/**
* @brief Enumeration for cellular pdn type.
* @since_tizen 3.0
- * @remarks Use CONNECTION_CELLULAR_PDN_TYPE_IPV4_IPV6 instead of
+ * @remarks Use #CONNECTION_CELLULAR_PDN_TYPE_IPV4_IPV6 instead of
* CONNECTION_CELLULAR_PDN_TYPE_IPV4_IPv6.
*/
typedef enum {
- CONNECTION_CELLULAR_PDN_TYPE_UNKNOWN = 0, /**> Unknown */
- CONNECTION_CELLULAR_PDN_TYPE_IPV4 = 1, /**> IPv4 */
- CONNECTION_CELLULAR_PDN_TYPE_IPV6 = 2, /**> IPv6 */
- CONNECTION_CELLULAR_PDN_TYPE_IPV4_IPv6 = 3, /**> IPv4 and IPv6 (Deprecated since 4.0)*/
- CONNECTION_CELLULAR_PDN_TYPE_IPV4_IPV6 = 4, /**> IPv4 and IPv6 (Since 4.0)*/
+ CONNECTION_CELLULAR_PDN_TYPE_UNKNOWN = 0, /**< Unknown */
+ CONNECTION_CELLULAR_PDN_TYPE_IPV4 = 1, /**< IPv4 */
+ CONNECTION_CELLULAR_PDN_TYPE_IPV6 = 2, /**< IPv6 */
+ CONNECTION_CELLULAR_PDN_TYPE_IPV4_IPv6 = 3, /**< IPv4 and IPv6 (Deprecated since 4.0) */
+ CONNECTION_CELLULAR_PDN_TYPE_IPV4_IPV6 = 4, /**< IPv4 and IPv6 (Since 4.0) */
} connection_cellular_pdn_type_e;
/**
* @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()
+ * So, you must use this function 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
/**
- * @brief Gets the network type.
+ * @brief Gets the network state.
* @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
/**
- * @brief Registers the callback that is called when the state of profile is changed.
+ * @brief Sets 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
/**
- * @brief Unregisters the callback that is called when the state of profile is changed.
+ * @brief Unsets 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,
/**
- * @brief Gets the security mode of Wi-Fi.
+ * @brief Gets the security type 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
/**
- * @brief Gets the security mode of Wi-Fi.
+ * @brief Gets the encryption type 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
*/
-#ifndef __NET_CONNECTION_INTF_H__
-#define __NET_CONNECTION_INTF_H__
+#ifndef __TIZEN_NETWORK_NET_CONNECTION_H__
+#define __TIZEN_NETWORK_NET_CONNECTION_H__
#include <connection_profile.h>
* @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 handle using connection_destroy().
+ * @remarks You must release @a connection using connection_destroy().
* @param[out] connection The connection handle
* @return @c 0 on success,
* otherwise a negative error value
/**
* @brief Called when the address is changed.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @remarks @a ipv4_address @a ipv6_address should not be freed.
+ * @a ipv4_address @a ipv6_address is available only in the callback.
+ * To use outside the callback, make a copy.
* @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
/**
- * @deprecated Deprecated since 4.0. Use connection_ethernet_cable_state_changed_cb instead.
+ * @deprecated Deprecated since 4.0. Use connection_ethernet_cable_state_changed_cb() instead.
* @brief Called when ethernet cable is plugged [in/out].
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
* @param[in] state The state of ethernet cable
/**
* @deprecated Deprecated since 4.0. Use connection_set_ethernet_cable_state_changed_cb() instead.
- * @brief Registers callback for ethernet cable is plugged [in/out] event.
+ * @brief Sets 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
* @param[in] callback The callback function to be called
/**
* @deprecated Deprecated since 4.0. Use connection_unset_ethernet_cable_state_changed_cb() instead.
- * @brief Unregisters callback for ethernet cable is plugged [in/out] event.
+ * @brief Unsets 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 @c 0 on success,
/**
- * @brief Registers callback for ethernet cable is plugged [in/out] event.
+ * @brief Sets callback for ethernet cable is plugged [in/out] event.
* @since_tizen 4.0
* @param[in] connection The handle of connection
* @param[in] callback The callback function to be called
/**
- * @brief Unregisters callback for ethernet cable is plugged [in/out] event.
+ * @brief Unsets callback for ethernet cable is plugged [in/out] event.
* @since_tizen 4.0
* @param[in] connection The handle of connection
* @return @c 0 on success,
/**
- * @brief Registers the callback that is called when the type of the current connection is changed.
+ * @brief Sets 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
/**
- * @brief Unregisters the callback that is called when the type of current connection is changed.
+ * @brief Unsets 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,
/**
- * @brief Registers the callback that is called when the IP address is changed.
+ * @brief Sets 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
/**
- * @brief Unregisters the callback that is called when the IP address is changed.
+ * @brief Unsets 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,
/**
- * @brief Registers the callback that is called when the proxy address is changed.
+ * @brief Sets 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
/**
- * @brief Unregisters the callback that is called when the proxy address is changed.
+ * @brief Unsets 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,
* @privlevel public
* @privilege %http://tizen.org/privilege/network.profile \n
* %http://tizen.org/privilege/network.get
- * @remarks This API needs both privileges.
+ * @remarks This function needs both privileges.
* @param[in] connection The connection handle
* @param[in] profile The profile handle
* @return @c 0 on success,
* @privlevel public
* @privilege %http://tizen.org/privilege/network.profile \n
* %http://tizen.org/privilege/network.get
- * @remarks This API needs both privileges.
+ * @remarks This function needs both privileges.
* @param[in] connection The connection handle
* @param[in] profile The profile handle
* @return @c 0 on success,
* @privlevel public
* @privilege %http://tizen.org/privilege/network.profile \n
* %http://tizen.org/privilege/network.get
- * @remarks This API needs both privileges.
+ * @remarks This function 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
* @privlevel public
* @privilege %http://tizen.org/privilege/network.profile \n
* %http://tizen.org/privilege/network.get
- * @remarks This API needs both privileges.
+ * @remarks This function 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
* @privlevel public
* @privilege %http://tizen.org/privilege/network.set \n
* %http://tizen.org/privilege/network.get
- * @remarks This API needs both privileges.
+ * @remarks This function needs both privileges.
* @param[in] connection The connection handle
* @param[in] profile The profile handle
* @param[in] callback The callback function to be called
* @privlevel public
* @privilege %http://tizen.org/privilege/network.profile \n
* %http://tizen.org/privilege/network.get
- * @remarks This API needs both privileges.
+ * @remarks This function 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
/**
+ * @deprecated Deprecated since 4.0. Use connection_add_route_entry() instead.
* @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.
* @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);
+int connection_remove_route(connection_h connection, const char* interface_name,
+ const char* host_address) TIZEN_DEPRECATED_API;
/**
* @privilege %http://tizen.org/privilege/network.get
* @param[in] connection The connection handle
* @param[in] connection_type The type of connection \n
- * Only CONNECTION_TYPE_WIFI and CONNECTION_TYPE_CELLULAR are supported
+ * 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,
* @privilege %http://tizen.org/privilege/network.set
* @param[in] connection The connection handle
* @param[in] connection_type The type of connection \n
- * Only CONNECTION_TYPE_WIFI and CONNECTION_TYPE_CELLULAR are supported
+ * 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
#endif /* __cplusplus */
-#endif
+#endif /* __TIZEN_NETWORK_NET_CONNECTION_H__ */