Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Network.Stc] Reinforce API documents #6383

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions src/Tizen.Network.Stc/Tizen.Network.Stc/StcManager.cs
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,9 @@
namespace Tizen.Network.Stc
{
/// <summary>
/// A class for managing the Stc handle.
/// A class for managing the Stc (Smart Traffic Control) handle.
/// This class provides a safe way to manage and release the Stc handle.
/// It includes methods to check the validity of the handle and to release it properly.
/// </summary>
[EditorBrowsable(EditorBrowsableState.Never)]
public sealed class SafeStcHandle : SafeHandle
Expand All @@ -45,7 +47,10 @@ public override bool IsInvalid
}

/// <summary>
/// Release the Stc handle
/// Releases the Stc (Statistics and Traffic Control) handle and deinitializes the Stc module.
/// This method attempts to deinitialize the Stc module using the current handle.
/// If the deinitialization is successful, it sets the handle to IntPtr.Zero and returns true.
/// Otherwise, it logs an error message and returns false.
/// </summary>
/// <returns>True if the handle is released successfully, otherwise false.</returns>
protected override bool ReleaseHandle()
Expand All @@ -62,7 +67,9 @@ protected override bool ReleaseHandle()
}

/// <summary>
/// A class which is used to manage Smart Traffic control (Stc).<br/>
/// A class which manages Smart Traffic Control (Stc) functionalities for Tizen devices.
/// It provides methods to get the Stc safe handle and retrieve network statistics information for applications within specified time ranges using a filter.
/// This class supports asynchronous operations for retrieving network statistics.
/// </summary>
public static class StcManager
{
Expand Down
5 changes: 5 additions & 0 deletions src/Tizen.Network.Stc/Tizen.Network.Stc/StcStatistics.cs
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,11 @@ namespace Tizen.Network.Stc
{
/// <summary>
/// A class for managing the Stc statistics information.
/// This class manages statistical information related to network usage.
/// It provides properties to access various details such as application ID, interface name,
/// time interval, interface type, counters for incoming and outgoing data, roaming status,
/// network protocol, and application state. This class also ensures proper resource management
/// through its Dispose method.
/// </summary>
/// <since_tizen> 6 </since_tizen>

Expand Down
3 changes: 3 additions & 0 deletions src/Tizen.Network.Stc/Tizen.Network.Stc/StcStatsFilter.cs
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,9 @@ namespace Tizen.Network.Stc
{
/// <summary>
/// A class for managing the Statistics Filters to match applications.
/// This class manages filters to match and retrieve network usage statistics for specific applications.
/// It allows setting properties such as application ID, time interval, interface type, and time period to refine the statistics data.
/// These filters are then converted to native handles for querying the actual network statistics.
/// </summary>
/// <since_tizen> 6 </since_tizen>
public class StatisticsFilter
Expand Down
Loading