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 * @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>
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.
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>
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.
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 * It is recommended to design feature related codes in your application for reliability.\n
55 * 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
56 * 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
57 * More details on featuring your application can be found from <a href="https://developer.tizen.org/development/tizen-studio/native-tools/configuring-your-app/manifest-text-editor#feature"><b>Feature Element</b>.</a>
62 * @ingroup CAPI_NETWORK_CONNECTION_MANAGER_MODULE
63 * @defgroup CAPI_NETWORK_CONNECTION_PROFILE_MODULE Connection Profile
64 * @brief The Connection Profile API provides functions for managing the connection profile.
65 * @section CAPI_NETWORK_CONNECTION_PROFILE_MODULE_HEADER Required Header
66 * \#include <net_connection.h>
68 * @section CAPI_NETWORK_CONNECTION_PROFILE_MODULE_OVERVIEW Overview
69 * The Connection Profile provides functions for mapping connection profile.
70 * 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 * @section CAPI_NETWORK_CONNECTION_PROFILE_MODULE_FEATURE Related Features
73 * This API is related with the following features:\n
74 * - http://tizen.org/feature/network.wifi\n
75 * - http://tizen.org/feature/network.telephony\n
76 * - http://tizen.org/feature/network.tethering.bluetooth\n
77 * - http://tizen.org/feature/network.ethernet\n
78 * It is recommended to design feature related codes in your application for reliability.\n
79 * 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
80 * 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
81 * More details on featuring your application can be found from <a href="https://developer.tizen.org/development/tizen-studio/native-tools/configuring-your-app/manifest-text-editor#feature"><b>Feature Element</b>.</a>
86 * @ingroup CAPI_NETWORK_CONNECTION_PROFILE_MODULE
87 * @defgroup CAPI_NETWORK_CONNECTION_CELLULAR_PROFILE_MODULE Cellular Profile
88 * @brief The Connection Cellular Profile API provides functions for managing the cellular profile.
89 * @section CAPI_NETWORK_CONNECTION_CELLULAR_PROFILE_MODULE_HEADER Required Header
90 * \#include <net_connection.h>
92 * @section CAPI_NETWORK_CONNECTION_CELLULAR_PROFILE_MODULE_OVERVIEW Overview
93 * The Connection Cellular Profile API provides functions for managing the cellular profile. You can manage the cellular profile using the functions.
95 * @section CAPI_NETWORK_CONNECTION_CELLULAR_PROFILE_MODULE_FEATURE Related Features
96 * This API is related with the following features:\n
97 * - http://tizen.org/feature/network.telephony\n
98 * It is recommended to design feature related codes in your application for reliability.\n
99 * 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
100 * 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
101 * More details on featuring your application can be found from <a href="https://developer.tizen.org/development/tizen-studio/native-tools/configuring-your-app/manifest-text-editor#feature"><b>Feature Element</b>.</a>
106 * @ingroup CAPI_NETWORK_CONNECTION_PROFILE_MODULE
107 * @defgroup CAPI_NETWORK_CONNECTION_WIFI_PROFILE_MODULE Wi-Fi Profile
108 * @brief The Connection Wi-Fi Profile API provides functions for managing the WiFi profile.
109 * @section CAPI_NETWORK_CONNECTION_WIFI_PROFILE_MODULE_HEADER Required Header
110 * \#include <net_connection.h>
112 * @section CAPI_NETWORK_CONNECTION_WIFI_PROFILE_MODULE_OVERVIEW Overview
113 * 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 * @section CAPI_NETWORK_CONNECTION_WIFI_PROFILE_MODULE_FEATURE Related Features
116 * This API is related with the following features:\n
117 * - http://tizen.org/feature/network.wifi\n
118 * It is recommended to design feature related codes in your application for reliability.\n
119 * 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
120 * 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
121 * More details on featuring your application can be found from <a href="https://developer.tizen.org/development/tizen-studio/native-tools/configuring-your-app/manifest-text-editor#feature"><b>Feature Element</b>.</a>
126 * @ingroup CAPI_NETWORK_CONNECTION_MODULE
127 * @defgroup CAPI_NETWORK_CONNECTION_STATISTICS_MODULE Connection Statistics
128 * @brief The Connection Statistics API provides functions for getting the statistical information.
129 * @section CAPI_NETWORK_CONNECTION_STATISTICS_MODULE_HEADER Required Header
130 * \#include <net_connection.h>
132 * @section CAPI_NETWORK_CONNECTION_STATISTICS_MODULE_HEADER_OVERVIEW Overview
133 * The Connection allows you to track the data transfer information.
134 * Use the Connection statistics to gather and reset statistics on network usage, such as the size of the sent or received data, in bytes.
135 * It also provides methods for getting the cumulative size of packets sent or received.
137 * @section CAPI_NETWORK_CONNECTION_STATISTICS_MODULE_FEATURE Related Features
138 * This API is related with the following features:\n
139 * - http://tizen.org/feature/network.wifi\n
140 * - http://tizen.org/feature/network.telephony\n
141 * It is recommended to design feature related codes in your application for reliability.\n
142 * 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
143 * 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
144 * More details on featuring your application can be found from <a href="https://developer.tizen.org/development/tizen-studio/native-tools/configuring-your-app/manifest-text-editor#feature"><b>Feature Element</b>.</a>
148 #endif /* __TIZEN_NETWORK_CONNECTION_DOC_H__ */