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