From: Jaehyun Kim Date: Tue, 11 Sep 2018 01:54:45 +0000 (+0900) Subject: Correct the classification of some APIs X-Git-Tag: submit/tizen/20180911.120738~1 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=2715df503957f450f19e286977d72b854ebd7a68;p=platform%2Fcore%2Fapi%2Fwifi-manager.git Correct the classification of some APIs Change-Id: Ib33d695f111f1c9274aca2ac8e5e20a9d7f2fe4e Signed-off-by: Jaehyun Kim --- diff --git a/include/wifi-manager.h b/include/wifi-manager.h index b7b84c7..f6fe194 100755 --- a/include/wifi-manager.h +++ b/include/wifi-manager.h @@ -2693,6 +2693,149 @@ int wifi_manager_ap_get_dns_address(wifi_manager_ap_h ap, int wifi_manager_ap_set_dns_address(wifi_manager_ap_h ap, int order, wifi_manager_address_family_e address_family, const char *dns_address); +/** + * @brief Gets the DNS config type. + * @since_tizen 4.0 + * @param[in] ap The access point handle + * @param[in] address_family The address family + * @param[out] type The DNS config type + * @return 0 on success, otherwise negative error value. + * @retval #WIFI_MANAGER_ERROR_NONE Successful + * @retval #WIFI_MANAGER_ERROR_NOT_INITIALIZED Not initialized + * @retval #WIFI_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #WIFI_MANAGER_ERROR_OPERATION_FAILED Operation failed + * @retval #WIFI_MANAGER_ERROR_NOT_SUPPORTED Not supported + */ +int wifi_manager_ap_get_dns_config_type(wifi_manager_ap_h ap, + wifi_manager_address_family_e address_family, wifi_manager_dns_config_type_e *type); + +/** + * @brief Sets the DNS config type. + * @since_tizen 4.0 + * @param[in] ap The access point handle + * @param[in] address_family The address family + * @param[in] type The DNS config type + * @return 0 on success, otherwise negative error value. + * @retval #WIFI_MANAGER_ERROR_NONE Successful + * @retval #WIFI_MANAGER_ERROR_NOT_INITIALIZED Not initialized + * @retval #WIFI_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #WIFI_MANAGER_ERROR_OPERATION_FAILED Operation failed + * @retval #WIFI_MANAGER_ERROR_NOT_SUPPORTED Not supported + * @see wifi_manager_update_ap() + */ +int wifi_manager_ap_set_dns_config_type(wifi_manager_ap_h ap, + wifi_manager_address_family_e address_family, wifi_manager_dns_config_type_e type); + +/** + * @brief Gets the network prefix length. + * @since_tizen 4.0 + * @param[in] ap The access point handle + * @param[in] address_family The address family + * @param[out] prefix_len The network prefix length. \n + * In case of IPv4, it means netmask length \n + * (also called a prefix, e.g. 8, 16, 24, 32) + * @return 0 on success, otherwise negative error value. + * @retval #WIFI_MANAGER_ERROR_NONE Successful + * @retval #WIFI_MANAGER_ERROR_NOT_INITIALIZED Not initialized + * @retval #WIFI_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #WIFI_MANAGER_ERROR_NOT_SUPPORTED Not supported + */ +int wifi_manager_ap_get_prefix_length(wifi_manager_ap_h ap, + wifi_manager_address_family_e address_family, int *prefix_len); + +/** + * @brief Sets the network prefix length. + * @since_tizen 4.0 + * @param[in] ap The access point handle + * @param[in] address_family The address family + * @param[in] prefix_len The network prefix length. \n + * In case of IPv4, it means netmask length \n + * (also called a prefix, e.g. 8, 16, 24, 32) + * @return 0 on success, otherwise negative error value. + * @retval #WIFI_MANAGER_ERROR_NONE Successful + * @retval #WIFI_MANAGER_ERROR_NOT_INITIALIZED Not initialized + * @retval #WIFI_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #WIFI_MANAGER_ERROR_NOT_SUPPORTED Not supported + * @see wifi_manager_update_ap() + */ +int wifi_manager_ap_set_prefix_length(wifi_manager_ap_h ap, + wifi_manager_address_family_e address_family, int prefix_len); + +/** + * @brief Gets the Wi-Fi disconnect reason from the supplicant. + * @since_tizen 3.0 + * @param[in] ap The access point handle + * @param[out] disconnect_reason The supplicant disconnect reason + * @return 0 on success, otherwise negative error value + * @retval #WIFI_MANAGER_ERROR_NONE Successful + * @retval #WIFI_MANAGER_ERROR_NOT_INITIALIZED Not initialized + * @retval #WIFI_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #WIFI_MANAGER_ERROR_OPERATION_FAILED Operation failed + * @retval #WIFI_MANAGER_ERROR_NOT_SUPPORTED Not supported + */ +int wifi_manager_ap_get_disconnect_reason(wifi_manager_ap_h ap, + wifi_manager_disconnect_reason_e *disconnect_reason); + +/** + * @brief Gets the error state. + * @since_tizen 4.0 + * @param[in] ap The access point handle + * @param[out] error_state The Wi-Fi connection error state + * @return 0 on success, otherwise negative error value + * @retval #WIFI_MANAGER_ERROR_NONE Successful + * @retval #WIFI_MANAGER_ERROR_NOT_INITIALIZED Not initialized + * @retval #WIFI_MANAGER_ERROR_INVALID_OPERATION Invalid operation + * @retval #WIFI_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #WIFI_MANAGER_ERROR_NOT_SUPPORTED Not supported + */ +int wifi_manager_ap_get_error_state(wifi_manager_ap_h ap, wifi_manager_error_e *error_state); + +/** + * @brief Gets the Wi-Fi Association Status Code from the supplicant. + * @since_tizen 5.0 + * @param[in] ap The access point handle + * @param[out] status_code The supplicant Wi-Fi association status code + * @return 0 on success, otherwise negative error value + * @retval #WIFI_MANAGER_ERROR_NONE Successful + * @retval #WIFI_MANAGER_ERROR_NOT_INITIALIZED Not initialized + * @retval #WIFI_MANAGER_ERROR_INVALID_OPERATION Invalid operation + * @retval #WIFI_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #WIFI_MANAGER_ERROR_NOT_SUPPORTED Not supported + */ + +int wifi_manager_ap_get_assoc_status_code(wifi_manager_ap_h ap, + wifi_manager_assoc_status_code_e *status_code); +/** + * @brief Called with VSIE data and length of VSIE. + * @since_tizen 5.0 + * @remarks If @a vsie is needed outside the callback, a copy should be + * made. @a vsie will be freed automatically after the execution + * of this callback. + * @param[in] vsie The vendor specific data + * @param[in] length The length of vendor specific data + * @param[in] user_data The user data passed from the foreach function + * @return @c true to continue with the next iteration of the loop, \n + * @c false to break out of the loop + * @pre wifi_manager_ap_foreach_vsie() will invoke this callback. + * @see wifi_manager_ap_foreach_vsie(). + */ +typedef bool(*wifi_manager_ap_vsie_cb)(unsigned char *vsie, int length, void *user_data); + +/** + * @brief Gets all VSIE of AP. + * @since_tizen 5.0 + * @param[in] ap The access point handle + * @param[in] callback The callback to be called for each VSIE of AP + * @param[in] user_data The user data passed to the callback function + * @return 0 on success, otherwise negative error value. + * @retval #WIFI_MANAGER_ERROR_NONE Successful + * @retval #WIFI_MANAGER_ERROR_NOT_INITIALIZED Not initialized + * @retval #WIFI_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #WIFI_MANAGER_ERROR_NOT_SUPPORTED Not supported + */ +int wifi_manager_ap_foreach_vsie(wifi_manager_ap_h ap, + wifi_manager_ap_vsie_cb callback, void *user_data); + /** * @brief Gets the raw country code. * @since_tizen 5.0 @@ -3058,149 +3201,6 @@ int wifi_manager_ap_get_eap_auth_type(wifi_manager_ap_h ap, wifi_manager_eap_aut */ int wifi_manager_ap_set_eap_auth_type(wifi_manager_ap_h ap, wifi_manager_eap_auth_type_e type); - -/** - * @brief Gets the Wi-Fi disconnect reason from the supplicant. - * @since_tizen 3.0 - * @param[in] ap The access point handle - * @param[out] disconnect_reason The supplicant disconnect reason - * @return 0 on success, otherwise negative error value - * @retval #WIFI_MANAGER_ERROR_NONE Successful - * @retval #WIFI_MANAGER_ERROR_NOT_INITIALIZED Not initialized - * @retval #WIFI_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #WIFI_MANAGER_ERROR_OPERATION_FAILED Operation failed - * @retval #WIFI_MANAGER_ERROR_NOT_SUPPORTED Not supported - */ -int wifi_manager_ap_get_disconnect_reason(wifi_manager_ap_h ap, - wifi_manager_disconnect_reason_e *disconnect_reason); -/** - * @brief Gets the DNS config type. - * @since_tizen 4.0 - * @param[in] ap The access point handle - * @param[in] address_family The address family - * @param[out] type The DNS config type - * @return 0 on success, otherwise negative error value. - * @retval #WIFI_MANAGER_ERROR_NONE Successful - * @retval #WIFI_MANAGER_ERROR_NOT_INITIALIZED Not initialized - * @retval #WIFI_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #WIFI_MANAGER_ERROR_OPERATION_FAILED Operation failed - * @retval #WIFI_MANAGER_ERROR_NOT_SUPPORTED Not supported - */ -int wifi_manager_ap_get_dns_config_type(wifi_manager_ap_h ap, - wifi_manager_address_family_e address_family, wifi_manager_dns_config_type_e *type); - -/** - * @brief Sets the DNS config type. - * @since_tizen 4.0 - * @param[in] ap The access point handle - * @param[in] address_family The address family - * @param[in] type The DNS config type - * @return 0 on success, otherwise negative error value. - * @retval #WIFI_MANAGER_ERROR_NONE Successful - * @retval #WIFI_MANAGER_ERROR_NOT_INITIALIZED Not initialized - * @retval #WIFI_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #WIFI_MANAGER_ERROR_OPERATION_FAILED Operation failed - * @retval #WIFI_MANAGER_ERROR_NOT_SUPPORTED Not supported - * @see wifi_manager_update_ap() - */ -int wifi_manager_ap_set_dns_config_type(wifi_manager_ap_h ap, - wifi_manager_address_family_e address_family, wifi_manager_dns_config_type_e type); - -/** - * @brief Gets the network prefix length. - * @since_tizen 4.0 - * @param[in] ap The access point handle - * @param[in] address_family The address family - * @param[out] prefix_len The network prefix length. \n - * In case of IPv4, it means netmask length \n - * (also called a prefix, e.g. 8, 16, 24, 32) - * @return 0 on success, otherwise negative error value. - * @retval #WIFI_MANAGER_ERROR_NONE Successful - * @retval #WIFI_MANAGER_ERROR_NOT_INITIALIZED Not initialized - * @retval #WIFI_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #WIFI_MANAGER_ERROR_NOT_SUPPORTED Not supported - */ -int wifi_manager_ap_get_prefix_length(wifi_manager_ap_h ap, - wifi_manager_address_family_e address_family, int *prefix_len); - -/** - * @brief Sets the network prefix length. - * @since_tizen 4.0 - * @param[in] ap The access point handle - * @param[in] address_family The address family - * @param[in] prefix_len The network prefix length. \n - * In case of IPv4, it means netmask length \n - * (also called a prefix, e.g. 8, 16, 24, 32) - * @return 0 on success, otherwise negative error value. - * @retval #WIFI_MANAGER_ERROR_NONE Successful - * @retval #WIFI_MANAGER_ERROR_NOT_INITIALIZED Not initialized - * @retval #WIFI_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #WIFI_MANAGER_ERROR_NOT_SUPPORTED Not supported - * @see wifi_manager_update_ap() - */ -int wifi_manager_ap_set_prefix_length(wifi_manager_ap_h ap, - wifi_manager_address_family_e address_family, int prefix_len); - -/** - * @brief Gets the error state. - * @since_tizen 4.0 - * @param[in] ap The access point handle - * @param[out] error_state The Wi-Fi connection error state - * @return 0 on success, otherwise negative error value - * @retval #WIFI_MANAGER_ERROR_NONE Successful - * @retval #WIFI_MANAGER_ERROR_NOT_INITIALIZED Not initialized - * @retval #WIFI_MANAGER_ERROR_INVALID_OPERATION Invalid operation - * @retval #WIFI_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #WIFI_MANAGER_ERROR_NOT_SUPPORTED Not supported - */ -int wifi_manager_ap_get_error_state(wifi_manager_ap_h ap, wifi_manager_error_e *error_state); - -/** - * @brief Gets the Wi-Fi Association Status Code from the supplicant. - * @since_tizen 5.0 - * @param[in] ap The access point handle - * @param[out] status_code The supplicant Wi-Fi association status code - * @return 0 on success, otherwise negative error value - * @retval #WIFI_MANAGER_ERROR_NONE Successful - * @retval #WIFI_MANAGER_ERROR_NOT_INITIALIZED Not initialized - * @retval #WIFI_MANAGER_ERROR_INVALID_OPERATION Invalid operation - * @retval #WIFI_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #WIFI_MANAGER_ERROR_NOT_SUPPORTED Not supported - */ - -int wifi_manager_ap_get_assoc_status_code(wifi_manager_ap_h ap, - wifi_manager_assoc_status_code_e *status_code); -/** - * @brief Called with VSIE data and length of VSIE. - * @since_tizen 5.0 - * @remarks If @a vsie is needed outside the callback, a copy should be - * made. @a vsie will be freed automatically after the execution - * of this callback. - * @param[in] vsie The vendor specific data - * @param[in] length The length of vendor specific data - * @param[in] user_data The user data passed from the foreach function - * @return @c true to continue with the next iteration of the loop, \n - * @c false to break out of the loop - * @pre wifi_manager_ap_foreach_vsie() will invoke this callback. - * @see wifi_manager_ap_foreach_vsie(). - */ -typedef bool(*wifi_manager_ap_vsie_cb)(unsigned char *vsie, int length, void *user_data); - -/** - * @brief Gets all VSIE of AP. - * @since_tizen 5.0 - * @param[in] ap The access point handle - * @param[in] callback The callback to be called for each VSIE of AP - * @param[in] user_data The user data passed to the callback function - * @return 0 on success, otherwise negative error value. - * @retval #WIFI_MANAGER_ERROR_NONE Successful - * @retval #WIFI_MANAGER_ERROR_NOT_INITIALIZED Not initialized - * @retval #WIFI_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #WIFI_MANAGER_ERROR_NOT_SUPPORTED Not supported - */ -int wifi_manager_ap_foreach_vsie(wifi_manager_ap_h ap, - wifi_manager_ap_vsie_cb callback, void *user_data); - /** * @} */