#define __TIZEN_NETWORK_CONNECTION_DOC_H__
/**
+ * @ingroup CAPI_NETWORK_FRAMEWORK
* @defgroup CAPI_NETWORK_CONNECTION_MODULE Connection
* @brief The Connection API provides functions for managing modem data connections.
- * @ingroup CAPI_NETWORK_FRAMEWORK
- *
* @section CAPI_NETWORK_CONNECTION_MODULE_HEADER Required Header
* \#include <net_connection.h>
*
* @section CAPI_NETWORK_CONNECTION_MODULE_OVERVIEW Overview
- * The Connection API provides functions used to create a network connection and to perform other operations on the
- * connection. With these functions, the application can get details such as the IP address, proxy information, gateway information, and connection
- * statistics.
- *
+ * The Connection API provides functions used to create a network connection and to perform other operations on the connection.
+ * With these functions, the application can get details such as the IP address, proxy information, gateway information, and connection statistics.
*/
+
/**
+ * @ingroup CAPI_NETWORK_CONNECTION_MODULE
* @defgroup CAPI_NETWORK_CONNECTION_MANAGER_MODULE Connection Manager
* @brief The Connection Manager API provides functions for managing data connections.
- * @ingroup CAPI_NETWORK_CONNECTION_MODULE
- *
* @section CAPI_NETWORK_CONNECTION_MANAGER_MODULE_HEADER Required Header
* \#include <net_connection.h>
*
* You should destroy the created connection handle if you do not need it anymore.
* 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
* or any other network library.
+ *
* @section CAPI_NETWORK_CONNECTION_MANAGER_MODULE_FEATURE Related Features
* This API is related with the following features:\n
* - http://tizen.org/feature/network.wifi\n
* - http://tizen.org/feature/network.tethering.bluetooth\n
* - http://tizen.org/feature/network.ethernet\n
* - http://tizen.org/feature/network.net_proxy\n
- *
* It is recommended to design feature related codes in your application for reliability.\n
- *
* 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
- *
* 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
- *
* 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>
- *
*/
+
/**
+ * @ingroup CAPI_NETWORK_CONNECTION_MANAGER_MODULE
* @defgroup CAPI_NETWORK_CONNECTION_PROFILE_MODULE Connection Profile
* @brief The Connection Profile API provides functions for managing the connection profile.
- * @ingroup CAPI_NETWORK_CONNECTION_MANAGER_MODULE
- *
* @section CAPI_NETWORK_CONNECTION_PROFILE_MODULE_HEADER Required Header
* \#include <net_connection.h>
*
* @section CAPI_NETWORK_CONNECTION_PROFILE_MODULE_OVERVIEW Overview
* The Connection Profile provides functions for mapping connection profile.
* It allows you to use a handle for dealing with a connection profile. You can get details about connection using ‘connection_profile_h’ handle.
+ *
* @section CAPI_NETWORK_CONNECTION_PROFILE_MODULE_FEATURE Related Features
* This API is related with the following features:\n
* - http://tizen.org/feature/network.wifi\n
* - http://tizen.org/feature/network.telephony\n
* - http://tizen.org/feature/network.tethering.bluetooth\n
* - http://tizen.org/feature/network.ethernet\n
- *
* It is recommended to design feature related codes in your application for reliability.\n
- *
* 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
- *
* 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
- *
* 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>
- *
*/
+
/**
+ * @ingroup CAPI_NETWORK_CONNECTION_PROFILE_MODULE
* @defgroup CAPI_NETWORK_CONNECTION_CELLULAR_PROFILE_MODULE Cellular Profile
* @brief The Connection Cellular Profile API provides functions for managing the cellular profile.
- * @ingroup CAPI_NETWORK_CONNECTION_PROFILE_MODULE
- *
* @section CAPI_NETWORK_CONNECTION_CELLULAR_PROFILE_MODULE_HEADER Required Header
* \#include <net_connection.h>
+ *
* @section CAPI_NETWORK_CONNECTION_CELLULAR_PROFILE_MODULE_OVERVIEW Overview
* The Connection Cellular Profile API provides functions for managing the cellular profile. You can manage the cellular profile using the functions.
+ *
* @section CAPI_NETWORK_CONNECTION_CELLULAR_PROFILE_MODULE_FEATURE Related Features
* This API is related with the following features:\n
* - http://tizen.org/feature/network.telephony\n
- *
* It is recommended to design feature related codes in your application for reliability.\n
- *
* 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
- *
* 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
- *
* 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>
- *
*/
+
/**
+ * @ingroup CAPI_NETWORK_CONNECTION_PROFILE_MODULE
* @defgroup CAPI_NETWORK_CONNECTION_WIFI_PROFILE_MODULE Wi-Fi Profile
* @brief The Connection Wi-Fi Profile API provides functions for managing the WiFi profile.
- * @ingroup CAPI_NETWORK_CONNECTION_PROFILE_MODULE
- *
* @section CAPI_NETWORK_CONNECTION_WIFI_PROFILE_MODULE_HEADER Required Header
* \#include <net_connection.h>
+ *
* @section CAPI_NETWORK_CONNECTION_WIFI_PROFILE_MODULE_OVERVIEW Overview
- * The Connection Wi-Fi Profile API provides functions for managing the wi-fi profile. You can manage the wi-fi profile using the functions.
+ * The Connection Wi-Fi Profile API provides functions for managing the Wi-Fi profile. You can manage the Wi-Fi profile using the functions.
+ *
* @section CAPI_NETWORK_CONNECTION_WIFI_PROFILE_MODULE_FEATURE Related Features
* This API is related with the following features:\n
* - http://tizen.org/feature/network.wifi\n
- *
* It is recommended to design feature related codes in your application for reliability.\n
- *
* 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
- *
* 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
- *
* 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>
- *
*/
+
/**
+ * @ingroup CAPI_NETWORK_CONNECTION_MODULE
* @defgroup CAPI_NETWORK_CONNECTION_STATISTICS_MODULE Connection Statistics
* @brief The Connection Statistics API provides functions for getting the statistical information.
- * @ingroup CAPI_NETWORK_CONNECTION_MODULE
- *
* @section CAPI_NETWORK_CONNECTION_STATISTICS_MODULE_HEADER Required Header
* \#include <net_connection.h>
*
* The Connection allows you to track the data transfer information.
* Use the Connection statistics to gather and reset statistics on network usage, such as the size of the sent or received data, in bytes.
* It also provides methods for getting the cumulative size of packets sent or received.
+ *
* @section CAPI_NETWORK_CONNECTION_STATISTICS_MODULE_FEATURE Related Features
* This API is related with the following features:\n
* - http://tizen.org/feature/network.wifi\n
* - http://tizen.org/feature/network.telephony\n
- *
* It is recommended to design feature related codes in your application for reliability.\n
- *
* 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
- *
* 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
- *
* 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>
- *
*/
-
-
#endif /* __TIZEN_NETWORK_CONNECTION_DOC_H__ */
* limitations under the License.
*/
+
#ifndef __TIZEN_NETWORK_CONNECTION_PROFILE_H__
#define __TIZEN_NETWORK_CONNECTION_PROFILE_H__
+
#include <tizen.h>
+
#ifdef __cplusplus
extern "C" {
#endif
+
/**
* @file connection_profile.h
*/
+
/**
* @addtogroup CAPI_NETWORK_CONNECTION_WIFI_PROFILE_MODULE
* @{
*/
+
/**
* @brief Enumeration for security type of Wi-Fi.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
-typedef enum
-{
- CONNECTION_WIFI_SECURITY_TYPE_NONE = 0, /**< Security disabled */
- CONNECTION_WIFI_SECURITY_TYPE_WEP = 1, /**< WEP */
- CONNECTION_WIFI_SECURITY_TYPE_WPA_PSK = 2, /**< WPA-PSK */
- CONNECTION_WIFI_SECURITY_TYPE_WPA2_PSK = 3, /**< WPA2-PSK */
- CONNECTION_WIFI_SECURITY_TYPE_EAP = 4, /**< EAP */
+typedef enum {
+ CONNECTION_WIFI_SECURITY_TYPE_NONE = 0, /**< Security disabled */
+ CONNECTION_WIFI_SECURITY_TYPE_WEP = 1, /**< WEP */
+ CONNECTION_WIFI_SECURITY_TYPE_WPA_PSK = 2, /**< WPA-PSK */
+ CONNECTION_WIFI_SECURITY_TYPE_WPA2_PSK = 3, /**< WPA2-PSK */
+ CONNECTION_WIFI_SECURITY_TYPE_EAP = 4, /**< EAP */
} connection_wifi_security_type_e;
+
/**
* @brief Enumeration for encryption modes.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
-typedef enum
-{
- CONNECTION_WIFI_ENCRYPTION_TYPE_NONE = 0, /**< Encryption disabled */
- CONNECTION_WIFI_ENCRYPTION_TYPE_WEP = 1, /**< WEP */
- CONNECTION_WIFI_ENCRYPTION_TYPE_TKIP = 2, /**< TKIP */
- CONNECTION_WIFI_ENCRYPTION_TYPE_AES = 3, /**< AES */
- CONNECTION_WIFI_ENCRYPTION_TYPE_TKIP_AES_MIXED = 4, /**< TKIP and AES are both supported */
+typedef enum {
+ CONNECTION_WIFI_ENCRYPTION_TYPE_NONE = 0, /**< Encryption disabled */
+ CONNECTION_WIFI_ENCRYPTION_TYPE_WEP = 1, /**< WEP */
+ CONNECTION_WIFI_ENCRYPTION_TYPE_TKIP = 2, /**< TKIP */
+ CONNECTION_WIFI_ENCRYPTION_TYPE_AES = 3, /**< AES */
+ CONNECTION_WIFI_ENCRYPTION_TYPE_TKIP_AES_MIXED = 4, /**< TKIP and AES are both supported */
} connection_wifi_encryption_type_e;
+
/**
* @}
*/
* @{
*/
+
/**
* @brief Enumeration for cellular service type.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
-typedef enum
-{
- CONNECTION_CELLULAR_SERVICE_TYPE_UNKNOWN = 0, /**< Unknown */
- CONNECTION_CELLULAR_SERVICE_TYPE_INTERNET = 1, /**< Internet */
- CONNECTION_CELLULAR_SERVICE_TYPE_MMS = 2, /**< MMS */
- CONNECTION_CELLULAR_SERVICE_TYPE_PREPAID_INTERNET = 3, /**< Prepaid internet */
- CONNECTION_CELLULAR_SERVICE_TYPE_PREPAID_MMS = 4, /**< Prepaid MMS */
- CONNECTION_CELLULAR_SERVICE_TYPE_TETHERING = 5, /**< Tethering */
- CONNECTION_CELLULAR_SERVICE_TYPE_APPLICATION = 6, /**< Specific application */
+typedef enum {
+ CONNECTION_CELLULAR_SERVICE_TYPE_UNKNOWN = 0, /**< Unknown */
+ CONNECTION_CELLULAR_SERVICE_TYPE_INTERNET = 1, /**< Internet */
+ CONNECTION_CELLULAR_SERVICE_TYPE_MMS = 2, /**< MMS */
+ CONNECTION_CELLULAR_SERVICE_TYPE_PREPAID_INTERNET = 3, /**< Prepaid internet */
+ CONNECTION_CELLULAR_SERVICE_TYPE_PREPAID_MMS = 4, /**< Prepaid MMS */
+ CONNECTION_CELLULAR_SERVICE_TYPE_TETHERING = 5, /**< Tethering */
+ CONNECTION_CELLULAR_SERVICE_TYPE_APPLICATION = 6, /**< Specific application */
} connection_cellular_service_type_e;
+
/**
* @brief Enumeration for cellular pdn type.
* @since_tizen 3.0
*/
-typedef enum
-{
- CONNECTION_CELLULAR_PDN_TYPE_UNKNOWN = 0,
- CONNECTION_CELLULAR_PDN_TYPE_IPV4 = 1,
- CONNECTION_CELLULAR_PDN_TYPE_IPV6 = 2,
- CONNECTION_CELLULAR_PDN_TYPE_IPV4_IPv6 = 3,
+typedef enum {
+ CONNECTION_CELLULAR_PDN_TYPE_UNKNOWN = 0,
+ CONNECTION_CELLULAR_PDN_TYPE_IPV4 = 1,
+ CONNECTION_CELLULAR_PDN_TYPE_IPV6 = 2,
+ CONNECTION_CELLULAR_PDN_TYPE_IPV4_IPv6 = 3,
} connection_cellular_pdn_type_e;
+
/**
* @brief Enumeration for cellular authentication type.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
-typedef enum
-{
- CONNECTION_CELLULAR_AUTH_TYPE_NONE = 0, /**< No authentication */
- CONNECTION_CELLULAR_AUTH_TYPE_PAP = 1, /**< PAP authentication */
- CONNECTION_CELLULAR_AUTH_TYPE_CHAP = 2, /**< CHAP authentication */
+typedef enum {
+ CONNECTION_CELLULAR_AUTH_TYPE_NONE = 0, /**< No authentication */
+ CONNECTION_CELLULAR_AUTH_TYPE_PAP = 1, /**< PAP authentication */
+ CONNECTION_CELLULAR_AUTH_TYPE_CHAP = 2, /**< CHAP authentication */
} connection_cellular_auth_type_e;
+
/**
* @}
*/
* @{
*/
+
/**
* @brief The profile handle.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
typedef void* connection_profile_h;
+
/**
* @brief Enumeration for profile state type.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
-typedef enum
-{
- CONNECTION_PROFILE_STATE_DISCONNECTED = 0, /**< Disconnected state */
- CONNECTION_PROFILE_STATE_ASSOCIATION = 1, /**< Association state */
- CONNECTION_PROFILE_STATE_CONFIGURATION = 2, /**< Configuration state */
- CONNECTION_PROFILE_STATE_CONNECTED = 3, /**< Connected state */
+typedef enum {
+ CONNECTION_PROFILE_STATE_DISCONNECTED = 0, /**< Disconnected state */
+ CONNECTION_PROFILE_STATE_ASSOCIATION = 1, /**< Association state */
+ CONNECTION_PROFILE_STATE_CONFIGURATION = 2, /**< Configuration state */
+ CONNECTION_PROFILE_STATE_CONNECTED = 3, /**< Connected state */
} connection_profile_state_e;
+
/**
* @brief Enumeration for address family.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
-typedef enum
-{
- CONNECTION_ADDRESS_FAMILY_IPV4 = 0, /**< IPV4 Address type */
- CONNECTION_ADDRESS_FAMILY_IPV6 = 1, /**< IPV6 Address type */
+typedef enum {
+ CONNECTION_ADDRESS_FAMILY_IPV4 = 0, /**< IPV4 Address type */
+ CONNECTION_ADDRESS_FAMILY_IPV6 = 1, /**< IPV6 Address type */
} connection_address_family_e;
+
/**
* @brief Enumeration for IP configuration type.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
-typedef enum
-{
- CONNECTION_IP_CONFIG_TYPE_NONE = 0, /**< Not defined */
- CONNECTION_IP_CONFIG_TYPE_STATIC = 1, /**< Manual IP configuration */
- CONNECTION_IP_CONFIG_TYPE_DYNAMIC = 2, /**< Config IP using DHCP client*/
- CONNECTION_IP_CONFIG_TYPE_AUTO = 3, /**< Config IP from Auto IP pool (169.254/16). Later with DHCP client, if available */
- CONNECTION_IP_CONFIG_TYPE_FIXED = 4, /**< Indicates an IP address that can not be modified */
+typedef enum {
+ CONNECTION_IP_CONFIG_TYPE_NONE = 0, /**< Not defined */
+ CONNECTION_IP_CONFIG_TYPE_STATIC = 1, /**< Manual IP configuration */
+ CONNECTION_IP_CONFIG_TYPE_DYNAMIC = 2, /**< Config IP using DHCP client*/
+ CONNECTION_IP_CONFIG_TYPE_AUTO = 3, /**< Config IP from Auto IP pool (169.254/16). Later with DHCP client, if available */
+ CONNECTION_IP_CONFIG_TYPE_FIXED = 4, /**< Indicates an IP address that can not be modified */
} connection_ip_config_type_e;
+
/**
* @brief Enumeration for proxy method type.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
-typedef enum
-{
- CONNECTION_PROXY_TYPE_DIRECT = 0, /**< Direct connection */
- CONNECTION_PROXY_TYPE_AUTO = 1, /**< Auto configuration(Use PAC file). If URL property is not set, DHCP/WPAD auto-discover will be tried */
- CONNECTION_PROXY_TYPE_MANUAL = 2, /**< Manual configuration */
+typedef enum {
+ CONNECTION_PROXY_TYPE_DIRECT = 0, /**< Direct connection */
+ CONNECTION_PROXY_TYPE_AUTO = 1, /**< Auto configuration(Use PAC file). If URL property is not set, DHCP/WPAD auto-discover will be tried */
+ CONNECTION_PROXY_TYPE_MANUAL = 2, /**< Manual configuration */
} connection_proxy_type_e;
+
/**
* @brief Enumeration for network connection type.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
-typedef enum{
- CONNECTION_PROFILE_TYPE_CELLULAR = 0, /**< Cellular type */
- CONNECTION_PROFILE_TYPE_WIFI = 1, /**< Wi-Fi type */
- CONNECTION_PROFILE_TYPE_ETHERNET = 2, /**< Ethernet type */
- CONNECTION_PROFILE_TYPE_BT = 3, /**< Bluetooth type */
+typedef enum {
+ CONNECTION_PROFILE_TYPE_CELLULAR = 0, /**< Cellular type */
+ CONNECTION_PROFILE_TYPE_WIFI = 1, /**< Wi-Fi type */
+ CONNECTION_PROFILE_TYPE_ETHERNET = 2, /**< Ethernet type */
+ CONNECTION_PROFILE_TYPE_BT = 3, /**< Bluetooth type */
} connection_profile_type_e;
+
/**
* @brief Creates a profile handle.
* @details The profile name, which you get from connection_profile_get_name(), will include the keyword you set.
* @privlevel public
* @privilege %http://tizen.org/privilege/network.get
* @remarks You must release @a profile using connection_profile_destroy().
- * @param[in] type The type of profile\n
- * #CONNECTION_PROFILE_TYPE_CELLULAR and #CONNECTION_PROFILE_TYPE_WIFI are supported.
- * @param[in] keyword The keyword included in profile name
- * @param[out] profile The handle of the profile
- * @return @c 0 on success, otherwise negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not supported
+ * @param[in] type The type of profile \n
+ * #CONNECTION_PROFILE_TYPE_CELLULAR and #CONNECTION_PROFILE_TYPE_WIFI are supported
+ * @param[in] keyword The keyword included in profile name
+ * @param[out] profile The handle of the profile
+ * @return @c 0 on success,
+ * otherwise negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_OUT_OF_MEMORY Out of memory
+ * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not supported
* @see connection_profile_destroy()
* @see connection_profile_get_name()
*/
int connection_profile_create(connection_profile_type_e type, const char* keyword, connection_profile_h* profile);
+
/**
* @brief Destroys a profile handle.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[out] profile The handle to the profile
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @param[out] profile The handle to the profile
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
* @see connection_profile_create()
*/
int connection_profile_destroy(connection_profile_h profile);
+
/**
* @brief Clones a profile handle.
* @since_tizen 2.3
* @remarks You must release @a cloned_profile using connection_profile_destroy().
- * @param[out] cloned_profile The handle of the cloned profile
- * @param[in] origin_profile The handle of the origin profile
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_OUT_OF_MEMORY Out of memory
+ * @param[out] cloned_profile The handle of the cloned profile
+ * @param[in] origin_profile The handle of the origin profile
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_OUT_OF_MEMORY Out of memory
* @see connection_profile_destroy()
*/
int connection_profile_clone(connection_profile_h* cloned_profile, connection_profile_h origin_profile);
+
/**
* @brief Gets the profile ID.
* @details The separate profiles can have the same name.
- * So, you must use this API instead of connection_profile_get_name() if you want to get the unique identification.
- * In case you create a profile, this value will be determined when you add the profile.
- *
+ * So, you must use this API instead of connection_profile_get_name() if you want to get the unique identification.
+ * In case you create a profile, this value will be determined when you add the profile.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @remarks You must release @a profile_id using free().
- * @param[in] profile The profile handle
- * @param[out] profile_id The ID of the profile
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_OUT_OF_MEMORY Out of memory
+ * @param[in] profile The profile handle
+ * @param[out] profile_id The ID of the profile
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_OUT_OF_MEMORY Out of memory
* @see connection_profile_get_name()
* @see connection_add_profile()
*/
int connection_profile_get_id(connection_profile_h profile, char** profile_id);
+
/**
* @brief Gets the profile name.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @remarks You must release @a profile_name using free().
- * @param[in] profile The profile handle
- * @param[out] profile_name The name of the profile
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_OUT_OF_MEMORY Out of memory
+ * @param[in] profile The profile handle
+ * @param[out] profile_name The name of the profile
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_OUT_OF_MEMORY Out of memory
* @see connection_profile_get_id()
*/
int connection_profile_get_name(connection_profile_h profile, char** profile_name);
+
/**
* @brief Gets the network type.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] profile The profile handle
- * @param[out] type The type of the profile
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
+ * @param[in] profile The profile handle
+ * @param[out] type The type of the profile
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
*/
int connection_profile_get_type(connection_profile_h profile, connection_profile_type_e* type);
+
/**
* @brief Gets the name of the network interface, e.g. eth0 and pdp0.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @remarks You must release @a interface_name using free().
- * @param[in] profile The profile handle
- * @param[out] interface_name The name of the network interface
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_OUT_OF_MEMORY Out of memory
+ * @param[in] profile The profile handle
+ * @param[out] interface_name The name of the network interface
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_OUT_OF_MEMORY Out of memory
*/
int connection_profile_get_network_interface_name(connection_profile_h profile, char** interface_name);
+
/**
* @brief Refreshes the profile information.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/network.get
* @remarks You should call this function in order to get the current information because the profile information can be changed.
- * @param[in] profile The profile handle
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
- * @retval #CONNECTION_ERROR_OUT_OF_MEMORY Out of memory
+ * @param[in] profile The profile handle
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
+ * @retval #CONNECTION_ERROR_OUT_OF_MEMORY Out of memory
* @retval #CONNECTION_ERROR_PERMISSION_DENIED Permission Denied
*/
int connection_profile_refresh(connection_profile_h profile);
+
/**
* @brief Gets the network type.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] profile The profile handle
- * @param[out] state The state of the profile
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
+ * @param[in] profile The profile handle
+ * @param[out] state The state of the profile
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
*/
int connection_profile_get_state(connection_profile_h profile, connection_profile_state_e* state);
+
/**
* @brief Gets the IP config type.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] profile The profile handle
- * @param[in] address_family The address family
- * @param[out] type The type of the IP config
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
+ * @param[in] profile The profile handle
+ * @param[in] address_family The address family
+ * @param[out] type The type of the IP config
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
*/
int connection_profile_get_ip_config_type(connection_profile_h profile, connection_address_family_e address_family, connection_ip_config_type_e* type);
+
/**
* @brief Gets the IP address.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @remarks You must release @a ip_address using free().
- * @param[in] profile The profile handle
- * @param[in] address_family The address family
- * @param[out] ip_address The IP address
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #CONNECTION_ERROR_ADDRESS_FAMILY_NOT_SUPPORTED Not supported address family
- * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
+ * @param[in] profile The profile handle
+ * @param[in] address_family The address family
+ * @param[out] ip_address The IP address
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_OUT_OF_MEMORY Out of memory
+ * @retval #CONNECTION_ERROR_ADDRESS_FAMILY_NOT_SUPPORTED Not supported address family
+ * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
*/
int connection_profile_get_ip_address(connection_profile_h profile, connection_address_family_e address_family, char** ip_address);
+
/**
* @brief Gets the Subnet Mask.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @remarks You must release @a subnet_mask using free().
- * @param[in] profile The profile handle
- * @param[in] address_family The address family
- * @param[out] subnet_mask The subnet mask
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #CONNECTION_ERROR_ADDRESS_FAMILY_NOT_SUPPORTED Not supported address family
- * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
+ * @param[in] profile The profile handle
+ * @param[in] address_family The address family
+ * @param[out] subnet_mask The subnet mask
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_OUT_OF_MEMORY Out of memory
+ * @retval #CONNECTION_ERROR_ADDRESS_FAMILY_NOT_SUPPORTED Not supported address family
+ * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
*/
int connection_profile_get_subnet_mask(connection_profile_h profile, connection_address_family_e address_family, char** subnet_mask);
+
/**
* @brief Gets the Gateway address.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @remarks You must release @a gateway_address using free().
- * @param[in] profile The profile handle
- * @param[in] address_family The address family
- * @param[out] gateway_address The gateway address
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #CONNECTION_ERROR_ADDRESS_FAMILY_NOT_SUPPORTED Not supported address family
- * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
+ * @param[in] profile The profile handle
+ * @param[in] address_family The address family
+ * @param[out] gateway_address The gateway address
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_OUT_OF_MEMORY Out of memory
+ * @retval #CONNECTION_ERROR_ADDRESS_FAMILY_NOT_SUPPORTED Not supported address family
+ * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
*/
int connection_profile_get_gateway_address(connection_profile_h profile, connection_address_family_e address_family, char** gateway_address);
+
/**
* @brief Gets the DNS address.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @remarks The allowance of the DNS address is @c 2. You must release @a dns_address using free().
- * @param[in] profile The profile handle
- * @param[in] order The order of DNS address \n
- * it starts from 1, which means first DNS address.
- * @param[in] address_family The address family
- * @param[out] dns_address The DNS address
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #CONNECTION_ERROR_ADDRESS_FAMILY_NOT_SUPPORTED Not supported address family
- * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
+ * @param[in] profile The profile handle
+ * @param[in] order The order of DNS address \n
+ * it starts from 1, which means first DNS address
+ * @param[in] address_family The address family
+ * @param[out] dns_address The DNS address
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_OUT_OF_MEMORY Out of memory
+ * @retval #CONNECTION_ERROR_ADDRESS_FAMILY_NOT_SUPPORTED Not supported address family
+ * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
*/
int connection_profile_get_dns_address(connection_profile_h profile, int order, connection_address_family_e address_family, char** dns_address);
+
/**
* @brief Gets the Proxy type.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] profile The profile handle
- * @param[out] type The type of the proxy
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
+ * @param[in] profile The profile handle
+ * @param[out] type The type of the proxy
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
*/
int connection_profile_get_proxy_type(connection_profile_h profile, connection_proxy_type_e* type);
+
/**
* @brief Gets the Proxy address.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @remarks You must release @a proxy_address using free().
- * @param[in] profile The profile handle
- * @param[in] address_family The address family
- * @param[out] proxy_address The proxy address
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #CONNECTION_ERROR_ADDRESS_FAMILY_NOT_SUPPORTED Not supported address family
- * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
+ * @param[in] profile The profile handle
+ * @param[in] address_family The address family
+ * @param[out] proxy_address The proxy address
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_OUT_OF_MEMORY Out of memory
+ * @retval #CONNECTION_ERROR_ADDRESS_FAMILY_NOT_SUPPORTED Not supported address family
+ * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
*/
int connection_profile_get_proxy_address(connection_profile_h profile, connection_address_family_e address_family, char** proxy_address);
+
/**
* @brief Sets the IP config type.
* @details If you set IP config type to #CONNECTION_IP_CONFIG_TYPE_STATIC,
- * then IP address, Gateway and Subnet mask will be set to the initial value "0.0.0.0".
+ * then IP address, Gateway and Subnet mask will be set to the initial value "0.0.0.0".
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] profile The profile handle
- * @param[in] address_family The address family
- * @param[in] type The type of the IP config
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
+ * @param[in] profile The profile handle
+ * @param[in] address_family The address family
+ * @param[in] type The type of the IP config
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
*/
int connection_profile_set_ip_config_type(connection_profile_h profile, connection_address_family_e address_family, connection_ip_config_type_e type);
+
/**
* @brief Sets the IP address.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] profile The profile handle
- * @param[in] address_family The address family
- * @param[in] ip_address The IP address.\n
- * If you set this value to @c NULL, then the existing value will be deleted.
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @param[in] profile The profile handle
+ * @param[in] address_family The address family
+ * @param[in] ip_address The IP address. \n
+ * If you set this value to @c NULL, then the existing value will be deleted
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #CONNECTION_ERROR_ADDRESS_FAMILY_NOT_SUPPORTED Not supported address family
- * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
+ * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
* @see connection_update_profile()
*/
int connection_profile_set_ip_address(connection_profile_h profile, connection_address_family_e address_family, const char* ip_address);
+
/**
* @brief Sets the Subnet Mask.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] profile The profile handle
- * @param[in] address_family The address family
- * @param[in] subnet_mask The subnet mask. \n
- * If you set this value to @c NULL, then the existing value will be deleted.
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_ADDRESS_FAMILY_NOT_SUPPORTED Not supported address family
- * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
+ * @param[in] profile The profile handle
+ * @param[in] address_family The address family
+ * @param[in] subnet_mask The subnet mask. \n
+ * If you set this value to @c NULL, then the existing value will be deleted
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_ADDRESS_FAMILY_NOT_SUPPORTED Not supported address family
+ * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
* @see connection_update_profile()
*/
int connection_profile_set_subnet_mask(connection_profile_h profile, connection_address_family_e address_family, const char* subnet_mask);
+
/**
* @brief Sets the Gateway address.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] profile The profile handle
- * @param[in] address_family The address family
- * @param[in] gateway_address The gateway address. \n
- * If you set this value to @c NULL, then the existing value will be deleted.
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_ADDRESS_FAMILY_NOT_SUPPORTED Not supported address family
- * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
+ * @param[in] profile The profile handle
+ * @param[in] address_family The address family
+ * @param[in] gateway_address The gateway address. \n
+ * If you set this value to @c NULL, then the existing value will be deleted
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_ADDRESS_FAMILY_NOT_SUPPORTED Not supported address family
+ * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
* @see connection_update_profile()
*/
int connection_profile_set_gateway_address(connection_profile_h profile, connection_address_family_e address_family, const char* gateway_address);
+
/**
* @brief Sets the DNS address.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @remarks The allowance of the DNS address is @c 2.
- * @param[in] profile The profile handle
- * @param[in] order The order of the DNS address. \n
- * It starts from @c 1, which means first DNS address.
- * @param[in] address_family The address family
- * @param[in] dns_address The DNS address; if you set this value to NULL, then the existing value will be deleted
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_ADDRESS_FAMILY_NOT_SUPPORTED Not supported address family
- * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
+ * @param[in] profile The profile handle
+ * @param[in] order The order of the DNS address. \n
+ * It starts from @c 1, which means first DNS address
+ * @param[in] address_family The address family
+ * @param[in] dns_address The DNS address; if you set this value to NULL, then the existing value will be deleted
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_ADDRESS_FAMILY_NOT_SUPPORTED Not supported address family
+ * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
* @see connection_update_profile()
*/
int connection_profile_set_dns_address(connection_profile_h profile, int order, connection_address_family_e address_family, const char* dns_address);
+
/**
* @brief Sets the Proxy type.
* @details If you set the Proxy type to #CONNECTION_PROXY_TYPE_AUTO or #CONNECTION_PROXY_TYPE_MANUAL, then Proxy will be restored.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] profile The profile handle
- * @param[in] type The type of the proxy
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
+ * @param[in] profile The profile handle
+ * @param[in] type The type of the proxy
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
* @see connection_update_profile()
*/
int connection_profile_set_proxy_type(connection_profile_h profile, connection_proxy_type_e type);
+
/**
* @brief Sets the Proxy address.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] profile The profile handle
- * @param[in] address_family The address family
- * @param[in] proxy_address The proxy address. \n
- * if you set this value to @c NULL, then the existing value will be deleted.
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_ADDRESS_FAMILY_NOT_SUPPORTED Not supported address family
- * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
+ * @param[in] profile The profile handle
+ * @param[in] address_family The address family
+ * @param[in] proxy_address The proxy address. \n
+ * If you set this value to @c NULL, then the existing value will be deleted
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_ADDRESS_FAMILY_NOT_SUPPORTED Not supported address family
+ * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
* @see connection_update_profile()
*/
int connection_profile_set_proxy_address(connection_profile_h profile, connection_address_family_e address_family, const char* proxy_address);
+
/**
* @brief Called when the state of the profile is changed.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] state The state
+ * @param[in] state The state
* @param[in] user_data The user data passed from the callback registration function
* @see connection_profile_set_state_changed_cb()
* @see connection_profile_unset_state_changed_cb()
*/
typedef void(*connection_profile_state_changed_cb)(connection_profile_state_e state, void* user_data);
+
/**
* @brief Registers the callback that is called when the state of profile is changed.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] profile The profile handle
- * @param[in] callback The callback function to be called
+ * @param[in] profile The profile handle
+ * @param[in] callback The callback function to be called
* @param[in] user_data The user data passed to the callback function
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
* @post connection_opened_cb() is invoked when the state of profile is changed.
* @see connection_profile_state_changed_cb()
* @see connection_profile_unset_state_changed_cb()
*/
int connection_profile_set_state_changed_cb(connection_profile_h profile, connection_profile_state_changed_cb callback, void* user_data);
+
/**
* @brief Unregisters the callback that is called when the state of profile is changed.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] profile The profile handle
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @param[in] profile The profile handle
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
* @see connection_profile_state_changed_cb()
* @see connection_profile_set_state_changed_cb()
*/
int connection_profile_unset_state_changed_cb(connection_profile_h profile);
+
/**
* @}
*/
* @{
*/
+
/**
* @brief Gets the ESSID (Extended Service Set Identifier).
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @remarks You must release @a essid using free().
- * @param[in] profile The profile handle
- * @param[out] essid The ESSID
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not supported
+ * @param[in] profile The profile handle
+ * @param[out] essid The ESSID
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_OUT_OF_MEMORY Out of memory
+ * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not supported
*/
int connection_profile_get_wifi_essid(connection_profile_h profile, char** essid);
+
/**
* @brief Gets the BSSID (Basic Service Set Identifier).
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @remarks You must release @a bssid using free().
- * @param[in] profile The profile handle
- * @param[out] bssid The BSSID
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not supported
+ * @param[in] profile The profile handle
+ * @param[out] bssid The BSSID
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_OUT_OF_MEMORY Out of memory
+ * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not supported
*/
int connection_profile_get_wifi_bssid(connection_profile_h profile, char** bssid);
+
/**
* @brief Gets the RSSI.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] profile The profile handle
- * @param[out] rssi The RSSI
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not supported
+ * @param[in] profile The profile handle
+ * @param[out] rssi The RSSI
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not supported
*/
int connection_profile_get_wifi_rssi(connection_profile_h profile, int* rssi);
+
/**
* @brief Gets the frequency (MHz).
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] profile The profile handle
- * @param[out] frequency The frequency
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not supported
+ * @param[in] profile The profile handle
+ * @param[out] frequency The frequency
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not supported
*/
int connection_profile_get_wifi_frequency(connection_profile_h profile, int* frequency);
+
/**
* @brief Gets the max speed (Mbps).
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] profile The profile handle
- * @param[out] max_speed The max speed
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not supported
+ * @param[in] profile The profile handle
+ * @param[out] max_speed The max speed
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not supported
*/
int connection_profile_get_wifi_max_speed(connection_profile_h profile, int* max_speed);
+
/**
* @brief Gets the security mode of Wi-Fi.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] profile The profile handle
- * @param[out] type The type of Wi-Fi security
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
- * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not supported
+ * @param[in] profile The profile handle
+ * @param[out] type The type of Wi-Fi security
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
+ * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not supported
*/
int connection_profile_get_wifi_security_type(connection_profile_h profile, connection_wifi_security_type_e* type);
+
/**
* @brief Gets the security mode of Wi-Fi.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] profile The profile handle
- * @param[out] type The type of Wi-Fi security
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
- * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not supported
+ * @param[in] profile The profile handle
+ * @param[out] type The type of Wi-Fi security
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
+ * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not supported
*/
int connection_profile_get_wifi_encryption_type(connection_profile_h profile, connection_wifi_encryption_type_e* type);
+
/**
* @brief Checks whether passphrase is required.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @remarks This function is not valid if security type is #CONNECTION_WIFI_SECURITY_TYPE_EAP.
- * @param[in] profile The profile handle
- * @param[out] required @c true if a passphrase is required, otherwise @c false if a passphrase is not required.
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not supported
+ * @param[in] profile The profile handle
+ * @param[out] required @c true if a passphrase is required,
+ * otherwise @c false if a passphrase is not required
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not supported
*/
int connection_profile_is_wifi_passphrase_required(connection_profile_h profile, bool* required);
+
/**
* @brief Sets the passphrase of the Wi-Fi WPA.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] profile The profile handle
- * @param[in] passphrase The passphrase of Wi-Fi security
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not supported
+ * @param[in] profile The profile handle
+ * @param[in] passphrase The passphrase of Wi-Fi security
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not supported
* @see connection_update_profile()
*/
int connection_profile_set_wifi_passphrase(connection_profile_h profile, const char* passphrase);
+
/**
* @brief Checks whether the WPS (Wi-Fi Protected Setup) is supported.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @remarks If WPS is supported, you can connect the access point with WPS by wifi_connect_with_wps().
- * @param[in] profile The profile handle
- * @param[out] supported @c true if WPS is supported, otherwise @c false if WPS is not supported.
- * @return @c 0 on success, otherwise negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not supported
+ * @param[in] profile The profile handle
+ * @param[out] supported @c true if WPS is supported,
+ * otherwise @c false if WPS is not supported
+ * @return @c 0 on success,
+ * otherwise negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not supported
*/
int connection_profile_is_wifi_wps_supported(connection_profile_h profile, bool* supported);
+
/**
* @}
*/
* @{
*/
+
/**
* @brief Gets the service type.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] profile The profile handle
- * @param[out] type The type of the cellular service
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
- * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not supported
+ * @param[in] profile The profile handle
+ * @param[out] type The type of the cellular service
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
+ * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not supported
*/
int connection_profile_get_cellular_service_type(connection_profile_h profile, connection_cellular_service_type_e* type);
+
/**
* @brief Gets the APN (access point name).
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @remarks You must release @a apn using free().
- * @param[in] profile The profile handle
- * @param[out] apn The name of the APN
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not supported
+ * @param[in] profile The profile handle
+ * @param[out] apn The name of the APN
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_OUT_OF_MEMORY Out of memory
+ * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not supported
*/
int connection_profile_get_cellular_apn(connection_profile_h profile, char** apn);
+
/**
* @brief Gets the authentication information.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @remarks You must release @a user_name and @a password using free().
- * @param[in] profile The profile handle
- * @param[out] type The type of the authentication
- * @param[out] user_name The user name
- * @param[out] password The password
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
- * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not supported
+ * @param[in] profile The profile handle
+ * @param[out] type The type of the authentication
+ * @param[out] user_name The user name
+ * @param[out] password The password
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_OUT_OF_MEMORY Out of memory
+ * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
+ * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not supported
*/
int connection_profile_get_cellular_auth_info(connection_profile_h profile, connection_cellular_auth_type_e* type, char** user_name, char** password);
+
/**
* @brief Gets the home URL.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @remarks You must release @a home_url using free().
- * @param[in] profile The profile handle
- * @param[out] home_url The home URL
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not supported
+ * @param[in] profile The profile handle
+ * @param[out] home_url The home URL
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_OUT_OF_MEMORY Out of memory
+ * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not supported
*/
int connection_profile_get_cellular_home_url(connection_profile_h profile, char** home_url);
+
/**
* @brief Gets the cellular pdn type.
* @since_tizen 3.0
* @param[in] profile The profile handle
* @param[out] type The cellular pdn type
- * @return @c 0 on success, otherwise negative error value
+ * @return @c 0 on success,
+ * otherwise negative error value
* @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
- * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not Supported
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
+ * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not Supported
*/
int connection_profile_get_cellular_pdn_type(connection_profile_h profile, connection_cellular_pdn_type_e* type);
+
/**
* @brief Gets the cellular roam pdn type.
* @since_tizen 3.0
* @param[in] profile The profile handle
* @param[out] type The cellular pdn type
- * @return @c 0 on success, otherwise negative error value
+ * @return @c 0 on success,
+ * otherwise negative error value
* @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
- * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not Supported
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
+ * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not Supported
*/
int connection_profile_get_cellular_roam_pdn_type(connection_profile_h profile, connection_cellular_pdn_type_e* type);
+
/**
* @brief Checks wheter the connection is in roaming state.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] profile The profile handle
- * @param[out] is_roaming @c true if the cellular is roaming, otherwise @c false if it is not roaming.
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not supported
+ * @param[in] profile The profile handle
+ * @param[out] is_roaming @c true if the cellular is roaming,
+ * otherwise @c false if it is not roaming
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not supported
*/
int connection_profile_is_cellular_roaming(connection_profile_h profile, bool* is_roaming);
+
/**
* @brief Checks whether the profile is hidden.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] profile The profile handle
- * @param[out] is_hidden @c ture if the profile is in hidden, otherwise @c false if the profile is not hidden.
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not supported
+ * @param[in] profile The profile handle
+ * @param[out] is_hidden @c true if the profile is in hidden,
+ * otherwise @c false if the profile is not hidden
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not supported
*/
int connection_profile_is_cellular_hidden(connection_profile_h profile, bool* is_hidden);
+
/**
* @brief Checks whether the profile is editable.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @param[in] profile The profile handle
- * @param[out] is_editable @c true if the profile is editable, otherwise @c false if the profile is not editable.
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not supported
+ * @param[out] is_editable @c true if the profile is editable,
+ * otherwise @c false if the profile is not editable
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not supported
*/
int connection_profile_is_cellular_editable(connection_profile_h profile, bool* is_editable);
+
/**
* @brief Checks whether the profile is default.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] profile The profile handle
- * @param[out] is_default @c true if the profile is default, otherwise @c false if the profile is not default.
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not supported
+ * @param[in] profile The profile handle
+ * @param[out] is_default @c true if the profile is default,
+ * otherwise @c false if the profile is not default
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not supported
*/
int connection_profile_is_cellular_default(connection_profile_h profile, bool* is_default);
+
/**
* @brief Sets the service type.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] profile The profile handle
- * @param[in] service_type The type of cellular service
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not supported
+ * @param[in] profile The profile handle
+ * @param[in] service_type The type of cellular service
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not supported
* @see connection_update_profile()
*/
int connection_profile_set_cellular_service_type(connection_profile_h profile, connection_cellular_service_type_e service_type);
+
/**
* @brief Sets the APN (Access Point Name).
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] profile The profile handle
- * @param[in] apn The name of APN
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not supported
+ * @param[in] profile The profile handle
+ * @param[in] apn The name of APN
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not supported
* @see connection_update_profile()
*/
int connection_profile_set_cellular_apn(connection_profile_h profile, const char* apn);
+
/**
* @brief Sets the Authentication information.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] profile The profile handle
- * @param[in] type The type of the authentication
- * @param[in] user_name The user name
- * @param[in] password The password
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not supported
+ * @param[in] profile The profile handle
+ * @param[in] type The type of the authentication
+ * @param[in] user_name The user name
+ * @param[in] password The password
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not supported
* @see connection_update_profile()
*/
int connection_profile_set_cellular_auth_info(connection_profile_h profile, connection_cellular_auth_type_e type, const char* user_name, const char* password);
+
/**
* @brief Sets the home URL.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] profile The profile handle
- * @param[in] home_url The home URL
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not supported
+ * @param[in] profile The profile handle
+ * @param[in] home_url The home URL
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not supported
* @see connection_update_profile()
*/
int connection_profile_set_cellular_home_url(connection_profile_h profile, const char* home_url);
+
/**
* @brief Sets the cellular pdn type.
* @since_tizen 3.0
* @param[in] profile The profile handle
* @param[in] type The cellular pdn type
- * @return @c 0 on success, otherwise negative error value
+ * @return @c 0 on success,
+ * otherwise negative error value
* @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
- * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not Supported
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
+ * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not Supported
*/
int connection_profile_set_cellular_pdn_type(connection_profile_h profile, connection_cellular_pdn_type_e type);
+
/**
* @brief Sets the cellular roam pdn type.
* @since_tizen 3.0
* @param[in] profile The profile handle
* @param[in] type The cellular pdn type
- * @return @c 0 on success, otherwise negative error value
+ * @return @c 0 on success,
+ * otherwise negative error value
* @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
* @retval #CONNECTION_ERROR_PERMISSION_DENIED Permission Denied
- * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not Supported
+ * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not Supported
*/
int connection_profile_set_cellular_roam_pdn_type(connection_profile_h profile, connection_cellular_pdn_type_e type);
+
/**
* @}
*/
#ifdef __cplusplus
}
+
#endif
+
#endif /* __TIZEN_NETWORK_CONNECTION_PROFILE_H__ */
* limitations under the License.
*/
+
#ifndef __NET_CONNECTION_INTF_H__
#define __NET_CONNECTION_INTF_H__
+
#include "connection_profile.h"
+
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
+
/**
* @file net_connection.h
*/
+
/**
* @addtogroup CAPI_NETWORK_CONNECTION_MANAGER_MODULE
* @{
*/
+
/**
* @brief The connection handle.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
typedef void* connection_h;
+
/**
* @brief The profiles iterator handle.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
typedef void* connection_profile_iterator_h;
+
/**
* @brief Enumeration for connection type.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
-typedef enum
-{
- CONNECTION_TYPE_DISCONNECTED = 0, /**< Disconnected */
- CONNECTION_TYPE_WIFI = 1, /**< Wi-Fi type */
- CONNECTION_TYPE_CELLULAR = 2, /**< Cellular type */
- CONNECTION_TYPE_ETHERNET = 3, /**< Ethernet type */
- CONNECTION_TYPE_BT = 4, /**< Bluetooth type */
- CONNECTION_TYPE_NET_PROXY, /**< Proxy type for internet connection (Since 3.0) */
+typedef enum {
+ CONNECTION_TYPE_DISCONNECTED = 0, /**< Disconnected */
+ CONNECTION_TYPE_WIFI = 1, /**< Wi-Fi type */
+ CONNECTION_TYPE_CELLULAR = 2, /**< Cellular type */
+ CONNECTION_TYPE_ETHERNET = 3, /**< Ethernet type */
+ CONNECTION_TYPE_BT = 4, /**< Bluetooth type */
+ CONNECTION_TYPE_NET_PROXY, /**< Proxy type for internet connection (Since 3.0) */
} connection_type_e;
+
/**
* @brief Enumeration for cellular network state.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
-typedef enum
-{
- CONNECTION_CELLULAR_STATE_OUT_OF_SERVICE = 0, /**< Out of service */
- CONNECTION_CELLULAR_STATE_FLIGHT_MODE = 1, /**< Flight mode */
- CONNECTION_CELLULAR_STATE_ROAMING_OFF = 2, /**< Roaming is turned off */
- CONNECTION_CELLULAR_STATE_CALL_ONLY_AVAILABLE = 3, /**< Call is only available */
- CONNECTION_CELLULAR_STATE_AVAILABLE = 4, /**< Available but not connected yet */
- CONNECTION_CELLULAR_STATE_CONNECTED = 5, /**< Connected */
+typedef enum {
+ CONNECTION_CELLULAR_STATE_OUT_OF_SERVICE = 0, /**< Out of service */
+ CONNECTION_CELLULAR_STATE_FLIGHT_MODE = 1, /**< Flight mode */
+ CONNECTION_CELLULAR_STATE_ROAMING_OFF = 2, /**< Roaming is turned off */
+ CONNECTION_CELLULAR_STATE_CALL_ONLY_AVAILABLE = 3, /**< Call is only available */
+ CONNECTION_CELLULAR_STATE_AVAILABLE = 4, /**< Available but not connected yet */
+ CONNECTION_CELLULAR_STATE_CONNECTED = 5, /**< Connected */
} connection_cellular_state_e;
+
/**
* @brief Enumeration for Wi-Fi state.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
-typedef enum
-{
- CONNECTION_WIFI_STATE_DEACTIVATED = 0, /**< Wi-Fi is deactivated */
- CONNECTION_WIFI_STATE_DISCONNECTED = 1, /**< Disconnected */
- CONNECTION_WIFI_STATE_CONNECTED = 2, /**< Connected */
+typedef enum {
+ CONNECTION_WIFI_STATE_DEACTIVATED = 0, /**< Wi-Fi is deactivated */
+ CONNECTION_WIFI_STATE_DISCONNECTED = 1, /**< Disconnected */
+ CONNECTION_WIFI_STATE_CONNECTED = 2, /**< Connected */
} connection_wifi_state_e;
+
/**
* @brief Enumeration for ethernet state.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*/
-typedef enum
-{
- CONNECTION_ETHERNET_STATE_DEACTIVATED = 0, /**< There is no Ethernet profile to open */
- CONNECTION_ETHERNET_STATE_DISCONNECTED = 1, /**< Disconnected */
- CONNECTION_ETHERNET_STATE_CONNECTED = 2, /**< Connected */
+typedef enum {
+ CONNECTION_ETHERNET_STATE_DEACTIVATED = 0, /**< There is no Ethernet profile to open */
+ CONNECTION_ETHERNET_STATE_DISCONNECTED = 1, /**< Disconnected */
+ CONNECTION_ETHERNET_STATE_CONNECTED = 2, /**< Connected */
} connection_ethernet_state_e;
+
/**
* @brief Enumeration for Bluetooth state.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
-typedef enum
-{
- CONNECTION_BT_STATE_DEACTIVATED = 0, /**< There is no Bluetooth profile to open */
- CONNECTION_BT_STATE_DISCONNECTED = 1, /**< Disconnected */
- CONNECTION_BT_STATE_CONNECTED = 2, /**< Connected */
+typedef enum {
+ CONNECTION_BT_STATE_DEACTIVATED = 0, /**< There is no Bluetooth profile to open */
+ CONNECTION_BT_STATE_DISCONNECTED = 1, /**< Disconnected */
+ CONNECTION_BT_STATE_CONNECTED = 2, /**< Connected */
} connection_bt_state_e;
+
/**
* @brief Enumeration for connection iterator type.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
-typedef enum
-{
- CONNECTION_ITERATOR_TYPE_REGISTERED = 0, /**< The iterator of the registered profile */
- CONNECTION_ITERATOR_TYPE_CONNECTED = 1, /**< The iterator of the connected profile */
- CONNECTION_ITERATOR_TYPE_DEFAULT = 2, /**< The iterator of the default profile */
+typedef enum {
+ CONNECTION_ITERATOR_TYPE_REGISTERED = 0, /**< The iterator of the registered profile */
+ CONNECTION_ITERATOR_TYPE_CONNECTED = 1, /**< The iterator of the connected profile */
+ CONNECTION_ITERATOR_TYPE_DEFAULT = 2, /**< The iterator of the default profile */
} connection_iterator_type_e;
+
/**
* @brief Enumeration for reset profile type.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
-typedef enum
-{
- CONNECTION_RESET_DEFAULT_PROFILE = 0, /**< Initialized with the default profile defined by csc */
- CONNECTION_RESET_CLEAR_PROFILE = 1, /**< Remove all profiles */
+typedef enum {
+ CONNECTION_RESET_DEFAULT_PROFILE = 0, /**< Initialized with the default profile defined by csc */
+ CONNECTION_RESET_CLEAR_PROFILE = 1, /**< Remove all profiles */
} connection_reset_option_e;
+
/**
- * @brief This enumeration defines the attached or detached state of ethernet cable.
+ * @brief Enumeration for the attached or detached state of ethernet cable.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*/
-typedef enum
-{
- CONNECTION_ETHERNET_CABLE_DETACHED = 0, /**< Ethernet cable is detached */
- CONNECTION_ETHERNET_CABLE_ATTACHED = 1, /**< Ethernet cable is attached */
+typedef enum {
+ CONNECTION_ETHERNET_CABLE_DETACHED = 0, /**< Ethernet cable is detached */
+ CONNECTION_ETHERNET_CABLE_ATTACHED = 1, /**< Ethernet cable is attached */
} connection_ethernet_cable_state_e;
+
/**
* @brief Enumeration for connection errors.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
-typedef enum
-{
- CONNECTION_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */
- CONNECTION_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER, /**< Invalid parameter */
- CONNECTION_ERROR_OUT_OF_MEMORY = TIZEN_ERROR_OUT_OF_MEMORY, /**< Out of memory error */
- CONNECTION_ERROR_INVALID_OPERATION = TIZEN_ERROR_INVALID_OPERATION, /**< Invalid Operation */
- CONNECTION_ERROR_ADDRESS_FAMILY_NOT_SUPPORTED = TIZEN_ERROR_ADDRESS_FAMILY_NOT_SUPPORTED, /**< Address family not supported */
- CONNECTION_ERROR_OPERATION_FAILED = TIZEN_ERROR_CONNECTION|0x0401, /**< Operation failed */
- CONNECTION_ERROR_ITERATOR_END = TIZEN_ERROR_CONNECTION|0x0402, /**< End of iteration */
- CONNECTION_ERROR_NO_CONNECTION = TIZEN_ERROR_CONNECTION|0x0403, /**< There is no connection */
- CONNECTION_ERROR_NOW_IN_PROGRESS = TIZEN_ERROR_NOW_IN_PROGRESS, /** Now in progress */
- CONNECTION_ERROR_ALREADY_EXISTS = TIZEN_ERROR_CONNECTION|0x0404, /**< Already exists */
- CONNECTION_ERROR_OPERATION_ABORTED = TIZEN_ERROR_CONNECTION|0x0405, /**< Operation is aborted */
- CONNECTION_ERROR_DHCP_FAILED = TIZEN_ERROR_CONNECTION|0x0406, /**< DHCP failed */
- CONNECTION_ERROR_INVALID_KEY = TIZEN_ERROR_CONNECTION|0x0407, /**< Invalid key */
- CONNECTION_ERROR_NO_REPLY = TIZEN_ERROR_CONNECTION|0x0408, /**< No reply */
- CONNECTION_ERROR_PERMISSION_DENIED = TIZEN_ERROR_PERMISSION_DENIED, /**< Permission denied */
- CONNECTION_ERROR_NOT_SUPPORTED = TIZEN_ERROR_NOT_SUPPORTED /**< Not Supported */
+typedef enum {
+ CONNECTION_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */
+ CONNECTION_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER, /**< Invalid parameter */
+ CONNECTION_ERROR_OUT_OF_MEMORY = TIZEN_ERROR_OUT_OF_MEMORY, /**< Out of memory error */
+ CONNECTION_ERROR_INVALID_OPERATION = TIZEN_ERROR_INVALID_OPERATION, /**< Invalid Operation */
+ CONNECTION_ERROR_ADDRESS_FAMILY_NOT_SUPPORTED = TIZEN_ERROR_ADDRESS_FAMILY_NOT_SUPPORTED, /**< Address family not supported */
+ CONNECTION_ERROR_OPERATION_FAILED = TIZEN_ERROR_CONNECTION|0x0401, /**< Operation failed */
+ CONNECTION_ERROR_ITERATOR_END = TIZEN_ERROR_CONNECTION|0x0402, /**< End of iteration */
+ CONNECTION_ERROR_NO_CONNECTION = TIZEN_ERROR_CONNECTION|0x0403, /**< There is no connection */
+ CONNECTION_ERROR_NOW_IN_PROGRESS = TIZEN_ERROR_NOW_IN_PROGRESS, /** Now in progress */
+ CONNECTION_ERROR_ALREADY_EXISTS = TIZEN_ERROR_CONNECTION|0x0404, /**< Already exists */
+ CONNECTION_ERROR_OPERATION_ABORTED = TIZEN_ERROR_CONNECTION|0x0405, /**< Operation is aborted */
+ CONNECTION_ERROR_DHCP_FAILED = TIZEN_ERROR_CONNECTION|0x0406, /**< DHCP failed */
+ CONNECTION_ERROR_INVALID_KEY = TIZEN_ERROR_CONNECTION|0x0407, /**< Invalid key */
+ CONNECTION_ERROR_NO_REPLY = TIZEN_ERROR_CONNECTION|0x0408, /**< No reply */
+ CONNECTION_ERROR_PERMISSION_DENIED = TIZEN_ERROR_PERMISSION_DENIED, /**< Permission denied */
+ CONNECTION_ERROR_NOT_SUPPORTED = TIZEN_ERROR_NOT_SUPPORTED /**< Not Supported */
} connection_error_e;
+
/**
* @}
*/
+
/**
* @addtogroup CAPI_NETWORK_CONNECTION_STATISTICS_MODULE
* @{
*/
+
/**
* @brief Enumeration for statistics type.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
-typedef enum
-{
- CONNECTION_STATISTICS_TYPE_LAST_RECEIVED_DATA = 0, /**< Last received data */
- CONNECTION_STATISTICS_TYPE_LAST_SENT_DATA = 1, /**< Last sent data */
- CONNECTION_STATISTICS_TYPE_TOTAL_RECEIVED_DATA = 2, /**< Total received data */
- CONNECTION_STATISTICS_TYPE_TOTAL_SENT_DATA = 3, /**< Total sent data */
+typedef enum {
+ CONNECTION_STATISTICS_TYPE_LAST_RECEIVED_DATA = 0, /**< Last received data */
+ CONNECTION_STATISTICS_TYPE_LAST_SENT_DATA = 1, /**< Last sent data */
+ CONNECTION_STATISTICS_TYPE_TOTAL_RECEIVED_DATA = 2, /**< Total received data */
+ CONNECTION_STATISTICS_TYPE_TOTAL_SENT_DATA = 3, /**< Total sent data */
} connection_statistics_type_e;
+
/**
* @}
*/
+
/**
* @addtogroup CAPI_NETWORK_CONNECTION_MANAGER_MODULE
* @{
* @privlevel public
* @privilege %http://tizen.org/privilege/network.get
* @remarks You must release @a handle using connection_destroy().
- * @param[out] connection The connection handle
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_OUT_OF_MEMORY Out of memory
+ * @param[out] connection The connection handle
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_OUT_OF_MEMORY Out of memory
* @see connection_destroy()
*/
int connection_create(connection_h* connection);
+
/**
* @brief Destroys the connection handle.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] connection The connection handle
- * @return @c 0 on success, otherwise negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @param[in] connection The connection handle
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
* @see connection_create()
*/
int connection_destroy(connection_h connection);
+
/**
* @brief Called when the type of a connection is changed.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] type The type of the current network connection
+ * @param[in] type The type of the current network connection
* @param[in] user_data The user data passed from the callback registration function
* @see connection_set_type_changed_cb()
* @see connection_unset_type_changed_cb()
*/
typedef void(*connection_type_changed_cb)(connection_type_e type, void* user_data);
+
/**
* @brief Called when the address is changed.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] ipv4_address The IP address for IPv4
- * @param[in] ipv6_address The IP address for IPv6
+ * @param[in] ipv4_address The IP address for IPv4
+ * @param[in] ipv6_address The IP address for IPv6
* @param[in] user_data The user data passed from the callback registration function
* @see connection_set_ip_address_changed_cb()
* @see connection_unset_ip_address_changed_cb()
*/
typedef void(*connection_address_changed_cb)(const char* ipv4_address, const char* ipv6_address, void* user_data);
+
/**
* @brief Called when connection_set_default_cellular_service_profile_async() finishes.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] result The result
+ * @param[in] result The result
* @param[in] user_data The user data passed from connection_open_profile()
* @pre connection_set_default_cellular_service_profile_async() will invoke this callback function.
* @see connection_set_default_cellular_service_profile_async()
*/
typedef void(*connection_set_default_cb)(connection_error_e result, void* user_data);
+
/**
* @brief Gets the type of the current profile for data connection.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] connection The connection handle
- * @param[out] type The type of the network
- * @return @c 0 on success, otherwise negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
+ * @param[in] connection The connection handle
+ * @param[out] type The type of the network
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
*/
int connection_get_type(connection_h connection, connection_type_e* type);
+
/**
* @brief Gets the IP address of the current connection.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @remarks You must release @a ip_address using free().
- * @param[in] connection The connection handle
- * @param[in] address_family The address family
- * @param[out] ip_address The pointer to the IP address string
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
- * @retval #CONNECTION_ERROR_ADDRESS_FAMILY_NOT_SUPPORTED Not supported address family
+ * @param[in] connection The connection handle
+ * @param[in] address_family The address family
+ * @param[out] ip_address The pointer to the IP address string
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
+ * @retval #CONNECTION_ERROR_ADDRESS_FAMILY_NOT_SUPPORTED Not supported address family
*/
int connection_get_ip_address(connection_h connection, connection_address_family_e address_family, char** ip_address);
+
/**
* @brief Gets the proxy address of the current connection.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @remarks You must release @a proxy using free().
- * @param[in] connection The connection handle
- * @param[in] address_family The address family
- * @param[out] proxy The proxy address
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
- * @retval #CONNECTION_ERROR_ADDRESS_FAMILY_NOT_SUPPORTED Not supported address family
+ * @param[in] connection The connection handle
+ * @param[in] address_family The address family
+ * @param[out] proxy The proxy address
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
+ * @retval #CONNECTION_ERROR_ADDRESS_FAMILY_NOT_SUPPORTED Not supported address family
*/
int connection_get_proxy(connection_h connection, connection_address_family_e address_family, char** proxy);
+
/**
* @brief Gets the MAC address of the Wi-Fi or ethernet.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
* @remarks @a mac_addr must be released with free() by you.
- * @param[in] connection The handle of the connection
- * @param[in] type The type of current network connection
- * @param[out] mac_addr The MAC address
- * @return 0 on success, otherwise negative error value.
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_INVALID_OPERATION Invalid operation
- * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
- * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not supported
- * @retval #CONNECTION_ERROR_OUT_OF_MEMORY Out of memory
+ * @param[in] connection The handle of the connection
+ * @param[in] type The type of current network connection
+ * @param[out] mac_addr The MAC address
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_INVALID_OPERATION Invalid operation
+ * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
+ * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not supported
+ * @retval #CONNECTION_ERROR_OUT_OF_MEMORY Out of memory
*/
int connection_get_mac_address(connection_h connection, connection_type_e type, char** mac_addr);
+
/**
* @brief Gets the state of cellular connection.
* @details The returned state is for the cellular connection state.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] connection The connection handle
- * @param[out] state The state of the cellular connection
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
- * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not supported
+ * @param[in] connection The connection handle
+ * @param[out] state The state of the cellular connection
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
+ * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not supported
*/
int connection_get_cellular_state(connection_h connection, connection_cellular_state_e* state);
+
/**
* @brief Gets the state of the Wi-Fi.
* @details The returned state is for the Wi-Fi connection state.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/network.get
- * @param[in] connection The connection handle
- * @param[out] state The state of Wi-Fi connection
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
+ * @param[in] connection The connection handle
+ * @param[out] state The state of Wi-Fi connection
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
* @retval #CONNECTION_ERROR_PERMISSION_DENIED Permission Denied
* @retval #CONNECTION_ERROR_NOT_SUPPORTED Not supported
*/
int connection_get_wifi_state(connection_h connection, connection_wifi_state_e* state);
+
/**
* @brief Gets the state of the Ethernet.
* @details The returned state is for the Ethernet connection state.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/network.get
- * @param[in] connection The connection handle
- * @param[out] state The state of Ethernet connection
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
+ * @param[in] connection The connection handle
+ * @param[out] state The state of Ethernet connection
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
* @retval #CONNECTION_ERROR_PERMISSION_DENIED Permission Denied
- * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not supported
+ * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not supported
*/
int connection_get_ethernet_state(connection_h connection, connection_ethernet_state_e* state);
+
/**
-* @brief Checks for ethernet cable is attached or not.
-* @details The returned state is for the ethernet cable state.
-* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
-* @privlevel public
-* @privilege %http://tizen.org/privilege/network.get
-* @param[in] connection The handle of the connection
-* @param[in] state - Enum connection_ethernet_cable_state_e
-* @return 0 on success, otherwise negative error value
-* @retval #CONNECTION_ERROR_NONE Successful
-* @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
-* @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
-* @retval #CONNECTION_ERROR_NOT_SUPPORTED Not supported
-* @retval #CONNECTION_ERROR_PERMISSION_DENIED Permission Denied
-*/
+ * @brief Checks for ethernet cable is attached or not.
+ * @details The returned state is for the ethernet cable state.
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/network.get
+ * @param[in] connection The handle of the connection
+ * @param[in] state - Enum connection_ethernet_cable_state_e
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
+ * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not supported
+ * @retval #CONNECTION_ERROR_PERMISSION_DENIED Permission Denied
+ */
int connection_get_ethernet_cable_state(connection_h connection, connection_ethernet_cable_state_e *state);
+
/**
* @brief Called when ethernet cable is plugged [in/out].
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
* @param[in] state The ethernet cable state (connection_ethernet_cable_state_e)
* @param[in] user_data The user data passed to callback registration function
*/
-typedef void(*connection_ethernet_cable_state_chaged_cb)(
- connection_ethernet_cable_state_e state, void* user_data);
+typedef void(*connection_ethernet_cable_state_chaged_cb)(connection_ethernet_cable_state_e state, void* user_data);
+
/**
* @brief Registers callback for ethernet cable is plugged [in/out] event.
* @param[in] connection The handle of connection
* @param[in] callback The callback function to be called
* @param[in] user_data The user data passed to the callback function
- * @return 0 on success, otherwise negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
- * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not supported
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
+ * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not supported
*/
-int connection_set_ethernet_cable_state_chaged_cb( connection_h connection,
- connection_ethernet_cable_state_chaged_cb callback, void *user_data);
+int connection_set_ethernet_cable_state_chaged_cb(connection_h connection, connection_ethernet_cable_state_chaged_cb callback, void *user_data);
+
/**
* @brief Unregisters callback for ethernet cable is plugged [in/out] event.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
- * @param[in] connection The handle of connection
- * @return 0 on success, otherwise negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
- * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not supported
+ * @param[in] connection The handle of connection
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
+ * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not supported
*/
int connection_unset_ethernet_cable_state_chaged_cb(connection_h connection);
+
/**
* @brief Gets the state of the Bluetooth.
* @details The returned state is for the Bluetooth connection state.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/network.get
- * @param[in] connection The connection handle
- * @param[out] state The state of the Bluetooth connection
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
+ * @param[in] connection The connection handle
+ * @param[out] state The state of the Bluetooth connection
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
* @retval #CONNECTION_ERROR_PERMISSION_DENIED Permission Denied
- * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not supported
+ * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not supported
*/
int connection_get_bt_state(connection_h connection, connection_bt_state_e* state);
+
/**
* @brief Registers the callback that is called when the type of the current connection is changed.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] connection The connection handle
- * @param[in] callback The callback function to be called
+ * @param[in] connection The connection handle
+ * @param[in] callback The callback function to be called
* @param[in] user_data The user data passed to the callback function
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
*/
int connection_set_type_changed_cb(connection_h connection, connection_type_changed_cb callback, void* user_data);
+
/**
* @brief Unregisters the callback that is called when the type of current connection is changed.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] connection The connection handle
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
+ * @param[in] connection The connection handle
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
*/
int connection_unset_type_changed_cb(connection_h connection);
+
/**
* @brief Registers the callback that is called when the IP address is changed.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] connection The connection handle
- * @param[in] callback The callback function to be called
+ * @param[in] connection The connection handle
+ * @param[in] callback The callback function to be called
* @param[in] user_data The user data passed to the callback function
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
*/
int connection_set_ip_address_changed_cb(connection_h connection, connection_address_changed_cb callback, void* user_data);
+
/**
* @brief Unregisters the callback that is called when the IP address is changed.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] connection The connection handle
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
+ * @param[in] connection The connection handle
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
*/
int connection_unset_ip_address_changed_cb(connection_h connection);
+
/**
* @brief Registers the callback that is called when the proxy address is changed.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] connection The connection handle
- * @param[in] callback The callback function to be called
+ * @param[in] connection The connection handle
+ * @param[in] callback The callback function to be called
* @param[in] user_data The user data passed to the callback function
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
*/
int connection_set_proxy_address_changed_cb(connection_h connection, connection_address_changed_cb callback, void* user_data);
+
/**
* @brief Unregisters the callback that is called when the proxy address is changed.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] connection The connection handle
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
+ * @param[in] connection The connection handle
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
*/
int connection_unset_proxy_address_changed_cb(connection_h connection);
+
/**
* @brief Adds a new profile which is created by connection_profile_create().
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/network.profile
* @remarks You can only add a profile of the cellular type.
- * @param[in] connection The connection handle
- * @param[in] profile The profile handle
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
+ * @param[in] connection The connection handle
+ * @param[in] profile The profile handle
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
* @retval #CONNECTION_ERROR_PERMISSION_DENIED Permission Denied
- * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not Supported
+ * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not Supported
*/
int connection_add_profile(connection_h connection, connection_profile_h profile);
+
/**
* @brief Removes an existing profile.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/network.profile \n
- * %http://tizen.org/privilege/network.get
+ * %http://tizen.org/privilege/network.get
* @remarks This API needs both privileges.
- * @param[in] connection The connection handle
- * @param[in] profile The profile handle
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
+ * @param[in] connection The connection handle
+ * @param[in] profile The profile handle
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
* @retval #CONNECTION_ERROR_PERMISSION_DENIED Permission Denied
- * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not Supported
+ * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not Supported
*/
int connection_remove_profile(connection_h connection, connection_profile_h profile);
+
/**
* @brief Updates an existing profile.
* @details When a profile is changed, these changes will be not applied to the Connection Manager immediately.
- * When you call this function, your changes affect the Connection Manager and the existing profile is updated.
- * In addition, the existing profile will be updated if you call connection_open_profile().
+ * When you call this function, your changes affect the Connection Manager and the existing profile is updated.
+ * In addition, the existing profile will be updated if you call connection_open_profile().
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/network.profile \n
- * %http://tizen.org/privilege/network.get
+ * %http://tizen.org/privilege/network.get
* @remarks This API needs both privileges.
- * @param[in] connection The connection handle
- * @param[in] profile The profile handle
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
+ * @param[in] connection The connection handle
+ * @param[in] profile The profile handle
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
* @retval #CONNECTION_ERROR_PERMISSION_DENIED Permission Denied
- * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not Supported
+ * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not Supported
* @see connection_open_profile()
*/
int connection_update_profile(connection_h connection, connection_profile_h profile);
+
/**
* @brief Gets a profiles iterator.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/network.get
* @remarks You must release @a profile_iterator using connection_destroy().
- * @param[in] connection The connection handle
- * @param[in] type The type of the connetion iterator
- * @param[out] profile_iterator The iterator of profile
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
+ * @param[in] connection The connection handle
+ * @param[in] type The type of the connetion iterator
+ * @param[out] profile_iterator The iterator of profile
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_OUT_OF_MEMORY Out of memory
+ * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
* @retval #CONNECTION_ERROR_PERMISSION_DENIED Permission Denied
*/
int connection_get_profile_iterator(connection_h connection, connection_iterator_type_e type, connection_profile_iterator_h* profile_iterator);
+
/**
* @brief Moves the profile iterator to the next position and gets a profile handle.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] profile_iterator The iterator of profile
- * @param[out] profile The profile handle
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_ITERATOR_END End of iteration
+ * @param[in] profile_iterator The iterator of profile
+ * @param[out] profile The profile handle
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_ITERATOR_END End of iteration
*/
int connection_profile_iterator_next(connection_profile_iterator_h profile_iterator, connection_profile_h* profile);
+
/**
* @brief Checks whether the next element of a profile iterator exists or not.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
- * @param[in] profile_iterator The iterator of profile
- * @return @c true if next element exists, otherwise @c false if next element doesn't exist
+ * @param[in] profile_iterator The iterator of profile
+ * @return @c true if next element exists,
+ * otherwise @c false if next element doesn't exist
*/
bool connection_profile_iterator_has_next(connection_profile_iterator_h profile_iterator);
+
/**
* @brief Destroys a profiles iterator.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] profile_iterator The iterator of the profile
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @param[in] profile_iterator The iterator of the profile
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
*/
int connection_destroy_profile_iterator(connection_profile_iterator_h profile_iterator);
+
/**
* @brief Gets the name of the default profile.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/network.get
* @remarks You must release @a profile using connection_profile_destroy().
- * @param[in] connection The connection handle
- * @param[out] profile The profile handle
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
- * @retval #CONNECTION_ERROR_NO_CONNECTION There is no connection
+ * @param[in] connection The connection handle
+ * @param[out] profile The profile handle
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_OUT_OF_MEMORY Out of memory
+ * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
+ * @retval #CONNECTION_ERROR_NO_CONNECTION There is no connection
* @retval #CONNECTION_ERROR_PERMISSION_DENIED Permission Denied
*/
int connection_get_current_profile(connection_h connection, connection_profile_h* profile);
+
/**
* @brief Gets the default profile which provides the given cellular service.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/network.get
* @remarks You must release @a profile using connection_profile_destroy().
- * @param[in] connection The connection handle
- * @param[in] type The type of cellular service \n
- * #CONNECTION_CELLULAR_SERVICE_TYPE_APPLICATION is not permitted.
- * @param[out] profile The profile handle
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
+ * @param[in] connection The connection handle
+ * @param[in] type The type of cellular service \n
+ * #CONNECTION_CELLULAR_SERVICE_TYPE_APPLICATION is not permitted
+ * @param[out] profile The profile handle
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_OUT_OF_MEMORY Out of memory
+ * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
* @retval #CONNECTION_ERROR_PERMISSION_DENIED Permission Denieda
- * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not Supported
+ * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not Supported
*/
int connection_get_default_cellular_service_profile(connection_h connection, connection_cellular_service_type_e type, connection_profile_h* profile);
+
/**
* @brief Sets the default profile which provides the given cellular service.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/network.profile \n
- * %http://tizen.org/privilege/network.get
+ * %http://tizen.org/privilege/network.get
* @remarks This API needs both privileges.
- * @param[in] connection The connection handle
- * @param[in] type The type of cellular service \n
- * only #CONNECTION_CELLULAR_SERVICE_TYPE_INTERNET and #CONNECTION_CELLULAR_SERVICE_TYPE_PREPAID_INTERNET are permitted.
- * @param[in] profile The profile handle
- * @return @c 0 on success, otherwise a negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
+ * @param[in] connection The connection handle
+ * @param[in] type The type of cellular service \n
+ * only #CONNECTION_CELLULAR_SERVICE_TYPE_INTERNET and #CONNECTION_CELLULAR_SERVICE_TYPE_PREPAID_INTERNET are permitted
+ * @param[in] profile The profile handle
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
* @retval #CONNECTION_ERROR_PERMISSION_DENIED Permission Denied
* @retval #CONNECTION_ERROR_NOT_SUPPORTED Not Supported
*/
int connection_set_default_cellular_service_profile(connection_h connection, connection_cellular_service_type_e type, connection_profile_h profile);
+
/**
* @brief Sets the default profile which provides the given cellular service, asynchronously.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/network.profile \n
- * %http://tizen.org/privilege/network.get
+ * %http://tizen.org/privilege/network.get
* @remarks This API needs both privileges.
- * @param[in] connection The connection handle
- * @param[in] type The type of cellular service (only #CONNECTION_CELLULAR_SERVICE_TYPE_INTERNET and #CONNECTION_CELLULAR_SERVICE_TYPE_PREPAID_INTERNET are permitted)
- * @param[in] profile The profile handle
- * @param[in] callback The callback function to be called
+ * @param[in] connection The connection handle
+ * @param[in] type The type of cellular service (only #CONNECTION_CELLULAR_SERVICE_TYPE_INTERNET and #CONNECTION_CELLULAR_SERVICE_TYPE_PREPAID_INTERNET are permitted)
+ * @param[in] profile The profile handle
+ * @param[in] callback The callback function to be called
* @param[in] user_data The user data passed to the callback function
- * @return @c 0 on success, otherwise negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
* @retval #CONNECTION_ERROR_PERMISSION_DENIED Permission Denied
- * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not Supported
+ * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not Supported
*/
int connection_set_default_cellular_service_profile_async(connection_h connection,
connection_cellular_service_type_e type, connection_profile_h profile, connection_set_default_cb callback, void* user_data);
+
/**
* @brief Called after connection_open_profile() is finished.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] result The result
+ * @param[in] result The result
* @param[in] user_data The user data passed from connection_open_profile()
* @pre connection_open_profile() will invoke this callback function.
* @see connection_open_profile()
*/
typedef void(*connection_opened_cb)(connection_error_e result, void* user_data);
+
/**
* @brief Called after connection_close_profile() is finished.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] result The result
+ * @param[in] result The result
* @param[in] user_data The user data passed from connection_close_profile()
* @pre connection_close_profile() will invoke this callback function.
* @see connection_close_profile()
*/
typedef void(*connection_closed_cb)(connection_error_e result, void* user_data);
+
/**
* @brief Called after connection_reset_profile() is finished.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] result The result
+ * @param[in] result The result
* @param[in] user_data The user data passed from connection_reset_profile()
* @pre connection_reset_profile() will invoke this callback function.
* @see connection_reset_profile()
*/
typedef void(*connection_reset_cb)(connection_error_e result, void* user_data);
+
/**
* @brief Opens a connection of profile, asynchronously.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/network.set \n
- * %http://tizen.org/privilege/network.get
+ * %http://tizen.org/privilege/network.get
* @remarks This API needs both privileges.
- * @param[in] connection The connection handle
- * @param[in] profile The profile handle
- * @param[in] callback The callback function to be called
+ * @param[in] connection The connection handle
+ * @param[in] profile The profile handle
+ * @param[in] callback The callback function to be called
* @param[in] user_data The user data passed to the callback function
- * @return @c 0 on success, otherwise negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
* @retval #CONNECTION_ERROR_PERMISSION_DENIED Permission Denied
* @post connection_opened_cb() will be invoked.
* @see connection_opened_cb()
*/
int connection_open_profile(connection_h connection, connection_profile_h profile, connection_opened_cb callback, void* user_data);
+
/**
* @brief Closes a connection of profile.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/network.set
- * @param[in] connection The connection handle
- * @param[in] profile The profile handle
- * @param[in] callback The callback function to be called
+ * @param[in] connection The connection handle
+ * @param[in] profile The profile handle
+ * @param[in] callback The callback function to be called
* @param[in] user_data The user data passed to the callback function
- * @return @c 0 on success, otherwise negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
* @retval #CONNECTION_ERROR_PERMISSION_DENIED Permission Denied
* @post connection_closed_cb() will be invoked.
* @see connection_closed_cb()
*/
int connection_close_profile(connection_h connection, connection_profile_h profile, connection_closed_cb callback, void* user_data);
+
/**
* @brief Resets the cellular profile.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/network.profile \n
- * %http://tizen.org/privilege/network.get
+ * %http://tizen.org/privilege/network.get
* @remarks This API needs both privileges.
- * @param[in] connection The connection handle
- * @param[in] type The type of reset
- * @param[in] id The subscriber identity module id to reset (The sim index starts from 0.)
- * @param[in] callback The callback function to be called
+ * @param[in] connection The connection handle
+ * @param[in] type The type of reset
+ * @param[in] id The subscriber identity module ID to reset (The sim index starts from 0.)
+ * @param[in] callback The callback function to be called
* @param[in] user_data The user data passed to the callback function
- * @return 0 on success, otherwise negative error value
+ * @return @c 0 on success,
+ * otherwise a negative error value
* @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
* @retval #CONNECTION_ERROR_PERMISSION_DENIED Permission Denied
* @retval #CONNECTION_ERROR_NOT_SUPPORTED Not Supported
* @post connection_reset_cb() will be invoked.
*/
int connection_reset_profile(connection_h connection, connection_reset_option_e type, int id, connection_reset_cb callback, void *user_data);
+
/**
* @brief Adds a IPv4 route to the routing table.
* @details You can get the @a interface_name from connection_profile_get_network_interface_name() of opened profile.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/network.set
- * @param[in] connection The connection handle
- * @param[in] interface_name The name of network interface
- * @param[in] host_address The IP address of the host
- * @return @c 0 on success, otherwise negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_ALREADY_EXISTS Already exists
- * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
+ * @param[in] connection The connection handle
+ * @param[in] interface_name The name of network interface
+ * @param[in] host_address The IP address of the host
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_ALREADY_EXISTS Already exists
+ * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
* @retval #CONNECTION_ERROR_PERMISSION_DENIED Permission Denied
* @see connection_profile_get_network_interface_name()
*/
int connection_add_route(connection_h connection, const char* interface_name, const char* host_address);
+
/**
* @brief Removes a IPv4 route from the routing table.
* @details You can get the @a interface_name from connection_profile_get_network_interface_name() of opened profile.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/network.set
- * @param[in] connection The connection handle
- * @param[in] interface_name The name of network interface
- * @param[in] host_address The IP address of the host
- * @return @c 0 on success, otherwise negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
+ * @param[in] connection The connection handle
+ * @param[in] interface_name The name of network interface
+ * @param[in] host_address The IP address of the host
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
* @retval #CONNECTION_ERROR_PERMISSION_DENIED Permission Denied
* @see connection_profile_get_network_interface_name()
*/
int connection_remove_route(connection_h connection, const char* interface_name, const char* host_address);
+
/**
* @brief Adds a IPv6 route to the routing table.
* @details You can get the @a interface_name from connection_profile_get_network_interface_name() of opened profile.
* @since_tizen 2.3.1
* @privlevel public
* @privilege %http://tizen.org/privilege/network.set
- * @param[in] connection The connection handle
- * @param[in] interface_name The name of network interface
- * @param[in] host_address The IP address of the host
- * @param[in] gateway The gateway address
- * @return @c 0 on success, otherwise negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_ALREADY_EXISTS Already exists
- * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
+ * @param[in] connection The connection handle
+ * @param[in] interface_name The name of network interface
+ * @param[in] host_address The IP address of the host
+ * @param[in] gateway The gateway address
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_ALREADY_EXISTS Already exists
+ * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
* @retval #CONNECTION_ERROR_PERMISSION_DENIED Permission Denied
* @see connection_profile_get_network_interface_name()
*/
int connection_add_route_ipv6(connection_h connection, const char *interface_name, const char *host_address, const char * gateway);
+
/**
* @brief Removes a IPV6 route from the routing table.
* @details You can get the @a interface_name from connection_profile_get_network_interface_name() of opened profile.
* @since_tizen 2.3.1
* @privlevel public
* @privilege %http://tizen.org/privilege/network.set
- * @param[in] connection The connection handle
- * @param[in] interface_name The name of network interface
- * @param[in] host_address The IP address of the host
- * @param[in] gateway The gateway address
- * @return @c 0 on success, otherwise negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
+ * @param[in] connection The connection handle
+ * @param[in] interface_name The name of network interface
+ * @param[in] host_address The IP address of the host
+ * @param[in] gateway The gateway address
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
* @retval #CONNECTION_ERROR_PERMISSION_DENIED Permission Denied
* @see connection_profile_get_network_interface_name()
*/
int connection_remove_route_ipv6(connection_h connection, const char *interface_name, const char *host_address, const char * gateway);
+
/**
* @}
*/
+
/**
* @addtogroup CAPI_NETWORK_CONNECTION_STATISTICS_MODULE
* @{
*/
+
/**
* @brief Gets the statistics information.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/network.get
- * @param[in] connection The connection handle
- * @param[in] connection_type The type of connection (only CONNECTION_TYPE_WIFI and CONNECTION_TYPE_CELLULAR are supported)
- * @param[in] statistics_type The type of statistics
- * @param[out] size The received data size of the last cellular packet data connection (bytes)
- * @return @c 0 on success, otherwise negative error value
- * @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
- * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not Supported
+ * @param[in] connection The connection handle
+ * @param[in] connection_type The type of connection (only CONNECTION_TYPE_WIFI and CONNECTION_TYPE_CELLULAR are supported)
+ * @param[in] statistics_type The type of statistics
+ * @param[out] size The received data size of the last cellular packet data connection (bytes)
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE Successful
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
+ * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not Supported
*/
int connection_get_statistics(connection_h connection, connection_type_e connection_type, connection_statistics_type_e statistics_type, long long* size);
+
/**
* @brief Resets the statistics information.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/network.set
* @remarks This API needs both privileges.
- * @param[in] connection The connection handle
- * @param[in] connection_type The type of connection (only CONNECTION_TYPE_WIFI and CONNECTION_TYPE_CELLULAR are supported)
- * @param[in] statistics_type The type of statistics
- * @return @c 0 on success, otherwise negative error value
+ * @param[in] connection The connection handle
+ * @param[in] connection_type The type of connection (only CONNECTION_TYPE_WIFI and CONNECTION_TYPE_CELLULAR are supported)
+ * @param[in] statistics_type The type of statistics
+ * @return @c 0 on success,
+ * otherwise a negative error value
* @retval #CONNECTION_ERROR_NONE Successful
- * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #CONNECTION_ERROR_OPERATION_FAILED Operation failed
* @retval #CONNECTION_ERROR_PERMISSION_DENIED Permission Denied
- * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not Supported
+ * @retval #CONNECTION_ERROR_NOT_SUPPORTED Not Supported
*/
int connection_reset_statistics(connection_h connection, connection_type_e connection_type, connection_statistics_type_e statistics_type);
+
/**
* @}
*/
+
#ifdef __cplusplus
}
#endif /* __cplusplus */
+
#endif
#define ETHERNET_MAC_INFO_FILE "/sys/class/net/eth0/address"
#define WIFI_MAC_INFO_FILE "/sys/class/net/wlan0/address"
-#define TELEPHONY_FEATURE "http://tizen.org/feature/network.telephony"
-#define WIFI_FEATURE "http://tizen.org/feature/network.wifi"
+#define TELEPHONY_FEATURE "http://tizen.org/feature/network.telephony"
+#define WIFI_FEATURE "http://tizen.org/feature/network.wifi"
#define TETHERING_BLUETOOTH_FEATURE "http://tizen.org/feature/network.tethering.bluetooth"
#define ETHERNET_FEATURE "http://tizen.org/feature/network.ethernet"
-typedef enum
-{
+typedef enum {
CONNECTION_CELLULAR_SUBSCRIBER_1 = 0x00,
CONNECTION_CELLULAR_SUBSCRIBER_2 = 0x01,
} connection_cellular_subscriber_id_e;
-typedef enum
-{
+typedef enum {
CONNECTION_SUPPORTED_FEATURE_TELEPHONY,
CONNECTION_SUPPORTED_FEATURE_WIFI,
CONNECTION_SUPPORTED_FEATURE_TETHERING_BLUETOOTH,
#define CHECK_FEATURE_SUPPORTED(...) \
do { \
int rv = _connection_check_feature_supported(__VA_ARGS__, NULL); \
- if( rv != CONNECTION_ERROR_NONE ) \
+ if (rv != CONNECTION_ERROR_NONE) \
return rv; \
- } while(0)
+ } while (0)
#define CONNECTION_LOG(log_level, format, args...) \
do { \
default: \
LOGI(format, ## args); \
} \
- } while(0)
+ } while (0)
#define SECURE_CONNECTION_LOG(log_level, format, args...) \
do { \
default: \
SECURE_LOGI(format, ## args); \
} \
- } while(0)
+ } while (0)
#define VCONF_TELEPHONY_DEFAULT_DATA_SERVICE \
"db/telephony/dualsim/default_data_service"
Name: capi-network-connection
Summary: Network Connection library in TIZEN C API
-Version: 1.0.93
+Version: 1.0.94
Release: 1
Group: System/Network
License: Apache-2.0
{
CHECK_FEATURE_SUPPORTED(TELEPHONY_FEATURE, WIFI_FEATURE, TETHERING_BLUETOOTH_FEATURE, ETHERNET_FEATURE);
+ CONNECTION_LOG(CONNECTION_ERROR, "Address Family: ", address_family);
if (!(_connection_libnet_check_profile_validity(profile)) ||
(address_family != CONNECTION_ADDRESS_FAMILY_IPV4 &&
address_family != CONNECTION_ADDRESS_FAMILY_IPV6)) {
projects / platform / core / api / connection.git / commitdiff