doc/stc_doc.h

   1 /*
   2  * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the License);
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an AS IS BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17
  18 #ifndef __TIZEN_NETWORK_STC_DOC_H__
  19 #define __TIZEN_NETWORK_STC_DOC_H__
  20
  21 /**
  22  * @defgroup CAPI_NETWORK_STC_MODULE Smart Traffic Control
  23  * @brief The STC API provides functions for managing and monitoring network packets.
  24  * @ingroup CAPI_NETWORK_FRAMEWORK
  25  *
  26  * @section CAPI_NETWORK_STC_MODULE_HEADER Required Header
  27  *   \#include <stc.h>
  28  *
  29  * @section CAPI_NETWORK_STC_MODULE_OVERVIEW Overview
  30  * This functions is used to initialize the settings of Smart Traffic Control.
  31  * @section CAPI_NETWORK_STC_MODULE_FEATURE Related Features
  32  * This API is related with the following features:\n
  33  * - http://tizen.org/feature/network.get\n
  34  *
  35  * It is recommended to use features in your application for reliability.\n
  36  *
  37  * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n
  38  *
  39  * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n
  40  *
  41  * More details on featuring your application can be found from <a href="https://docs.tizen.org/application/tizen-studio/native-tools/manifest-text-editor#feature-element"><b>Feature Element</b></a>.
  42  *
  43  */
  44
  45
  46 /**
  47  * @defgroup CAPI_NETWORK_STC_MANAGER_MODULE STC Manager
  48  * @brief The STC Manager API provides functions for managing STC.
  49  * @ingroup CAPI_NETWORK_STC_MODULE
  50  *
  51  * @section CAPI_NETWORK_STC_MANAGER_MODULE_HEADER Required Header
  52  *   \#include <stc.h>
  53  *
  54  * @section CAPI_NETWORK_STC_MANAGER_MODULE_OVERVIEW Overview
  55  * To use STC manager API, first create the STC handle using stc_initialize(). After that, you can obtain STC information.
  56  * You should destroy the created STC handle if you do not need it anymore.
  57  * The STC manager API provides functions for managing STC.
  58  * Using the STC manager, you can implement features that allow the users of your application to:
  59  * - Reset / Get  / Update the statistics information
  60  * - Set / Get / Remove / Exclude the restriction rule
  61  * @section CAPI_NETWORK_STC_MANAGER_MODULE_FEATURE Related Features
  62  * This API is related with the following features:\n
  63  * - http://tizen.org/feature/network.get\n
  64  *
  65  * It is recommended to use features in your application for reliability.\n
  66  *
  67  * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n
  68  *
  69  * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n
  70  *
  71  * More details on featuring your application can be found from <a href="https://docs.tizen.org/application/tizen-studio/native-tools/manifest-text-editor#feature-element"><b>Feature Element</b></a>.
  72  *
  73  */
  74
  75
  76 /**
  77  * @defgroup CAPI_NETWORK_STC_STATISTICS_MODULE STC Statistics
  78  * @brief The STC statistics API provides functions for managing STC statistics.
  79  * @ingroup CAPI_NETWORK_STC_MODULE
  80  *
  81  * @section CAPI_NETWORK_STC_STATISTICS_MODULE_HEADER Required Header
  82  *   \#include <stc.h>
  83  *
  84  * @section CAPI_NETWORK_STC_STATISTICS_MODULE_OVERVIEW Overview
  85  * To use STC statistics API, first create the STC handle using stc_initialize(). After that, you can obtain STC information.
  86  * You should destroy the created STC handle if you do not need it anymore.
  87  * The STC statistics API provides functions for managing STC statistics.
  88  * @section CAPI_NETWORK_STC_STATISTICS_FEATURE Related Features
  89  * This API is related with the following features:\n
  90  * - http://tizen.org/feature/network.get\n
  91  *
  92  * It is recommended to use features in your application for reliability.\n
  93  *
  94  * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n
  95  *
  96  * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n
  97  *
  98  * More details on featuring your application can be found from <a href="https://docs.tizen.org/application/tizen-studio/native-tools/manifest-text-editor#feature-element"><b>Feature Element</b></a>.
  99  *
 100  */
 101
 102
 103 /**
 104  * @defgroup CAPI_NETWORK_STC_RESTRICTION_MODULE STC Restriction
 105  * @brief The STC restriction API provides functions for managing STC restriction.
 106  * @ingroup CAPI_NETWORK_STC_MODULE
 107  *
 108  * @section CAPI_NETWORK_STC_RESTRICTION_MODULE_HEADER Required Header
 109  *   \#include <stc.h>
 110  *
 111  * @section CAPI_NETWORK_STC_RESTRICTION_MODULE_OVERVIEW Overview
 112  * To use STC restriction API, first create the STC handle using stc_initialize(). After that, you can obtain STC information.
 113  * You should destroy the created STC handle if you do not need it anymore.
 114  * The STC restriction API provides functions for managing STC restrictions.
 115  * @section CAPI_NETWORK_STC_RESTRICTION_MODULE_FEATURE Related Features
 116  * This API is related with the following features:\n
 117  * - http://tizen.org/feature/network.get\n
 118  *
 119  * It is recommended to use features in your application for reliability.\n
 120  *
 121  * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n
 122  *
 123  * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n
 124  *
 125  * More details on featuring your application can be found from <a href="https://docs.tizen.org/application/tizen-studio/native-tools/manifest-text-editor#feature-element"><b>Feature Element</b></a>.
 126  *
 127  */
 128
 129 #endif /* __TIZEN_NETWORK_STC_DOC_H__ */