Modified header files by tizen policy

[platform/core/api/connection.git] / include / connection_profile.h

diff --git a/include/connection_profile.h b/include/connection_profile.h
index 50b3ffd..5e464b1 100755 (executable)
--- a/include/connection_profile.h
+++ b/include/connection_profile.h
@@ -93,15 +93,15 @@ typedef enum {
 /**
  * @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;
 
 
@@ -172,7 +172,7 @@ typedef enum {
        CONNECTION_IP_CONFIG_TYPE_STATIC  = 1,
 
        /**
-        * Config IP using DHCP client
+        * Config IP using DHCP client (IPv4 Only)
         */
        CONNECTION_IP_CONFIG_TYPE_DYNAMIC = 2,
 
@@ -182,7 +182,7 @@ typedef enum {
        CONNECTION_IP_CONFIG_TYPE_AUTO = 3,
 
        /**
-        * Indicates an IP address that can not be modified
+        * Indicates an IP address that can not be modified (IPv4 Only)
         */
        CONNECTION_IP_CONFIG_TYPE_FIXED = 4,
 
@@ -293,7 +293,7 @@ int connection_profile_clone(connection_profile_h *cloned_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()
+ *          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
@@ -377,7 +377,7 @@ int connection_profile_refresh(connection_profile_h profile);
 
 
 /**
- * @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
@@ -430,6 +430,7 @@ int connection_profile_get_ip_address(connection_profile_h profile,
  * @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().
+ *          This function is supported only for IPv4 address family.
  * @param[in] profile           The profile handle
  * @param[in] address_family    The address family
  * @param[out] subnet_mask      The subnet mask
@@ -482,6 +483,22 @@ int connection_profile_get_dhcp_server_address(connection_profile_h profile,
                connection_address_family_e address_family, char **dhcp_server);
 
 /**
+ * @brief Gets the DHCP lease duration.
+ * @since_tizen 4.0
+ * @param[in] profile                   The profile handle
+ * @param[in] address_family            The address family
+ * @param[out] dhcp_lease_duration      The DHCP lease duration in seconds
+ * @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_NOT_SUPPORTED                  Not supported
+*/
+int connection_profile_get_dhcp_lease_duration(connection_profile_h profile,
+               connection_address_family_e address_family, int *dhcp_lease_duration);
+
+/**
  * @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().
@@ -578,6 +595,7 @@ int connection_profile_set_ip_address(connection_profile_h profile,
  * @brief Sets the Subnet Mask.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  * @remarks You must release @a subnet_mask using free().
+ *          This function is supported only for IPv4 address family.
  * @param[in] profile           The profile handle
  * @param[in] address_family    The address family
  * @param[in] subnet_mask       The subnet mask \n
@@ -688,7 +706,7 @@ typedef void(*connection_profile_state_changed_cb)(connection_profile_state_e st
 
 
 /**
- * @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
@@ -707,7 +725,7 @@ int connection_profile_set_state_changed_cb(connection_profile_h profile,
 
 
 /**
- * @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,
@@ -884,7 +902,7 @@ int connection_profile_get_wifi_max_speed(connection_profile_h profile, int *max
 
 
 /**
- * @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
@@ -900,7 +918,7 @@ int connection_profile_get_wifi_security_type(connection_profile_h profile,
 
 
 /**
- * @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
@@ -1056,7 +1074,7 @@ int connection_profile_get_cellular_home_url(connection_profile_h profile,
  * @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 suppported
+ * @retval #CONNECTION_ERROR_NOT_SUPPORTED      Not supported
 */
 int connection_profile_get_cellular_pdn_type(connection_profile_h profile,
                connection_cellular_pdn_type_e *type);
@@ -1161,7 +1179,7 @@ int connection_profile_set_cellular_service_type(connection_profile_h profile,
 /**
  * @brief Sets the APN (Access Point Name).
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @remarks You must release @a spn using free().
+ * @remarks You must release @a apn using free().
  * @param[in] profile         The profile handle
  * @param[in] apn             The name of APN
  * @return @c 0 on success,