2 * Copyright (c) 2011 Samsung Electronics Co., Ltd All Rights Reserved
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 #ifndef __TIZEN_NETWORK_CONNECTION_DOC_H__
19 #define __TIZEN_NETWORK_CONNECTION_DOC_H__
22 * @defgroup CAPI_NETWORK_CONNECTION_MODULE Connection
23 * @brief The Connection API provides functions for managing modem data connections.
24 * @ingroup CAPI_NETWORK_FRAMEWORK
26 * @section CAPI_NETWORK_CONNECTION_MODULE_HEADER Required Header
27 * \#include <net_connection.h>
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
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
41 * @section CAPI_NETWORK_CONNECTION_MANAGER_MODULE_HEADER Required Header
42 * \#include <net_connection.h>
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
56 * It is recommended to design feature related codes in your application for reliability.\n
58 * 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 * 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 * More details on featuring your application can be found from <a href="../org.tizen.mobile.native.appprogramming/html/ide_sdk_tools/feature_element.htm"><b>Feature Element</b>.</a>
67 * @defgroup CAPI_NETWORK_CONNECTION_PROFILE_MODULE Connection Profile
68 * @brief The Connection Profile API provides functions for managing the connection profile.
69 * @ingroup CAPI_NETWORK_CONNECTION_MANAGER_MODULE
71 * @section CAPI_NETWORK_CONNECTION_PROFILE_MODULE_HEADER Required Header
72 * \#include <net_connection.h>
74 * @section CAPI_NETWORK_CONNECTION_PROFILE_MODULE_OVERVIEW Overview
75 * The Connection Profile provides functions for mapping connection profile.
76 * It allows you to use a handle for dealing with a connection profile. You can get details about connection using ‘connection_profile_h’ handle.
77 * @section CAPI_NETWORK_CONNECTION_PROFILE_MODULE_FEATURE Related Features
78 * This API is related with the following features:\n
79 * - http://tizen.org/feature/network.bluetooth\n
80 * - http://tizen.org/feature/network.wifi\n
81 * - http://tizen.org/feature/network.telephony\n
82 * - http://tizen.org/feature/network.tethering.bluetooth\n
84 * It is recommended to design feature related codes in your application for reliability.\n
86 * 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 * 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 * More details on featuring your application can be found from <a href="../org.tizen.mobile.native.appprogramming/html/ide_sdk_tools/feature_element.htm"><b>Feature Element</b>.</a>
95 * @defgroup CAPI_NETWORK_CONNECTION_CELLULAR_PROFILE_MODULE Cellular Profile
96 * @brief The Connection Cellular Profile API provides functions for managing the cellular profile.
97 * @ingroup CAPI_NETWORK_CONNECTION_PROFILE_MODULE
99 * @section CAPI_NETWORK_CONNECTION_CELLULAR_PROFILE_MODULE_HEADER Required Header
100 * \#include <net_connection.h>
101 * @section CAPI_NETWORK_CONNECTION_CELLULAR_PROFILE_MODULE_OVERVIEW Overview
102 * The Connection Cellular Profile API provides functions for managing the cellular profile. You can manage the cellular profile using the functions.
103 * @section CAPI_NETWORK_CONNECTION_CELLULAR_PROFILE_MODULE_FEATURE Related Features
104 * This API is related with the following features:\n
105 * - http://tizen.org/feature/network.telephony\n
107 * It is recommended to design feature related codes in your application for reliability.\n
109 * 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 * 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 * More details on featuring your application can be found from <a href="../org.tizen.mobile.native.appprogramming/html/ide_sdk_tools/feature_element.htm"><b>Feature Element</b>.</a>
118 * @defgroup CAPI_NETWORK_CONNECTION_WIFI_PROFILE_MODULE Wi-Fi Profile
119 * @brief The Connection Wi-Fi Profile API provides functions for managing the WiFi profile.
120 * @ingroup CAPI_NETWORK_CONNECTION_PROFILE_MODULE
122 * @section CAPI_NETWORK_CONNECTION_WIFI_PROFILE_MODULE_HEADER Required Header
123 * \#include <net_connection.h>
124 * @section CAPI_NETWORK_CONNECTION_WIFI_PROFILE_MODULE_OVERVIEW Overview
125 * The Connection Wi-Fi Profile API provides functions for managing the wi-fi profile. You can manage the wi-fi profile using the functions.
126 * @section CAPI_NETWORK_CONNECTION_WIFI_PROFILE_MODULE_FEATURE Related Features
127 * This API is related with the following features:\n
128 * - http://tizen.org/feature/network.wifi\n
130 * It is recommended to design feature related codes in your application for reliability.\n
132 * 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 * 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 * More details on featuring your application can be found from <a href="../org.tizen.mobile.native.appprogramming/html/ide_sdk_tools/feature_element.htm"><b>Feature Element</b>.</a>
141 * @defgroup CAPI_NETWORK_CONNECTION_STATISTICS_MODULE Connection Statistics
142 * @brief The Connection Statistics API provides functions for getting the statistical information.
143 * @ingroup CAPI_NETWORK_CONNECTION_MODULE
145 * @section CAPI_NETWORK_CONNECTION_STATISTICS_MODULE_HEADER Required Header
146 * \#include <net_connection.h>
148 * @section CAPI_NETWORK_CONNECTION_STATISTICS_MODULE_HEADER_OVERVIEW Overview
149 * The Connection allows you to track the data transfer information.
150 * Use the Connection statistics to gather and reset statistics on network usage, such as the size of the sent or received data, in bytes.
151 * It also provides methods for getting the cumulative size of packets sent or received.
152 * @section CAPI_NETWORK_CONNECTION_STATISTICS_MODULE_FEATURE Related Features
153 * This API is related with the following features:\n
154 * - http://tizen.org/feature/network.wifi\n
155 * - http://tizen.org/feature/network.telephony\n
157 * It is recommended to design feature related codes in your application for reliability.\n
159 * 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 * 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 * More details on featuring your application can be found from <a href="../org.tizen.mobile.native.appprogramming/html/ide_sdk_tools/feature_element.htm"><b>Feature Element</b>.</a>
170 #endif /* __TIZEN_NETWORK_CONNECTION_DOC_H__ */