*/
/**
- * @brief The softap handle.
- * @since_tizen 3.0
+ * @brief The SoftAP handle.
+ * @since_tizen 5.0
*/
typedef void * softap_h;
-#ifndef TIZEN_ERROR_SOFTAP
-#define TIZEN_ERROR_SOFTAP -0x03200000
-#endif
-
/**
- * @brief Enumeration for the softap.
- * @since_tizen 3.0
+ * @brief Enumeration for the SoftAP.
+ * @since_tizen 5.0
*/
typedef enum {
- SOFTAP_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */
- SOFTAP_ERROR_NOT_PERMITTED = TIZEN_ERROR_NOT_PERMITTED, /**< Operation not permitted */
- SOFTAP_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER, /**< Invalid parameter */
- SOFTAP_ERROR_OUT_OF_MEMORY = TIZEN_ERROR_OUT_OF_MEMORY, /**< Out of memory */
- SOFTAP_ERROR_RESOURCE_BUSY = TIZEN_ERROR_RESOURCE_BUSY, /**< Resource busy */
- SOFTAP_ERROR_OPERATION_FAILED = TIZEN_ERROR_SOFTAP | 0x0501, /**< Operation failed */
+ SOFTAP_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */
+ SOFTAP_ERROR_NOT_PERMITTED = TIZEN_ERROR_NOT_PERMITTED, /**< Operation not permitted */
+ SOFTAP_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER, /**< Invalid parameter */
+ SOFTAP_ERROR_OUT_OF_MEMORY = TIZEN_ERROR_OUT_OF_MEMORY, /**< Out of memory */
+ SOFTAP_ERROR_RESOURCE_BUSY = TIZEN_ERROR_RESOURCE_BUSY, /**< Resource busy */
+ SOFTAP_ERROR_OPERATION_FAILED = TIZEN_ERROR_SOFTAP | 0x01, /**< Operation failed */
+ SOFTAP_ERROR_ALREADY_ENABLED = TIZEN_ERROR_SOFTAP | 0x02, /**< Already enabled */
SOFTAP_ERROR_INVALID_OPERATION = TIZEN_ERROR_INVALID_OPERATION, /**< Invalid operation */
- SOFTAP_ERROR_NOT_SUPPORTED = TIZEN_ERROR_NOT_SUPPORTED, /**< API is not supported */
- SOFTAP_ERROR_PERMISSION_DENIED = TIZEN_ERROR_PERMISSION_DENIED, /**< Permission denied */
+ SOFTAP_ERROR_NOT_SUPPORTED = TIZEN_ERROR_NOT_SUPPORTED, /**< API is not supported */
+ SOFTAP_ERROR_PERMISSION_DENIED = TIZEN_ERROR_PERMISSION_DENIED, /**< Permission denied */
} softap_error_e;
/**
- * @brief Enumeration for the cause of disabling the softap.
- * @since_tizen 3.0
+ * @brief Enumeration for the cause of disabling the SoftAP.
+ * @since_tizen 5.0
*/
typedef enum {
SOFTAP_DISABLED_BY_FLIGHT_MODE = 0, /**< Disabled due to flight mode */
/**
* @brief Enumeration for the Wi-Fi security.
- * @since_tizen 3.0
+ * @since_tizen 5.0
*/
typedef enum {
SOFTAP_SECURITY_TYPE_NONE = 0, /**< No Security type */
/**
* @brief Enumeration for the SoftAP HW mode.
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef enum {
SOFTAP_WIRELESS_MODE_B = 0, /**< 802.11b */
*/
/**
- * @brief The softap client handle.
- * @since_tizen 3.0
+ * @brief The SoftAP client handle.
+ * @since_tizen 5.0
*/
typedef void * softap_client_h;
/**
* @brief Enumeration for address family.
- * @since_tizen 3.0
+ * @since_tizen 5.0
*/
typedef enum {
- SOFTAP_ADDRESS_FAMILY_IPV4 = 0, /**< IPV4 Address type */
+ SOFTAP_ADDRESS_FAMILY_IPV4 = 0, /**< IPv4 Address type */
+ SOFTAP_ADDRESS_FAMILY_IPV6, /**< IPv6 Address type */
} softap_address_family_e;
/**
*/
/**
- * @brief Called when the softap is enabled.
- * @since_tizen 3.0
- * @param[in] result The result of enabling the softap
+ * @brief Called when the SoftAP is enabled.
+ * @details The following error codes can be received: \n
+ * #SOFTAP_ERROR_NONE: Success \n
+ * #SOFTAP_ERROR_NOT_PERMITTED: Operation not permitted \n
+ * #SOFTAP_ERROR_INVALID_PARAMETER: Invalid parameter \n
+ * #SOFTAP_ERROR_OUT_OF_MEMORY: Out of memory \n
+ * #SOFTAP_ERROR_OPERATION_FAILED: Operation failed \n
+ * #SOFTAP_ERROR_ALREADY_ENABLED: Already enabled \n
+ * @since_tizen 5.0
+ * @param[in] result The result of enabling the SoftAP
* @param[in] is_requested Indicates whether this change is requested
* @param[in] user_data The user data passed from softap_set_enabled_cb()
- * @pre If you register callback function using softap_set_enabled_cb(), this will be invoked when the softap is enabled.
- * @see softap_enable()
- * @see softap_unset_enabled_cb()
+ * @pre If you register callback function using softap_set_enabled_cb(), this will be invoked when the SoftAP is enabled.
+ * @see softap_enable()
+ * @see softap_unset_enabled_cb()
*/
typedef void (*softap_enabled_cb)(softap_error_e result, bool is_requested, void *user_data);
/**
- * @brief Called when the softap is disabled.
- * @since_tizen 3.0
- * @param[in] result The result of disabling the softap
+ * @brief Called when the SoftAP is disabled.
+ * @details The following error codes can be received: \n
+ * #SOFTAP_ERROR_NONE: Success \n
+ * #SOFTAP_ERROR_INVALID_PARAMETER: Invalid parameter \n
+ * #SOFTAP_ERROR_OUT_OF_MEMORY: Out of memory \n
+ * #SOFTAP_ERROR_OPERATION_FAILED: Operation failed \n
+ * @since_tizen 5.0
+ * @param[in] result The result of disabling the SoftAP
* @param[in] cause The cause of disabling
* @param[in] user_data The user data passed from softap_set_disabled_cb()
- * @pre If you register callback function using softap_set_disabled_cb(), this will be invoked when the softap is disabled.
- * @see softap_set_disabled_cb()
- * @see softap_unset_disabled_cb()
+ * @pre If you register callback function using softap_set_disabled_cb(), this will be invoked when the SoftAP is disabled.
+ * @see softap_set_disabled_cb()
+ * @see softap_unset_disabled_cb()
*/
typedef void (*softap_disabled_cb)(softap_error_e result, softap_disabled_cause_e cause, void *user_data);
/**
* @brief Called when the connection state is changed.
- * @since_tizen 3.0
- * @remarks @a client is valid only in this function. In order to use it outside this function, a user must copy the client with softap_client_clone().
+ * @since_tizen 5.0
+ * @remarks The @a client should not be released by the application and it is valid only in this function.\n
+ * In order to use it outside this function, a user must copy the client with softap_client_clone().
* @param[in] client The client of which connection state is changed
* @param[in] opened @c true when connection is opened, otherwise false
* @param[in] user_data The user data passed from softap_set_client_connection_state_changed_cb()
* @pre If you register callback function using softap_set_client_connection_state_changed_cb(), this will be invoked when the connection state is changed.
- * @see softap_set_client_connection_state_changed_cb()
- * @see softap_unset_client_connection_state_changed_cb()
+ * @see softap_set_client_connection_state_changed_cb()
+ * @see softap_unset_client_connection_state_changed_cb()
*/
typedef void (*softap_client_connection_state_changed_cb)(softap_client_h client, bool opened, void *user_data);
/**
* @brief Called when you get the connected client repeatedly.
- * @since_tizen 3.0
- * @remarks @a client is valid only in this function. In order to use the client outside this function, a user must copy the client with softap_client_clone().
+ * @since_tizen 5.0
+ * @remarks The @a client should not be released by the application and it is valid only in this function.\n
+ * In order to use the client outside this function, a user must copy the client with softap_client_clone().
* @param[in] client The connected client
* @param[in] user_data The user data passed from the request function
* @return @c true to continue with the next iteration of the loop, \n @c false to break out of the loop
typedef bool(*softap_connected_client_cb)(softap_client_h client, void *user_data);
/**
- * @brief Called when the security type of Soft AP is changed.
- * @since_tizen 3.0
+ * @brief Called when the security type of SoftAP is changed.
+ * @since_tizen 5.0
* @param[in] changed_type The changed security type
* @param[in] user_data The user data passed from the register function
- * @see softap_set_security_type_changed_cb()
- * @see softap_unset_security_type_changed_cb()
+ * @see softap_set_security_type_changed_cb()
+ * @see softap_unset_security_type_changed_cb()
*/
typedef void (*softap_security_type_changed_cb)(softap_security_type_e changed_type, void *user_data);
/**
* @brief Called when the visibility of SSID is changed.
- * @since_tizen 3.0
+ * @since_tizen 5.0
* @param[in] changed_visible The changed visibility of SSID
* @param[in] user_data The user data passed from the register function
- * @see softap_set_ssid_visibility_changed_cb()
- * @see softap_unset_ssid_visibility_changed_cb()
+ * @see softap_set_ssid_visibility_changed_cb()
+ * @see softap_unset_ssid_visibility_changed_cb()
*/
typedef void (*softap_ssid_visibility_changed_cb)(bool changed_visible, void *user_data);
/**
- * @brief Called when the passphrase
- * @since_tizen 3.0
+ * @brief Called when the passphrase.
+ * @since_tizen 5.0
* @param[in] user_data The user data passed from the register function
- * @see softap_set_passphrase_changed_cb()
- * @see softap_unset_passphrase_changed_cb()
+ * @see softap_set_passphrase_changed_cb()
+ * @see softap_unset_passphrase_changed_cb()
*/
typedef void (*softap_passphrase_changed_cb)(void *user_data);
/**
- * @brief Called when Soft AP settings are reloaded.
- * @since_tizen 3.0
+ * @brief Called when SoftAP settings are reloaded.
+ * @details The following error codes can be received: \n
+ * #SOFTAP_ERROR_NONE: Success \n
+ * #SOFTAP_ERROR_NOT_PERMITTED: Operation not permitted \n
+ * #SOFTAP_ERROR_INVALID_PARAMETER: Invalid parameter \n
+ * #SOFTAP_ERROR_OUT_OF_MEMORY: Out of memory \n
+ * #SOFTAP_ERROR_OPERATION_FAILED: Operation failed \n
+ * @since_tizen 5.0
* @param[in] result The result of reloading the settings
* @param[in] user_data The user data passed from the request function
* @pre softap_reload_settings() will invoke this callback.
typedef void (*softap_settings_reloaded_cb)(softap_error_e result, void *user_data);
/**
- * @brief Creates the handle for softap.
- * @since_tizen 3.0
- * @remarks The @a softap must be released using softap_destroy().
+ * @brief Creates the handle for SoftAP.
+ * @since_tizen 5.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/softap
+ * @remarks The @a softap should be released using softap_destroy().
* @param[out] softap A handle of a new mobile ap handle on success
* @return 0 on success, otherwise a negative error value
- * @retval #SOFTAP_ERROR_NONE Successful
- * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #SOFTAP_ERROR_NONE Successful
+ * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SOFTAP_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
- * @retval #SOFTAP_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_PERMISSION_DENIED Permission denied
* @see softap_destroy()
*/
int softap_create(softap_h *softap);
/**
- * @brief Destroys the handle for softap.
- * @since_tizen 3.0
- * @param[in] softap The softap handle
+ * @brief Destroys the handle for SoftAP.
+ * @since_tizen 5.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/softap
+ * @param[in] softap The SoftAP handle
* @return 0 on success, otherwise a negative error value
- * @retval #SOFTAP_ERROR_NONE Successful
- * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_NONE Successful
+ * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_PERMISSION_DENIED Permission denied
* @see softap_create()
*/
int softap_destroy(softap_h softap);
/**
- * @brief Enables the softap, asynchronously.
- * @since_tizen 3.0
- * @param[in] softap The softap handle
+ * @brief Enables the SoftAP, asynchronously.
+ * @since_tizen 5.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/softap.admin
+ * @param[in] softap The SoftAP handle
* @return 0 on success, otherwise negative error value
- * @retval #SOFTAP_ERROR_NONE Successful
+ * @retval #SOFTAP_ERROR_NONE Successful
* @retval #SOFTAP_ERROR_NOT_PERMITTED Operation not permitted
- * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SOFTAP_ERROR_INVALID_OPERATION Invalid operation
* @retval #SOFTAP_ERROR_RESOURCE_BUSY Device or resource busy
- * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_PERMISSION_DENIED Permission denied
* @post softap_enabled_cb() will be invoked.
* @see softap_is_enabled()
* @see softap_disable()
*/
int softap_enable(softap_h softap);
/**
- * @brief Disables the softap, asynchronously.
- * @since_tizen 3.0
- * @param[in] softap The softap handle
+ * @brief Disables the SoftAP, asynchronously.
+ * @since_tizen 5.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/softap.admin
+ * @param[in] softap The SoftAP handle
* @return 0 on success, otherwise negative error value
- * @retval #SOFTAP_ERROR_NONE Successful
- * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #SOFTAP_ERROR_NONE Successful
+ * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SOFTAP_ERROR_INVALID_OPERATION Invalid operation
- * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_PERMISSION_DENIED Permission denied
* @post softap_disabled_cb() will be invoked.
* @see softap_is_enabled()
* @see softap_enable()
int softap_disable(softap_h softap);
/**
- * @brief Checks whether the softap is enabled or not.
- * @since_tizen 3.0
- * @param[in] softap The softap handle
- * @param[out] enable @c true if softap is enabled, \n @c false if softap is disabled
+ * @brief Checks whether the SoftAP is enabled or not.
+ * @since_tizen 5.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/softap
+ * @param[in] softap The SoftAP handle
+ * @param[out] enable @c true if SoftAP is enabled, \n @c false if SoftAP is disabled
* @return 0 on success, otherwise negative error value
- * @retval #SOFTAP_ERROR_NONE Successful
- * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_NONE Successful
+ * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #SOFTAP_ERROR_OPERATION_FAILED Operation failed
+ * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_PERMISSION_DENIED Permission denied
*/
int softap_is_enabled(softap_h softap, bool *enable);
/**
* @brief Gets the MAC address of local device as "FC:A1:3E:D6:B1:B1".
- * @since_tizen 3.0
- * @remarks @a mac_address must be released using free().
- * @param[in] softap The softap handle
+ * @since_tizen 5.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/softap
+ * @remarks The @a mac_address should be released using free().
+ * @param[in] softap The SoftAP handle
* @param[out] mac_address The MAC address
* @return 0 on success, otherwise a negative error value
- * @retval #SOFTAP_ERROR_NONE Successful
- * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #SOFTAP_ERROR_OUT_OF_MEMORY Out of memory
+ * @retval #SOFTAP_ERROR_NONE Successful
+ * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #SOFTAP_ERROR_OUT_OF_MEMORY Out of memory
* @retval #SOFTAP_ERROR_OPERATION_FAILED Operation failed
- * @retval #SOFTAP_ERROR_INVALID_OPERATION Invalid operation
- * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
- * @pre The softap must be enabled.
+ * @retval #SOFTAP_ERROR_INVALID_OPERATION Invalid operation
+ * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_PERMISSION_DENIED Permission denied
+ * @pre The SoftAP must be enabled.
* @see softap_is_enabled()
* @see softap_enable()
*/
/**
* @brief Gets the name of network interface (e.g. wlan0).
- * @since_tizen 3.0
- * @remarks @a interface_name must be released using free().
- * @param[in] softap The softap handle
+ * @since_tizen 5.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/softap
+ * @remarks The @a interface_name should be released using free().
+ * @param[in] softap The SoftAP handle
* @param[out] interface_name The name of the network interface
* @return 0 on success, otherwise negative error value
- * @retval #SOFTAP_ERROR_NONE Successful
- * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #SOFTAP_ERROR_NONE Successful
+ * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SOFTAP_ERROR_OUT_OF_MEMORY Out of memory
* @retval #SOFTAP_ERROR_OPERATION_FAILED Operation failed
* @retval #SOFTAP_ERROR_INVALID_OPERATION Invalid operation
- * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
- * @pre The softap must be enabled.
+ * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_PERMISSION_DENIED Permission denied
+ * @pre The SoftAP must be enabled.
* @see softap_is_enabled()
* @see softap_enable()
*/
/**
* @brief Sets the local IP address.
- * @since_tizen 4.0
- * @remarks This change is applied next time softap is enabled.
- * You can use softap_enable() or softap_reload_settings() to enable softap.
- * @param[in] softap The softap handle
- * @param[in] address_family The address family of IP address (currently, #SOFTAP_ADDRESS_FAMILY_IPV4 is only supported)
+ * @since_tizen 5.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/softap
+ * @remarks This change is applied next time SoftAP is enabled.
+ * You can use softap_enable() or softap_reload_settings() to enable SoftAP.
+ * @param[in] softap The SoftAP handle
+ * @param[in] address_family The address family of IP address (currently only #SOFTAP_ADDRESS_FAMILY_IPV4 is supported)
* @param[in] ip_address The local IP address
* @return 0 on success, otherwise negative error value
- * @retval #SOFTAP_ERROR_NONE Successful
- * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_NONE Successful
+ * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_PERMISSION_DENIED Permission denied
*/
int softap_set_ip_address(softap_h softap, softap_address_family_e address_family, const char *ip_address);
/**
* @brief Gets the local IP address.
- * @since_tizen 3.0
- * @remarks @a ip_address must be released using free().
- * @param[in] softap The softap handle
- * @param[in] address_family The address family of IP address (currently, #SOFTAP_ADDRESS_FAMILY_IPV4 is only supported)
+ * @since_tizen 5.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/softap
+ * @remarks The @a ip_address should be released using free().
+ * @param[in] softap The SoftAP handle
+ * @param[in] address_family The address family of IP address (currently only #SOFTAP_ADDRESS_FAMILY_IPV4 is supported)
* @param[out] ip_address The local IP address
* @return 0 on success, otherwise negative error value
- * @retval #SOFTAP_ERROR_NONE Successful
- * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #SOFTAP_ERROR_NONE Successful
+ * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SOFTAP_ERROR_OUT_OF_MEMORY Out of memory
* @retval #SOFTAP_ERROR_OPERATION_FAILED Operation failed
* @retval #SOFTAP_ERROR_INVALID_OPERATION Invalid operation
- * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
- * @pre The softap must be enabled.
+ * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_PERMISSION_DENIED Permission denied
+ * @pre The SoftAP must be enabled.
* @see softap_is_enabled()
* @see softap_enable()
*/
/**
* @brief Gets the Gateway address.
- * @since_tizen 3.0
- * @remarks @a gateway_address must be released using free().
- * @param[in] softap The softap handle
- * @param[in] address_family The address family of IP address (currently, #SOFTAP_ADDRESS_FAMILY_IPV4 is only supported)
+ * @since_tizen 5.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/softap
+ * @remarks The @a gateway_address should be released using free().
+ * @param[in] softap The SoftAP handle
+ * @param[in] address_family The address family of IP address (currently only #SOFTAP_ADDRESS_FAMILY_IPV4 is supported)
* @param[out] gateway_address Gateway address
* @return 0 on success, otherwise negative error value
- * @retval #SOFTAP_ERROR_NONE Successful
- * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #SOFTAP_ERROR_NONE Successful
+ * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SOFTAP_ERROR_OUT_OF_MEMORY Out of memory
* @retval #SOFTAP_ERROR_OPERATION_FAILED Operation failed
* @retval #SOFTAP_ERROR_INVALID_OPERATION Invalid operation
- * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
- * @pre The softap must be enabled.
+ * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_PERMISSION_DENIED Permission denied
+ * @pre The SoftAP must be enabled.
* @see softap_is_enabled()
* @see softap_enable()
*/
/**
* @brief Gets the Subnet Mask.
- * @since_tizen 3.0
- * @remarks @a subnet_mask must be released using free().
- * @param[in] softap The softap handle
- * @param[in] address_family The address family of IP address (currently, #SOFTAP_ADDRESS_FAMILY_IPV4 is only supported)
+ * @since_tizen 5.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/softap
+ * @remarks The @a subnet_mask should be released using free().
+ * @param[in] softap The SoftAP handle
+ * @param[in] address_family The address family of IP address (currently only #SOFTAP_ADDRESS_FAMILY_IPV4 is supported)
* @param[out] subnet_mask Subnet mask
* @return 0 on success, otherwise negative error value
- * @retval #SOFTAP_ERROR_NONE Successful
- * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #SOFTAP_ERROR_NONE Successful
+ * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SOFTAP_ERROR_OUT_OF_MEMORY Out of memory
* @retval #SOFTAP_ERROR_OPERATION_FAILED Operation failed
* @retval #SOFTAP_ERROR_INVALID_OPERATION Invalid operation
- * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
- * @pre The softap must be enabled.
+ * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_PERMISSION_DENIED Permission denied
+ * @pre The SoftAP must be enabled.
* @see softap_is_enabled()
* @see softap_enable()
*/
/**
* @brief Gets the clients which are connected.
- * @since_tizen 3.0
- * @param[in] softap The softap handle
+ * @since_tizen 5.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/softap
+ * @param[in] softap The SoftAP handle
* @param[in] callback The callback function to invoke
* @param[in] user_data The user data to be passed to the callback function
- * @retval #SOFTAP_ERROR_NONE Successful
- * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
+ * @return 0 on success, otherwise negative error value
+ * @retval #SOFTAP_ERROR_NONE Successful
+ * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SOFTAP_ERROR_INVALID_OPERATION Invalid operation
* @retval #SOFTAP_ERROR_OPERATION_FAILED Operation failed
- * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
- * @pre The softap must be enabled.
+ * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_PERMISSION_DENIED Permission denied
+ * @pre The SoftAP must be enabled.
* @see softap_is_enabled()
* @see softap_enable()
*/
int softap_foreach_connected_clients(softap_h softap, softap_connected_client_cb callback, void *user_data);
/**
- * @brief Registers the callback function, which is called when softap is enabled.
- * @since_tizen 3.0
- * @param[in] softap The softap handle
+ * @brief Sets the callback function, which is called when SoftAP is enabled.
+ * @since_tizen 5.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/softap
+ * @param[in] softap The SoftAP handle
* @param[in] callback The callback function to invoke
* @param[in] user_data The user data to be passed to the callback function
- * @retval #SOFTAP_ERROR_NONE Successful
- * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @return 0 on success, otherwise negative error value
+ * @retval #SOFTAP_ERROR_NONE Successful
+ * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_PERMISSION_DENIED Permission denied
* @see softap_unset_enabled_cb()
*/
int softap_set_enabled_cb(softap_h softap, softap_enabled_cb callback, void *user_data);
/**
- * @brief Unregisters the callback function, which is called when softap is enabled.
- * @since_tizen 3.0
- * @param[in] softap The softap handle
- * @retval #SOFTAP_ERROR_NONE Successful
- * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @brief Unsets the callback function, which is called when SoftAP is enabled.
+ * @since_tizen 5.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/softap
+ * @param[in] softap The SoftAP handle
+ * @return 0 on success, otherwise negative error value
+ * @retval #SOFTAP_ERROR_NONE Successful
+ * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_PERMISSION_DENIED Permission denied
* @see softap_set_enabled_cb()
*/
int softap_unset_enabled_cb(softap_h softap);
/**
- * @brief Registers the callback function called when softap is disabled.
- * @since_tizen 3.0
- * @param[in] softap The softap handle
+ * @brief Sets the callback function called when SoftAP is disabled.
+ * @since_tizen 5.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/softap
+ * @param[in] softap The SoftAP handle
* @param[in] callback The callback function to invoke
* @param[in] user_data The user data to be passed to the callback function
- * @retval #SOFTAP_ERROR_NONE Successful
- * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @return 0 on success, otherwise negative error value
+ * @retval #SOFTAP_ERROR_NONE Successful
+ * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_PERMISSION_DENIED Permission denied
* @see softap_unset_disabled_cb()
*/
int softap_set_disabled_cb(softap_h softap, softap_disabled_cb callback, void *user_data);
/**
- * @brief Unregisters the callback function, which is called when softap is disabled.
- * @since_tizen 3.0
- * @param[in] softap The softap handle
- * @retval #SOFTAP_ERROR_NONE Successful
- * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @brief Unsets the callback function, which is called when SoftAP is disabled.
+ * @since_tizen 5.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/softap
+ * @param[in] softap The SoftAP handle
+ * @return 0 on success, otherwise negative error value
+ * @retval #SOFTAP_ERROR_NONE Successful
+ * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_PERMISSION_DENIED Permission denied
* @see softap_set_disabled_cb()
*/
int softap_unset_disabled_cb(softap_h softap);
/**
- * @brief Registers the callback function, which is called when the state of connection is changed.
- * @since_tizen 3.0
- * @param[in] softap The softap handle
+ * @brief Sets the callback function, which is called when the state of connection is changed.
+ * @since_tizen 5.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/softap
+ * @param[in] softap The SoftAP handle
* @param[in] callback The callback function to invoke
* @param[in] user_data The user data to be passed to the callback function
- * @retval #SOFTAP_ERROR_NONE Successful
- * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @return 0 on success, otherwise negative error value
+ * @retval #SOFTAP_ERROR_NONE Successful
+ * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_PERMISSION_DENIED Permission denied
* @see softap_unset_client_connection_state_changed_cb()
*/
int softap_set_client_connection_state_changed_cb(softap_h softap, softap_client_connection_state_changed_cb callback, void *user_data);
/**
- * @brief Unregisters the callback function, which is called when the state of connection is changed.
- * @since_tizen 3.0
- * @param[in] softap The softap handle
- * @retval #SOFTAP_ERROR_NONE Successful
- * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @brief Unsets the callback function, which is called when the state of connection is changed.
+ * @since_tizen 5.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/softap
+ * @param[in] softap The SoftAP handle
+ * @return 0 on success, otherwise negative error value
+ * @retval #SOFTAP_ERROR_NONE Successful
+ * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_PERMISSION_DENIED Permission denied
* @see softap_set_client_connection_state_changed_cb()
*/
int softap_unset_client_connection_state_changed_cb(softap_h softap);
/**
- * @brief Registers the callback function, which is called when the security type of softap is changed.
- * @since_tizen 3.0
- * @param[in] softap The softap handle
+ * @brief Sets the callback function, which is called when the security type of SoftAP is changed.
+ * @since_tizen 5.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/softap
+ * @param[in] softap The SoftAP handle
* @param[in] callback The callback function to invoke
* @param[in] user_data The user data to be passed to the callback function
- * @retval #SOFTAP_ERROR_NONE Successful
- * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @return 0 on success, otherwise negative error value
+ * @retval #SOFTAP_ERROR_NONE Successful
+ * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_PERMISSION_DENIED Permission denied
* @see softap_unset_security_type_changed_cb()
*/
int softap_set_security_type_changed_cb(softap_h softap, softap_security_type_changed_cb callback, void *user_data);
/**
- * @brief Unregisters the callback function, which is called when the security type of softap is changed.
- * @since_tizen 3.0
- * @param[in] softap The softap handle
- * @param[in] type The softap type
- * @retval #SOFTAP_ERROR_NONE Successful
- * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @brief Unsets the callback function, which is called when the security type of SoftAP is changed.
+ * @since_tizen 5.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/softap
+ * @param[in] softap The SoftAP handle
+ * @return 0 on success, otherwise negative error value
+ * @retval #SOFTAP_ERROR_NONE Successful
+ * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_PERMISSION_DENIED Permission denied
* @see softap_set_security_type_changed_cb()
*/
int softap_unset_security_type_changed_cb(softap_h softap);
/**
- * @brief Registers the callback function , which iscalled when the visibility of SSID is changed.
- * @since_tizen 3.0
- * @param[in] softap The softap handle
+ * @brief Sets the callback function , which iscalled when the visibility of SSID is changed.
+ * @since_tizen 5.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/softap
+ * @param[in] softap The SoftAP handle
* @param[in] callback The callback function to invoke
* @param[in] user_data The user data to be passed to the callback function
- * @retval #SOFTAP_ERROR_NONE Successful
- * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @return 0 on success, otherwise negative error value
+ * @retval #SOFTAP_ERROR_NONE Successful
+ * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_PERMISSION_DENIED Permission denied
* @see softap_unset_ssid_visibility_changed_cb_cb()
*/
int softap_set_ssid_visibility_changed_cb(softap_h softap, softap_ssid_visibility_changed_cb callback, void *user_data);
/**
- * @brief Unregisters the callback function, which is called when the visibility of SSID is changed.
- * @since_tizen 3.0
- * @param[in] softap The softap handle
- * @retval #SOFTAP_ERROR_NONE Successful
- * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @brief Unsets the callback function, which is called when the visibility of SSID is changed.
+ * @since_tizen 5.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/softap
+ * @param[in] softap The SoftAP handle
+ * @return 0 on success, otherwise a negative error value
+ * @retval #SOFTAP_ERROR_NONE Successful
+ * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_PERMISSION_DENIED Permission denied
* @see softap_wifi_set_ssid_visibility_changed_cb()
*/
int softap_unset_ssid_visibility_changed_cb(softap_h softap);
/**
- * @brief Registers the callback function, which is called when the passphrase of softap is changed.
- * @since_tizen 3.0
- * @param[in] softap The softap handle
+ * @brief Sets the callback function, which is called when the passphrase of SoftAP is changed.
+ * @since_tizen 5.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/softap
+ * @param[in] softap The SoftAP handle
* @param[in] callback The callback function to invoke
* @param[in] user_data The user data to be passed to the callback function
- * @retval #SOFTAP_ERROR_NONE Successful
- * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @return 0 on success, otherwise negative error value
+ * @retval #SOFTAP_ERROR_NONE Successful
+ * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_PERMISSION_DENIED Permission denied
* @see softap_unset_passphrase_changed_cb()
*/
int softap_set_passphrase_changed_cb(softap_h softap, softap_passphrase_changed_cb callback, void *user_data);
/**
- * @brief Unregisters the callback function, which is called when the passphrase of softap is changed.
- * @since_tizen 3.0
- * @param[in] softap The softap handle
- * @retval #SOFTAP_ERROR_NONE Successful
- * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @brief Unsets the callback function, which is called when the passphrase of SoftAP is changed.
+ * @since_tizen 5.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/softap
+ * @param[in] softap The SoftAP handle
+ * @return 0 on success, otherwise a negative error value
+ * @retval #SOFTAP_ERROR_NONE Successful
+ * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_PERMISSION_DENIED Permission denied
* @see softap_set_passphrase_changed_cb()
*/
int softap_unset_passphrase_changed_cb(softap_h softap);
*/
/**
- * @brief Sets the security type of softap.
+ * @brief Sets the security type of SoftAP.
* @details If security type is not set, WPA2_PSK is used.
- * @since_tizen 3.0
- * @remarks This change is applied next time softap is enabled. \
- * You can use softap_enable() or softap_reload_settings() to enable softap.
- * @param[in] softap The softap handle
+ * @since_tizen 5.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/softap
+ * @remarks This change is applied next time SoftAP is enabled. \
+ * You can use softap_enable() or softap_reload_settings() to enable SoftAP.
+ * @param[in] softap The SoftAP handle
* @param[in] type The security type
* @return 0 on success, otherwise negative error value
- * @retval #SOFTAP_ERROR_NONE Successful
- * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #SOFTAP_ERROR_NONE Successful
+ * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SOFTAP_ERROR_OPERATION_FAILED Operation failed
- * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
- * @see softap_wifi_ap_get_security_type()
+ * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_PERMISSION_DENIED Permission denied
+ * @see softap_get_security_type()
*/
int softap_set_security_type(softap_h softap, softap_security_type_e type);
/**
- * @brief Gets the security type of Soft AP.
+ * @brief Gets the security type of SoftAP.
* @details If security type is not set, WPA2_PSK is used.
- * @since_tizen 3.0
- * @param[in] softap The softap handle
+ * @since_tizen 5.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/softap
+ * @param[in] softap The SoftAP handle
* @param[out] type The security type
* @return 0 on success, otherwise negative error value
- * @retval #SOFTAP_ERROR_NONE Successful
- * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
- * @see softap_wifi_ap_set_security_type()
+ * @retval #SOFTAP_ERROR_NONE Successful
+ * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_PERMISSION_DENIED Permission denied
+ * @see softap_set_security_type()
*/
int softap_get_security_type(softap_h softap, softap_security_type_e *type);
/**
- * @brief Sets the SSID (service set identifier) for Soft AP.
+ * @brief Sets the SSID (service set identifier) for SoftAP.
* @details The SSID cannot exceed 32 bytes. If SSID is not set, device name is used as SSID.
- * @since_tizen 3.0
- * @remarks This change is applied next time softap is enabled. \
- * You can use softap_enable() or softap_reload_settings() to enable softap.
- * @param[in] softap The softap handle
+ * @since_tizen 5.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/softap
+ * @remarks This change is applied next time SoftAP is enabled. \
+ * You can use softap_enable() or softap_reload_settings() to enable SoftAP.
+ * @param[in] softap The SoftAP handle
* @param[in] ssid The SSID
* @return 0 on success, otherwise negative error value
- * @retval #SOFTAP_ERROR_NONE Successful
- * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #SOFTAP_ERROR_NONE Successful
+ * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SOFTAP_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_PERMISSION_DENIED Permission denied
+ * @see softap_get_ssid()
*/
int softap_set_ssid(softap_h softap, const char *ssid);
/**
- * @brief Gets the SSID (service set identifier) for Soft AP.
+ * @brief Gets the SSID (service set identifier) for SoftAP.
* @details If SSID is not set, Device name is used as SSID.
- * @since_tizen 3.0
- * @remarks @a ssid must be released using free().
- * @param[in] softap The softap handle
+ * @since_tizen 5.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/softap
+ * @remarks The @a ssid should be released using free().
+ * @param[in] softap The SoftAP handle
* @param[out] ssid The SSID
* @return 0 on success, otherwise negative error value
- * @retval #SOFTAP_ERROR_NONE Successful
- * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #SOFTAP_ERROR_NONE Successful
+ * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SOFTAP_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_PERMISSION_DENIED Permission denied
+ * @see softap_set_ssid()
*/
int softap_get_ssid(softap_h softap, char **ssid);
/**
- * @brief Sets the visibility of SSID (service set identifier) for Soft AP.
+ * @brief Sets the visibility of SSID (service set identifier) for SoftAP.
* @details If you set the visibility to invisible, then the SSID of this device is hidden and Wi-Fi scan won't find your device.
* @details By default visibility is set to @c true.
- * @since_tizen 3.0
- * @remarks This change is applied next time softap is enabled. \
- * You can use softap_enable() or softap_reload_settings() to enable softap.
- * @param[in] softap The softap handle
+ * @since_tizen 5.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/softap
+ * @remarks This change is applied next time SoftAP is enabled. \
+ * You can use softap_enable() or softap_reload_settings() to enable SoftAP.
+ * @param[in] softap The SoftAP handle
* @param[in] visible The visibility of SSID: (@c true = visible, @c false = invisible)
* @return 0 on success, otherwise negative error value
- * @retval #SOFTAP_ERROR_NONE Successful
- * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #SOFTAP_ERROR_NONE Successful
+ * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SOFTAP_ERROR_OPERATION_FAILED Operation failed
- * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_PERMISSION_DENIED Permission denied
* @see softap_get_ssid_visibility()
*/
int softap_set_ssid_visibility(softap_h softap, bool visible);
/**
- * @brief Gets the visibility of SSID (service set identifier) for Soft AP.
+ * @brief Gets the visibility of SSID (service set identifier) for SoftAP.
* @details If the visibility is set to invisible, then the SSID of this device is hidden and Wi-Fi scan won't find your device.
- * @details By default visibility is set to @c true.
- * @since_tizen 3.0
- * @param[in] softap The softap handle
+ * @since_tizen 5.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/softap
+ * @param[in] softap The SoftAP handle
* @param[out] visible The visibility of SSID: (@c true = visible, @c false = invisible)
* @return 0 on success, otherwise negative error value
- * @retval #SOFTAP_ERROR_NONE Successful
- * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_NONE Successful
+ * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_PERMISSION_DENIED Permission denied
* @see softap_set_ssid_visibility()
*/
int softap_get_ssid_visibility(softap_h softap, bool *visible);
/**
- * @brief Sets the passphrase for Soft AP.
+ * @brief Sets the passphrase for SoftAP.
* @details If the passphrase is not set, random string of 8 characters will be used.
- * @since_tizen 3.0
- * @remarks This change is applied next time softap is enabled. \
- * You can use softap_enable() or softap_reload_settings() to enable softap.
- * @param[in] softap The softap handle
+ * @since_tizen 5.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/softap
+ * @remarks This change is applied next time SoftAP is enabled. \
+ * You can use softap_enable() or softap_reload_settings() to enable SoftAP.
+ * @param[in] softap The SoftAP handle
* @param[in] passphrase The passphrase
* @return 0 on success, otherwise negative error value
- * @retval #SOFTAP_ERROR_NONE Successful
- * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_NONE Successful
+ * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_PERMISSION_DENIED Permission denied
* @see softap_get_passphrase()
*/
int softap_set_passphrase(softap_h softap, const char *passphrase);
/**
- * @brief Gets the passphrase for Soft AP.
+ * @brief Gets the passphrase for SoftAP.
* @details If the passphrase is not set, random string of 8 characters will be used.
- * @since_tizen 3.0
- * @remarks @a passphrase must be released using free().
- * @param[in] softap The softap handle
+ * @since_tizen 5.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/softap
+ * @remarks The @a passphrase should be released using free().
+ * @param[in] softap The SoftAP handle
* @param[out] passphrase The passphrase
* @return 0 on success, otherwise negative error value
- * @retval #SOFTAP_ERROR_NONE Successful
- * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #SOFTAP_ERROR_NONE Successful
+ * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SOFTAP_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_PERMISSION_DENIED Permission denied
* @see softap_set_passphrase()
*/
int softap_get_passphrase(softap_h softap, char **passphrase);
/**
- * @brief Reloads the settings (SSID / Passphrase / Security type / SSID visibility) for Soft AP.
- * @since_tizen 3.0
+ * @brief Reloads the settings (SSID / Passphrase / Security type / SSID visibility) for SoftAP.
+ * @since_tizen 5.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/softap.admin
* @remarks Devices connected via MobileAP will be disconnected when the settings are reloaded.
- * @param[in] softap The softap handle
+ * @param[in] softap The SoftAP handle
* @param[in] callback The callback function to invoke
* @param[in] user_data The user data to be passed to the callback function
* @return 0 on success, otherwise negative error value
- * @retval #SOFTAP_ERROR_NONE Successful
- * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #SOFTAP_ERROR_NONE Successful
+ * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SOFTAP_ERROR_OPERATION_FAILED Operation failed
- * @retval #SOFTAP_ERROR_RESOURCE_BUSY Device or resource busy
- * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_RESOURCE_BUSY Device or resource busy
+ * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_PERMISSION_DENIED Permission denied
*/
int softap_reload_settings(softap_h softap, softap_settings_reloaded_cb callback, void *user_data);
/**
- * @brief Pushes the WPS button to connect with Soft AP client. (WPS PBC)
- * @since_tizen 3.0
- * @remarks The WPS button should be pushed when client tries to connect with Soft AP by using WPS PBC.
- * @param[in] softap The softap handle
+ * @brief Pushes the WPS button to connect with SoftAP client(WPS PBC).
+ * @since_tizen 5.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/softap
+ * @remarks The WPS button should be pushed when client tries to connect with SoftAP by using WPS PBC.
+ * @param[in] softap The SoftAP handle
* @return 0 on success, otherwise negative error value
- * @retval #SOFTAP_ERROR_NONE Successful
- * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #SOFTAP_ERROR_NONE Successful
+ * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SOFTAP_ERROR_OPERATION_FAILED Operation failed
- * @retval #SOFTAP_ERROR_PERMISSION_DENIED Permission denied
- * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_PERMISSION_DENIED Permission denied
*/
int softap_push_wps_button(softap_h softap);
/**
- * @brief Sets the WPS PIN to connect with Soft AP client. (WPS PIN)
- * @since_tizen 3.0
- * @remarks The WPS PIN should be inserted when client tries to connect with Soft AP by using WPS PIN.
- * @param[in] softap The softap handle
+ * @brief Sets the WPS PIN to connect with SoftAP client(WPS PIN).
+ * @since_tizen 5.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/softap
+ * @remarks The WPS PIN should be inserted when client tries to connect with SoftAP by using WPS PIN.
+ * @param[in] softap The SoftAP handle
* @param[in] wps_pin The WPS PIN
* @return 0 on success, otherwise negative error value
- * @retval #SOFTAP_ERROR_NONE Successful
- * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #SOFTAP_ERROR_NONE Successful
+ * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SOFTAP_ERROR_OPERATION_FAILED Operation failed
- * @retval #SOFTAP_ERROR_PERMISSION_DENIED Permission denied
- * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_PERMISSION_DENIED Permission denied
*/
int softap_set_wps_pin(softap_h softap, const char *wps_pin);
/**
* @brief Sets vendor specific elements for Beacon and Probe Response frames.
- * @since_tizen 4.0
+ * @since_tizen 5.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/softap
* @remarks The format for vendor parameter should be a hexadumpt of the raw information elements.
- * @param[in] softap The softap handle
+ * This change is applied next time SoftAP is enabled.
+ * You can use softap_enable() or softap_reload_settings() to enable SoftAP.
+ * @param[in] softap The SoftAP handle
* @param[in] vendor_element The vendor specific elements
* @return 0 on success, otherwise negative error value
- * @retval #SOFTAP_ERROR_NONE Successful
- * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #SOFTAP_ERROR_PERMISSION_DENIED Permission denied
- * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_NONE Successful
+ * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_PERMISSION_DENIED Permission denied
+ * @see softap_get_vendor_element()
*/
int softap_set_vendor_element(softap_h softap, const char *vendor_element);
/**
* @brief Gets vendor specific elements for Beacon and Probe Response frames.
- * @since_tizen 4.0
+ * @since_tizen 5.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/softap
* @remarks The format for vendor parameter should be a hexadumpt of the raw information elements.
- * @param[in] softap The softap handle
+ * @remarks The @a vendor_element should be released using free().
+ * @param[in] softap The SoftAP handle
* @param[out] vendor_element The vendor specific elements
* @return 0 on success, otherwise negative error value
- * @retval #SOFTAP_ERROR_NONE Successful
- * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #SOFTAP_ERROR_PERMISSION_DENIED Permission denied
- * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_NONE Successful
+ * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_PERMISSION_DENIED Permission denied
+ * @see softap_set_vendor_element()
*/
int softap_get_vendor_element(softap_h softap, char **vendor_element);
/**
- * @brief Sets the channel for Soft AP.
+ * @brief Sets the channel for SoftAP.
* @details If channel is not set, Wi-Fi sets default channel.
- * @since_tizen 4.0
- * @param[in] softap The softap handle
+ * @since_tizen 5.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/softap
+ * @remarks This change is applied next time SoftAP is enabled.
+ * You can use softap_enable() or softap_reload_settings() to enable SoftAP.
+ * @param[in] softap The SoftAP handle
* @param[in] channel The channel number
* @return 0 on success, otherwise negative error value
- * @retval #SOFTAP_ERROR_NONE Successful
- * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_NONE Successful
+ * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_PERMISSION_DENIED Permission denied
+ * @see softap_get_channel()
*/
int softap_set_channel(softap_h softap, int channel);
/**
- * @brief Gets the channel for Soft AP.
- * @since_tizen 4.0
- * @param[in] softap The softap handle
+ * @brief Gets the channel for SoftAP.
+ * @since_tizen 5.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/softap
+ * @param[in] softap The SoftAP handle
* @param[out] channel The channel number
* @return 0 on success, otherwise negative error value
- * @retval #SOFTAP_ERROR_NONE Successful
- * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_NONE Successful
+ * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_PERMISSION_DENIED Permission denied
* @see softap_set_channel()
*/
int softap_get_channel(softap_h softap, int *channel);
/**
- * @brief Enables the dhcp server.
- * @since_tizen 4.0
- * @details Enable/disable the dhcp server.
- * @param[in] softap The softap handle
+ * @brief Enables the DHCP server.
+ * @details Enable/disable the DHCP server.
+ * @since_tizen 5.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/softap
+ * @param[in] softap The SoftAP handle
* @return 0 on success, otherwise negative error value.
- * @retval #SOFTAPERROR_NONE Successful
- * @retval #SOFTAPERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #SOFTAP_ERROR_NONE Successful
+ * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_PERMISSION_DENIED Permission denied
+ * @see softap_disable_dhcp()
*/
int softap_enable_dhcp(softap_h softap);
/**
- * @brief Disables the dhcp server.
- * @since_tizen 4.0
- * @details Enable/disable the dhcp server.
- * @param[in] softap The softap handle
+ * @brief Disables the DHCP server.
+ * @details Enable/disable the DHCP server.
+ * @since_tizen 5.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/softap
+ * @param[in] softap The SoftAP handle
* @return 0 on success, otherwise negative error value.
- * @retval #SOFTAPERROR_NONE Successful
- * @retval #SOFTAPERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #SOFTAP_ERROR_NONE Successful
+ * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_PERMISSION_DENIED Permission denied
+ * @see softap_enable_dhcp()
+ * @see softap_enable_dhcp_with_range()
*/
int softap_disable_dhcp(softap_h softap);
/**
- * @brief Checks whether the dhcp is enabled or not.
- * @since_tizen 4.0
- * @param[in] softap The softap handle
- * @param[out] dhcp_enabled @c true if dhcp is enabled, \n @c false if dhcp is disabled
+ * @brief Checks whether the DHCP is enabled or not.
+ * @since_tizen 5.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/softap
+ * @param[in] softap The SoftAP handle
+ * @param[out] dhcp_enabled @c true if DHCP is enabled, \n @c false if DHCP is disabled
* @return 0 on success, otherwise a negative error value
- * @retval #SOFTAP_ERROR_NONE Successful
- * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #SOFTAP_ERROR_NONE Successful
+ * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #SOFTAP_ERROR_PERMISSION_DENIED Permission denied
**/
int softap_is_dhcp_enabled(softap_h softap, bool *dhcp_enabled);
/**
- * @brief Enables the dhcp server with the address range.
- * @since_tizen 4.0
- * @details Enable the dhcp server with the address range.
+ * @brief Enables the DHCP server with the address range.
+ * @details Enable the DHCP server with the address range.
+ * @since_tizen 5.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/softap
* @param[in] softap The handle of softap
* @param[in] rangestart Start address range
* @param[in] rangestop End address range
* @return 0 on success, otherwise negative error value.
- * @retval #SOFTAP_ERROR_NONE Successful
- * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #SOFTAP_ERROR_NONE Successful
+ * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_PERMISSION_DENIED Permission denied
+ * @see softap_disable_dhcp()
**/
int softap_enable_dhcp_with_range(softap_h softap, char *rangestart, char *rangestop);
/**
- * @brief Sets the wireless mode for Soft AP.
- * @details If wireless mode is not set, Soft AP sets default wireless mode.
- * @since_tizen 4.0
- * @param[in] softap The softap handle
+ * @brief Sets the wireless mode for SoftAP.
+ * @details If wireless mode is not set, SoftAP sets default wireless mode.
+ * @since_tizen 5.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/softap
+ * @param[in] softap The SoftAP handle
* @param[in] mode The mode
* @return 0 on success, otherwise negative error value
- * @retval #SOFTAP_ERROR_NONE Successful
- * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_NONE Successful
+ * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_PERMISSION_DENIED Permission denied
+ * @see softap_get_mode()
*/
int softap_set_mode(softap_h softap, softap_wireless_mode_e mode);
/**
- * @brief Gets the wireless mode for Soft AP.
- * @since_tizen 4.0
- * @param[in] softap The softap handle
+ * @brief Gets the wireless mode for SoftAP.
+ * @since_tizen 5.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/softap
+ * @param[in] softap The SoftAP handle
* @param[out] mode The wireless mode
* @return 0 on success, otherwise negative error value
- * @retval #SOFTAP_ERROR_NONE Successful
- * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_NONE Successful
+ * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_PERMISSION_DENIED Permission denied
+ * @see softap_set_mode()
*/
int softap_get_mode(softap_h softap, softap_wireless_mode_e *mode);
/**
* @brief Clones the handle of a client.
- * @since_tizen 3.0
- * @remarks @a dest must be release using softap_client_destroy().
+ * @since_tizen 5.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/softap
+ * @remarks The @a dest should be released using softap_client_destroy().
* @param[out] dest The cloned client handle
* @param[in] origin The origin client handle
* @return 0 on success, otherwise a negative error value
- * @retval #SOFTAP_ERROR_NONE Successful
- * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #SOFTAP_ERROR_NONE Successful
+ * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SOFTAP_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #SOFTAP_ERROR_PERMISSION_DENIED Permission denied
- * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_PERMISSION_DENIED Permission denied
* @see softap_client_destroy()
*/
int softap_client_clone(softap_client_h *dest, softap_client_h origin);
/**
* @brief Destroys the handle of a client.
- * @since_tizen 3.0
+ * @since_tizen 5.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/softap
* @param[in] client The client handle
* @return 0 on success, otherwise a negative error value
- * @retval #SOFTAP_ERROR_NONE Successful
- * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_NONE Successful
+ * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_PERMISSION_DENIED Permission denied
* @see softap_client_clone()
*/
int softap_client_destroy(softap_client_h client);
/**
* @brief Gets the name of a client.
- * @since_tizen 3.0
- * @remarks @a name must be released using free().
+ * @since_tizen 5.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/softap
+ * @remarks The @a name should be released using free().
* @param[in] client The client handle
* @param[out] name The name of the client
* @return 0 on success, otherwise a negative error value
- * @retval #SOFTAP_ERROR_NONE Successful
- * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #SOFTAP_ERROR_NONE Successful
+ * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SOFTAP_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_PERMISSION_DENIED Permission denied
* @see softap_client_connection_state_changed_cb()
*/
int softap_client_get_name(softap_client_h client, char **name);
/**
* @brief Gets the IP address of a client.
- * @since_tizen 3.0
- * @remarks @a ip_address must be released using free().
+ * @since_tizen 5.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/softap
+ * @remarks The @a ip_address should be released using free().
* @param[in] client The client handle
* @param[in] address_family The address family of IP address. Currently, #SOFTAP_ADDRESS_FAMILY_IPV4 is only supported
* @param[out] ip_address The IP address
* @return 0 on success, otherwise a negative error value
- * @retval #SOFTAP_ERROR_NONE Successful
- * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #SOFTAP_ERROR_NONE Successful
+ * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SOFTAP_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_PERMISSION_DENIED Permission denied
* @see softap_client_connection_state_changed_cb()
*/
int softap_client_get_ip_address(softap_client_h client, softap_address_family_e address_family, char **ip_address);
/**
* @brief Gets the MAC address of a client such as "FC:A1:3E:D6:B1:B1".
- * @since_tizen 3.0
- * @remarks @a mac_address must be released using free().
+ * @since_tizen 5.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/softap
+ * @remarks The @a mac_address should be released using free().
* @param[in] client The client handle
* @param[out] mac_address The MAC address
* @return 0 on success, otherwise a negative error value
- * @retval #SOFTAP_ERROR_NONE Successful
- * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #SOFTAP_ERROR_NONE Successful
+ * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SOFTAP_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_PERMISSION_DENIED Permission denied
* @see softap_client_connection_state_changed_cb()
*/
int softap_client_get_mac_address(softap_client_h client, char **mac_address);
/**
* @brief Gets the connection time of a client.
- * @since_tizen 3.0
- * @param[in] client The client handle
- * @param[out] time The connected time of the client
+ * @since_tizen 5.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/softap
+ * @param[in] client The client handle
+ * @param[out] timestamp The connected time of the client
* @return 0 on success, otherwise a negative error value
- * @retval #SOFTAP_ERROR_NONE Successful
- * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_NONE Successful
+ * @retval #SOFTAP_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #SOFTAP_ERROR_NOT_SUPPORTED API is not supported
+ * @retval #SOFTAP_ERROR_PERMISSION_DENIED Permission denied
* @see softap_client_connection_state_changed_cb()
*/
int softap_client_get_time(softap_client_h client, time_t *timestamp);
projects / platform / core / api / softap.git / commitdiff