doc/net_connection_doc.h

   1 /*
   2  * Copyright (c) 2011 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_CONNECTION_DOC_H__
  19 #define __TIZEN_NETWORK_CONNECTION_DOC_H__
  20
  21 /**
  22  * @ingroup CAPI_NETWORK_FRAMEWORK
  23  * @defgroup CAPI_NETWORK_CONNECTION_MODULE Connection
  24  * @brief The Connection API provides functions for managing modem data connections.
  25  * @section CAPI_NETWORK_CONNECTION_MODULE_HEADER Required Header
  26  *   \#include <net_connection.h>
  27  *
  28  * @section CAPI_NETWORK_CONNECTION_MODULE_OVERVIEW Overview
  29  * The Connection API provides functions used to create a network connection and to perform other operations on the connection.
  30  * With these functions, the application can get details such as the IP address, proxy information, gateway information, and connection statistics.
  31  */
  32
  33
  34 /**
  35  * @ingroup CAPI_NETWORK_CONNECTION_MODULE
  36  * @defgroup CAPI_NETWORK_CONNECTION_MANAGER_MODULE Connection Manager
  37  * @brief The Connection Manager API provides functions for managing data connections.
  38  * @section CAPI_NETWORK_CONNECTION_MANAGER_MODULE_HEADER Required Header
  39  *   \#include <net_connection.h>
  40  *
  41  * @section CAPI_NETWORK_CONNECTION_MANAGER_MODULE_OVERVIEW Overview
  42  * To use Connection Manager API, first create a connection handle using connection_create(). After that, you can obtain network information.
  43  * You should destroy the created connection handle if you do not need it anymore.
  44  * This API is related with libsoup and sockets. It allows you to create a socket on the kernel Linux stack, which can be used directly or by libsoup
  45  * or any other network library.
  46  *
  47  * @section CAPI_NETWORK_CONNECTION_MANAGER_MODULE_FEATURE Related Features
  48  * This API is related with the following features:\n
  49  * - %http://tizen.org/feature/network.wifi\n
  50  * - %http://tizen.org/feature/network.telephony\n
  51  * - %http://tizen.org/feature/network.tethering.bluetooth\n
  52  * - %http://tizen.org/feature/network.ethernet\n
  53  * - %http://tizen.org/feature/network.net_proxy\n
  54  * - %http://tizen.org/feature/network.route\n
  55  * It is recommended to design feature related codes in your application for reliability.\n
  56  * 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
  57  * 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
  58  * 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>
  59  */
  60
  61
  62 /**
  63  * @ingroup CAPI_NETWORK_CONNECTION_MANAGER_MODULE
  64  * @defgroup CAPI_NETWORK_CONNECTION_PROFILE_MODULE Connection Profile
  65  * @brief The Connection Profile API provides functions for managing the connection profile.
  66  * @section CAPI_NETWORK_CONNECTION_PROFILE_MODULE_HEADER Required Header
  67  *   \#include <net_connection.h>
  68  *
  69  * @section CAPI_NETWORK_CONNECTION_PROFILE_MODULE_OVERVIEW Overview
  70  * The Connection Profile provides functions for mapping connection profile.
  71  * It allows you to use a handle for dealing with a connection profile. You can get details about connection using ‘connection_profile_h’ handle.
  72  *
  73  * @section CAPI_NETWORK_CONNECTION_PROFILE_MODULE_FEATURE Related Features
  74  * This API is related with the following features:\n
  75  * - %http://tizen.org/feature/network.wifi\n
  76  * - %http://tizen.org/feature/network.telephony\n
  77  * - %http://tizen.org/feature/network.tethering.bluetooth\n
  78  * - %http://tizen.org/feature/network.ethernet\n
  79  * It is recommended to design feature related codes in your application for reliability.\n
  80  * 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
  81  * 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
  82  * 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>
  83  */
  84
  85
  86 /**
  87  * @ingroup CAPI_NETWORK_CONNECTION_PROFILE_MODULE
  88  * @defgroup CAPI_NETWORK_CONNECTION_CELLULAR_PROFILE_MODULE Cellular Profile
  89  * @brief The Connection Cellular Profile API provides functions for managing the cellular profile.
  90  * @section CAPI_NETWORK_CONNECTION_CELLULAR_PROFILE_MODULE_HEADER Required Header
  91  *   \#include <net_connection.h>
  92  *
  93  * @section CAPI_NETWORK_CONNECTION_CELLULAR_PROFILE_MODULE_OVERVIEW Overview
  94  * The Connection Cellular Profile API provides functions for managing the cellular profile. You can manage the cellular profile using the functions.
  95  *
  96  * @section CAPI_NETWORK_CONNECTION_CELLULAR_PROFILE_MODULE_FEATURE Related Features
  97  * This API is related with the following features:\n
  98  * - %http://tizen.org/feature/network.telephony\n
  99  * It is recommended to design feature related codes in your application for reliability.\n
 100  * 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
 101  * 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
 102  * 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>
 103  */
 104
 105
 106 /**
 107  * @ingroup CAPI_NETWORK_CONNECTION_PROFILE_MODULE
 108  * @defgroup CAPI_NETWORK_CONNECTION_WIFI_PROFILE_MODULE Wi-Fi Profile
 109  * @brief The Connection Wi-Fi Profile API provides functions for managing the WiFi profile.
 110  * @section CAPI_NETWORK_CONNECTION_WIFI_PROFILE_MODULE_HEADER Required Header
 111  *   \#include <net_connection.h>
 112  *
 113  * @section CAPI_NETWORK_CONNECTION_WIFI_PROFILE_MODULE_OVERVIEW Overview
 114  * The Connection Wi-Fi Profile API provides functions for managing the Wi-Fi profile. You can manage the Wi-Fi profile using the functions.
 115  *
 116  * @section CAPI_NETWORK_CONNECTION_WIFI_PROFILE_MODULE_FEATURE Related Features
 117  * This API is related with the following features:\n
 118  * - %http://tizen.org/feature/network.wifi\n
 119  * It is recommended to design feature related codes in your application for reliability.\n
 120  * 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
 121  * 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
 122  * 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>
 123  */
 124
 125
 126 /**
 127  * @ingroup CAPI_NETWORK_CONNECTION_MODULE
 128  * @defgroup CAPI_NETWORK_CONNECTION_STATISTICS_MODULE Connection Statistics
 129  * @brief The Connection Statistics API provides functions for getting the statistical information.
 130  * @section CAPI_NETWORK_CONNECTION_STATISTICS_MODULE_HEADER Required Header
 131  *   \#include <net_connection.h>
 132  *
 133  * @section CAPI_NETWORK_CONNECTION_STATISTICS_MODULE_HEADER_OVERVIEW Overview
 134  * The Connection allows you to track the data transfer information.
 135  * Use the Connection statistics to gather and reset statistics on network usage, such as the size of the sent or received data, in bytes.
 136  * It also provides methods for getting the cumulative size of packets sent or received.
 137  *
 138  * @section CAPI_NETWORK_CONNECTION_STATISTICS_MODULE_FEATURE Related Features
 139  * This API is related with the following features:\n
 140  * - %http://tizen.org/feature/network.wifi\n
 141  * - %http://tizen.org/feature/network.telephony\n
 142  * It is recommended to design feature related codes in your application for reliability.\n
 143  * 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
 144  * 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
 145  * 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>
 146  */
 147
 148
 149 #endif /* __TIZEN_NETWORK_CONNECTION_DOC_H__ */