Tizen Native API
5.5
|
The Connection Information API provides functions for managing the network information.
#include <wifi-manager.h>
The Connection Information API provides functions for managing the network information. You can manage the network information using the functions.
This API is related with the following features:
It is recommended to design applications with regard to features, for reliability.
You can check if a device supports the related features for this API by using System Information, and control your application's actions accordingly.
To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.
More details on featuring your application can be found from Feature Element.
Functions | |
int | wifi_manager_ap_get_essid (wifi_manager_ap_h ap, char **essid) |
Gets ESSID (Extended Service Set Identifier). | |
int | wifi_manager_ap_get_raw_ssid (wifi_manager_ap_h ap, char **ssid, int *ssid_len) |
Gets raw SSID (Service Set Identifier). | |
int | wifi_manager_ap_get_bssid (wifi_manager_ap_h ap, char **bssid) |
Gets BSSID (Basic Service Set Identifier). | |
int | wifi_manager_ap_get_rssi (wifi_manager_ap_h ap, int *rssi) |
Gets the RSSI. | |
int | wifi_manager_ap_get_rssi_level (wifi_manager_ap_h ap, wifi_manager_rssi_level_e *rssi_level) |
Gets the RSSI level. | |
int | wifi_manager_ap_get_frequency (wifi_manager_ap_h ap, int *frequency) |
Gets the frequency band (MHz). | |
int | wifi_manager_ap_get_max_speed (wifi_manager_ap_h ap, int *max_speed) |
Gets the max speed (Mbps). | |
int | wifi_manager_ap_is_favorite (wifi_manager_ap_h ap, bool *favorite) |
Checks whether the access point is favorite or not. | |
int | wifi_manager_ap_is_passpoint (wifi_manager_ap_h ap, bool *passpoint) |
Checks whether the access point is passpoint or not. | |
int | wifi_manager_ap_is_hidden (wifi_manager_ap_h ap, bool *is_hidden) |
Checks whether the access point is hidden or not. | |
int | wifi_manager_ap_get_connection_state (wifi_manager_ap_h ap, wifi_manager_connection_state_e *state) |
Gets the connection state. | |
int | wifi_manager_ap_get_ip_config_type (wifi_manager_ap_h ap, wifi_manager_address_family_e address_family, wifi_manager_ip_config_type_e *type) |
Gets the config type of IP. | |
int | wifi_manager_ap_set_ip_config_type (wifi_manager_ap_h ap, wifi_manager_address_family_e address_family, wifi_manager_ip_config_type_e type) |
Sets the config type of IP. | |
int | wifi_manager_ap_get_ip_address (wifi_manager_ap_h ap, wifi_manager_address_family_e address_family, char **ip_address) |
Gets the IP address. | |
int | wifi_manager_ap_set_ip_address (wifi_manager_ap_h ap, wifi_manager_address_family_e address_family, const char *ip_address) |
Sets the IP address. | |
int | wifi_manager_ap_foreach_ipv6_address (wifi_manager_ap_h ap, wifi_manager_ap_ipv6_address_cb callback, void *user_data) |
Gets all IPv6 addresses assigned to the Wi-Fi interface. | |
int | wifi_manager_ap_get_subnet_mask (wifi_manager_ap_h ap, wifi_manager_address_family_e address_family, char **subnet_mask) |
Gets the subnet mask. | |
int | wifi_manager_ap_set_subnet_mask (wifi_manager_ap_h ap, wifi_manager_address_family_e address_family, const char *subnet_mask) |
Sets the subnet mask. | |
int | wifi_manager_ap_get_gateway_address (wifi_manager_ap_h ap, wifi_manager_address_family_e address_family, char **gateway_address) |
Gets the gateway address. | |
int | wifi_manager_ap_set_gateway_address (wifi_manager_ap_h ap, wifi_manager_address_family_e address_family, const char *gateway_address) |
Sets the gateway address. | |
int | wifi_manager_ap_get_dhcp_server_address (wifi_manager_ap_h ap, wifi_manager_address_family_e address_family, char **dhcp_server) |
Gets the DHCP Server address. | |
int | wifi_manager_ap_get_dhcp_lease_duration (wifi_manager_ap_h ap, wifi_manager_address_family_e address_family, int *dhcp_lease_duration) |
Gets the DHCP lease duration. | |
int | wifi_manager_ap_get_proxy_address (wifi_manager_ap_h ap, wifi_manager_address_family_e address_family, char **proxy_address) |
Gets the proxy address. | |
int | wifi_manager_ap_set_proxy_address (wifi_manager_ap_h ap, wifi_manager_address_family_e address_family, const char *proxy_address) |
Sets the proxy address. | |
int | wifi_manager_ap_get_proxy_type (wifi_manager_ap_h ap, wifi_manager_proxy_type_e *proxy_type) |
Gets the Proxy type. | |
int | wifi_manager_ap_set_proxy_type (wifi_manager_ap_h ap, wifi_manager_proxy_type_e proxy_type) |
Sets the Proxy address. | |
int | wifi_manager_ap_get_dns_address (wifi_manager_ap_h ap, int order, wifi_manager_address_family_e address_family, char **dns_address) |
Gets the DNS address. | |
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) |
Sets the DNS address. | |
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) |
Gets the DNS config type. | |
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) |
Sets the DNS config type. | |
int | wifi_manager_ap_get_prefix_length (wifi_manager_ap_h ap, wifi_manager_address_family_e address_family, int *prefix_len) |
Gets the network prefix length. | |
int | wifi_manager_ap_set_prefix_length (wifi_manager_ap_h ap, wifi_manager_address_family_e address_family, int prefix_len) |
Sets the network prefix length. | |
int | wifi_manager_ap_get_disconnect_reason (wifi_manager_ap_h ap, wifi_manager_disconnect_reason_e *disconnect_reason) |
Gets the Wi-Fi disconnect reason from the supplicant. | |
int | wifi_manager_ap_get_error_state (wifi_manager_ap_h ap, wifi_manager_error_e *error_state) |
Gets the error state. | |
int | wifi_manager_ap_get_assoc_status_code (wifi_manager_ap_h ap, wifi_manager_assoc_status_code_e *status_code) |
Gets the Wi-Fi Association Status Code from the supplicant. | |
int | wifi_manager_ap_foreach_vsie (wifi_manager_ap_h ap, wifi_manager_ap_vsie_cb callback, void *user_data) |
Gets all VSIE of AP. | |
int | wifi_manager_ap_get_countrycode (wifi_manager_ap_h ap, char **country_code) |
Gets the raw country code. | |
int | wifi_manager_foreach_found_bssid (wifi_manager_ap_h ap, wifi_manager_found_bssid_cb callback, void *user_data) |
Gets the BSSID list. | |
Typedefs | |
typedef bool(* | wifi_manager_ap_ipv6_address_cb )(char *ipv6_address, void *user_data) |
Called with an IPv6 address. | |
typedef bool(* | wifi_manager_ap_vsie_cb )(unsigned char *vsie, int length, void *user_data) |
Called with VSIE data and length of VSIE. | |
typedef bool(* | wifi_manager_found_bssid_cb )(const char *bssid, int rssi, int freq, void *user_data) |
Called for each found BSSID. |
typedef bool(* wifi_manager_ap_ipv6_address_cb)(char *ipv6_address, void *user_data) |
Called with an IPv6 address.
[in] | ipv6_address | The IPv6 address |
[in] | user_data | The user data passed from the foreach function |
true
to continue with the next iteration of the loop, false
to break out of the loop typedef bool(* wifi_manager_ap_vsie_cb)(unsigned char *vsie, int length, void *user_data) |
Called with VSIE data and length of VSIE.
[in] | vsie | The vendor specific data |
[in] | length | The length of vendor specific data |
[in] | user_data | The user data passed from the foreach function |
true
to continue with the next iteration of the loop, false
to break out of the loop typedef bool(* wifi_manager_found_bssid_cb)(const char *bssid, int rssi, int freq, void *user_data) |
Called for each found BSSID.
[in] | bssid | The BSSID |
[in] | rssi | The RSSI |
[in] | freq | The frequency |
[in] | user_data | The user data passed from the foreach function |
true
to continue with the next iteration of the loop, otherwise false
to break out of the loop Enumeration for the Net IP configuration type.
int wifi_manager_ap_foreach_ipv6_address | ( | wifi_manager_ap_h | ap, |
wifi_manager_ap_ipv6_address_cb | callback, | ||
void * | user_data | ||
) |
Gets all IPv6 addresses assigned to the Wi-Fi interface.
[in] | ap | The access point handle |
[in] | callback | The callback to be called for each IPv6 address |
[in] | user_data | The user data passed to the callback function |
WIFI_MANAGER_ERROR_NONE | Successful |
WIFI_MANAGER_ERROR_NOT_INITIALIZED | Not initialized |
WIFI_MANAGER_ERROR_INVALID_PARAMETER | Invalid parameter |
WIFI_MANAGER_ERROR_OPERATION_FAILED | Operation failed |
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 | ||
) |
Gets all VSIE of AP.
[in] | ap | The access point handle |
[in] | callback | The callback to be called for each VSIE of AP |
[in] | user_data | The user data passed to the callback function |
WIFI_MANAGER_ERROR_NONE | Successful |
WIFI_MANAGER_ERROR_NOT_INITIALIZED | Not initialized |
WIFI_MANAGER_ERROR_INVALID_PARAMETER | Invalid parameter |
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 | ||
) |
Gets the Wi-Fi Association Status Code from the supplicant.
[in] | ap | The access point handle |
[out] | status_code | The supplicant Wi-Fi association status code |
WIFI_MANAGER_ERROR_NONE | Successful |
WIFI_MANAGER_ERROR_NOT_INITIALIZED | Not initialized |
WIFI_MANAGER_ERROR_INVALID_OPERATION | Invalid operation |
WIFI_MANAGER_ERROR_INVALID_PARAMETER | Invalid parameter |
WIFI_MANAGER_ERROR_NOT_SUPPORTED | Not supported |
int wifi_manager_ap_get_bssid | ( | wifi_manager_ap_h | ap, |
char ** | bssid | ||
) |
Gets BSSID (Basic Service Set Identifier).
[in] | ap | The access point handle |
[out] | bssid | The BSSID |
WIFI_MANAGER_ERROR_NONE | Successful |
WIFI_MANAGER_ERROR_NOT_INITIALIZED | Not initialized |
WIFI_MANAGER_ERROR_INVALID_PARAMETER | Invalid parameter |
WIFI_MANAGER_ERROR_OUT_OF_MEMORY | Out of memory |
WIFI_MANAGER_ERROR_NOT_SUPPORTED | Not supported |
int wifi_manager_ap_get_connection_state | ( | wifi_manager_ap_h | ap, |
wifi_manager_connection_state_e * | state | ||
) |
Gets the connection state.
[in] | ap | The access point handle |
[out] | state | The connection state |
WIFI_MANAGER_ERROR_NONE | Successful |
WIFI_MANAGER_ERROR_NOT_INITIALIZED | Not initialized |
WIFI_MANAGER_ERROR_INVALID_PARAMETER | Invalid parameter |
WIFI_MANAGER_ERROR_OPERATION_FAILED | Operation failed |
WIFI_MANAGER_ERROR_NOT_SUPPORTED | Not supported |
int wifi_manager_ap_get_countrycode | ( | wifi_manager_ap_h | ap, |
char ** | country_code | ||
) |
Gets the raw country code.
[in] | ap | The access point handle |
[out] | country_code | The country code, NULL if M/W does not have the country code |
WIFI_MANAGER_ERROR_NONE | Successful |
WIFI_MANAGER_ERROR_NOT_INITIALIZED | Not initialized |
WIFI_MANAGER_ERROR_INVALID_PARAMETER | Invalid parameter |
WIFI_MANAGER_ERROR_OUT_OF_MEMORY | Out of memory |
WIFI_MANAGER_ERROR_NOT_SUPPORTED | Not supported |
int wifi_manager_ap_get_dhcp_lease_duration | ( | wifi_manager_ap_h | ap, |
wifi_manager_address_family_e | address_family, | ||
int * | dhcp_lease_duration | ||
) |
Gets the DHCP lease duration.
[in] | ap | The access point handle |
[in] | address_family | The address family |
[out] | dhcp_lease_duration | The DHCP lease duration in seconds |
WIFI_MANAGER_ERROR_NONE | Successful |
WIFI_MANAGER_ERROR_NOT_INITIALIZED | Not initialized |
WIFI_MANAGER_ERROR_INVALID_PARAMETER | Invalid parameter |
WIFI_MANAGER_ERROR_NOT_SUPPORTED | Not supported |
int wifi_manager_ap_get_dhcp_server_address | ( | wifi_manager_ap_h | ap, |
wifi_manager_address_family_e | address_family, | ||
char ** | dhcp_server | ||
) |
Gets the DHCP Server address.
[in] | ap | The access point handle |
[in] | address_family | The address family |
[out] | dhcp_server | The DHCP server address |
WIFI_MANAGER_ERROR_NONE | Successful |
WIFI_MANAGER_ERROR_NOT_INITIALIZED | Not initialized |
WIFI_MANAGER_ERROR_INVALID_PARAMETER | Invalid parameter |
WIFI_MANAGER_ERROR_OUT_OF_MEMORY | Out of memory |
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 | ||
) |
Gets the Wi-Fi disconnect reason from the supplicant.
[in] | ap | The access point handle |
[out] | disconnect_reason | The supplicant disconnect reason |
WIFI_MANAGER_ERROR_NONE | Successful |
WIFI_MANAGER_ERROR_NOT_INITIALIZED | Not initialized |
WIFI_MANAGER_ERROR_INVALID_PARAMETER | Invalid parameter |
WIFI_MANAGER_ERROR_OPERATION_FAILED | Operation failed |
WIFI_MANAGER_ERROR_NOT_SUPPORTED | Not supported |
int wifi_manager_ap_get_dns_address | ( | wifi_manager_ap_h | ap, |
int | order, | ||
wifi_manager_address_family_e | address_family, | ||
char ** | dns_address | ||
) |
Gets the DNS address.
2.You
must release dns_address using free(). [in] | ap | The access point handle |
[in] | order | The order of DNS address; it starts from 1, which means first DNS address |
[in] | address_family | The address family |
[out] | dns_address | The DNS address |
WIFI_MANAGER_ERROR_NONE | Successful |
WIFI_MANAGER_ERROR_NOT_INITIALIZED | Not initialized |
WIFI_MANAGER_ERROR_INVALID_PARAMETER | Invalid parameter |
WIFI_MANAGER_ERROR_OUT_OF_MEMORY | Out of memory |
WIFI_MANAGER_ERROR_ADDRESS_FAMILY_NOT_SUPPORTED | Address family not supported |
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 | ||
) |
Gets the DNS config type.
[in] | ap | The access point handle |
[in] | address_family | The address family |
[out] | type | The DNS config type |
WIFI_MANAGER_ERROR_NONE | Successful |
WIFI_MANAGER_ERROR_NOT_INITIALIZED | Not initialized |
WIFI_MANAGER_ERROR_INVALID_PARAMETER | Invalid parameter |
WIFI_MANAGER_ERROR_OPERATION_FAILED | Operation failed |
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 | ||
) |
Gets the error state.
[in] | ap | The access point handle |
[out] | error_state | The Wi-Fi connection error state |
WIFI_MANAGER_ERROR_NONE | Successful |
WIFI_MANAGER_ERROR_NOT_INITIALIZED | Not initialized |
WIFI_MANAGER_ERROR_INVALID_OPERATION | Invalid operation |
WIFI_MANAGER_ERROR_INVALID_PARAMETER | Invalid parameter |
WIFI_MANAGER_ERROR_NOT_SUPPORTED | Not supported |
int wifi_manager_ap_get_essid | ( | wifi_manager_ap_h | ap, |
char ** | essid | ||
) |
Gets ESSID (Extended Service Set Identifier).
[in] | ap | The access point handle |
[out] | essid | The ESSID |
WIFI_MANAGER_ERROR_NONE | Successful |
WIFI_MANAGER_ERROR_NOT_INITIALIZED | Not initialized |
WIFI_MANAGER_ERROR_INVALID_PARAMETER | Invalid parameter |
WIFI_MANAGER_ERROR_OUT_OF_MEMORY | Out of memory |
WIFI_MANAGER_ERROR_NOT_SUPPORTED | Not supported |
int wifi_manager_ap_get_frequency | ( | wifi_manager_ap_h | ap, |
int * | frequency | ||
) |
Gets the frequency band (MHz).
[in] | ap | The access point handle |
[out] | frequency | The frequency |
WIFI_MANAGER_ERROR_NONE | Successful |
WIFI_MANAGER_ERROR_NOT_INITIALIZED | Not initialized |
WIFI_MANAGER_ERROR_INVALID_PARAMETER | Invalid parameter |
WIFI_MANAGER_ERROR_OPERATION_FAILED | Operation failed |
WIFI_MANAGER_ERROR_NOT_SUPPORTED | Not supported |
int wifi_manager_ap_get_gateway_address | ( | wifi_manager_ap_h | ap, |
wifi_manager_address_family_e | address_family, | ||
char ** | gateway_address | ||
) |
Gets the gateway address.
[in] | ap | The access point handle |
[in] | address_family | The address family |
[out] | gateway_address | The gateway address |
WIFI_MANAGER_ERROR_NONE | Successful |
WIFI_MANAGER_ERROR_NOT_INITIALIZED | Not initialized |
WIFI_MANAGER_ERROR_INVALID_PARAMETER | Invalid parameter |
WIFI_MANAGER_ERROR_OUT_OF_MEMORY | Out of memory |
WIFI_MANAGER_ERROR_ADDRESS_FAMILY_NOT_SUPPORTED | Address family not supported |
WIFI_MANAGER_ERROR_NOT_SUPPORTED | Not supported |
int wifi_manager_ap_get_ip_address | ( | wifi_manager_ap_h | ap, |
wifi_manager_address_family_e | address_family, | ||
char ** | ip_address | ||
) |
Gets the IP address.
[in] | ap | The access point handle |
[in] | address_family | The address family |
[out] | ip_address | The IP address; this value is for default address e.g, IPv6 can have multiple addresses. but you can only obtain a representative address if you want to get all IPv6 address, you can use the wifi_manager_ap_foreach_ipv6_address(). |
WIFI_MANAGER_ERROR_NONE | Successful |
WIFI_MANAGER_ERROR_NOT_INITIALIZED | Not initialized |
WIFI_MANAGER_ERROR_INVALID_PARAMETER | Invalid parameter |
WIFI_MANAGER_ERROR_OUT_OF_MEMORY | Out of memory |
WIFI_MANAGER_ERROR_ADDRESS_FAMILY_NOT_SUPPORTED | Address family not supported |
WIFI_MANAGER_ERROR_NOT_SUPPORTED | Not supported |
int wifi_manager_ap_get_ip_config_type | ( | wifi_manager_ap_h | ap, |
wifi_manager_address_family_e | address_family, | ||
wifi_manager_ip_config_type_e * | type | ||
) |
Gets the config type of IP.
[in] | ap | The access point handle |
[in] | address_family | The address family |
[out] | type | The type of IP config |
WIFI_MANAGER_ERROR_NONE | Successful |
WIFI_MANAGER_ERROR_NOT_INITIALIZED | Not initialized |
WIFI_MANAGER_ERROR_INVALID_PARAMETER | Invalid parameter |
WIFI_MANAGER_ERROR_OPERATION_FAILED | Operation failed |
WIFI_MANAGER_ERROR_ADDRESS_FAMILY_NOT_SUPPORTED | Address family not supported |
WIFI_MANAGER_ERROR_NOT_SUPPORTED | Not supported |
int wifi_manager_ap_get_max_speed | ( | wifi_manager_ap_h | ap, |
int * | max_speed | ||
) |
Gets the max speed (Mbps).
[in] | ap | The access point handle |
[out] | max_speed | The max speed |
WIFI_MANAGER_ERROR_NONE | Successful |
WIFI_MANAGER_ERROR_NOT_INITIALIZED | Not initialized |
WIFI_MANAGER_ERROR_INVALID_PARAMETER | Invalid parameter |
WIFI_MANAGER_ERROR_OPERATION_FAILED | Operation failed |
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 | ||
) |
Gets the network prefix length.
[in] | ap | The access point handle |
[in] | address_family | The address family |
[out] | prefix_len | The network prefix length. In case of IPv4, it means netmask length (also called a prefix, e.g. 8, 16, 24, 32) |
WIFI_MANAGER_ERROR_NONE | Successful |
WIFI_MANAGER_ERROR_NOT_INITIALIZED | Not initialized |
WIFI_MANAGER_ERROR_INVALID_PARAMETER | Invalid parameter |
WIFI_MANAGER_ERROR_NOT_SUPPORTED | Not supported |
int wifi_manager_ap_get_proxy_address | ( | wifi_manager_ap_h | ap, |
wifi_manager_address_family_e | address_family, | ||
char ** | proxy_address | ||
) |
Gets the proxy address.
[in] | ap | The access point handle |
[in] | address_family | The address family |
[out] | proxy_address | The proxy address |
WIFI_MANAGER_ERROR_NONE | Successful |
WIFI_MANAGER_ERROR_NOT_INITIALIZED | Not initialized |
WIFI_MANAGER_ERROR_INVALID_PARAMETER | Invalid parameter |
WIFI_MANAGER_ERROR_OUT_OF_MEMORY | Out of memory |
WIFI_MANAGER_ERROR_ADDRESS_FAMILY_NOT_SUPPORTED | Address family not supported |
WIFI_MANAGER_ERROR_NOT_SUPPORTED | Not supported |
int wifi_manager_ap_get_proxy_type | ( | wifi_manager_ap_h | ap, |
wifi_manager_proxy_type_e * | proxy_type | ||
) |
Gets the Proxy type.
[in] | ap | The access point handle |
[out] | proxy_type | The type of proxy |
WIFI_MANAGER_ERROR_NONE | Successful |
WIFI_MANAGER_ERROR_NOT_INITIALIZED | Not initialized |
WIFI_MANAGER_ERROR_INVALID_PARAMETER | Invalid parameter |
WIFI_MANAGER_ERROR_OPERATION_FAILED | Operation failed |
WIFI_MANAGER_ERROR_NOT_SUPPORTED | Not supported |
int wifi_manager_ap_get_raw_ssid | ( | wifi_manager_ap_h | ap, |
char ** | ssid, | ||
int * | ssid_len | ||
) |
Gets raw SSID (Service Set Identifier).
[in] | ap | The access point handle |
[out] | ssid | The raw SSID bytes |
[out] | ssid_len | The raw SSID length |
WIFI_MANAGER_ERROR_NONE | Successful |
WIFI_MANAGER_ERROR_NOT_INITIALIZED | Not initialized |
WIFI_MANAGER_ERROR_INVALID_PARAMETER | Invalid parameter |
WIFI_MANAGER_ERROR_OUT_OF_MEMORY | Out of memory |
WIFI_MANAGER_ERROR_NOT_SUPPORTED | Not supported |
int wifi_manager_ap_get_rssi | ( | wifi_manager_ap_h | ap, |
int * | rssi | ||
) |
Gets the RSSI.
[in] | ap | The access point handle |
[out] | rssi | The RSSI value (in dBm) |
WIFI_MANAGER_ERROR_NONE | Successful |
WIFI_MANAGER_ERROR_NOT_INITIALIZED | Not initialized |
WIFI_MANAGER_ERROR_INVALID_PARAMETER | Invalid parameter |
WIFI_MANAGER_ERROR_OPERATION_FAILED | Operation failed |
WIFI_MANAGER_ERROR_NOT_SUPPORTED | Not supported |
int wifi_manager_ap_get_rssi_level | ( | wifi_manager_ap_h | ap, |
wifi_manager_rssi_level_e * | rssi_level | ||
) |
Gets the RSSI level.
[in] | ap | The access point handle |
[out] | rssi_level | The RSSI level |
WIFI_MANAGER_ERROR_NONE | Successful |
WIFI_MANAGER_ERROR_NOT_INITIALIZED | Not initialized |
WIFI_MANAGER_ERROR_INVALID_PARAMETER | Invalid parameter |
WIFI_MANAGER_ERROR_OPERATION_FAILED | Operation failed |
WIFI_MANAGER_ERROR_NOT_SUPPORTED | Not supported |
int wifi_manager_ap_get_subnet_mask | ( | wifi_manager_ap_h | ap, |
wifi_manager_address_family_e | address_family, | ||
char ** | subnet_mask | ||
) |
Gets the subnet mask.
[in] | ap | The access point handle |
[in] | address_family | The address family |
[out] | subnet_mask | The subnet mask |
WIFI_MANAGER_ERROR_NONE | Successful |
WIFI_MANAGER_ERROR_NOT_INITIALIZED | Not initialized |
WIFI_MANAGER_ERROR_INVALID_PARAMETER | Invalid parameter |
WIFI_MANAGER_ERROR_OUT_OF_MEMORY | Out of memory |
WIFI_MANAGER_ERROR_ADDRESS_FAMILY_NOT_SUPPORTED | Address family not supported |
WIFI_MANAGER_ERROR_NOT_SUPPORTED | Not supported |
int wifi_manager_ap_is_favorite | ( | wifi_manager_ap_h | ap, |
bool * | favorite | ||
) |
Checks whether the access point is favorite or not.
[in] | ap | The access point handle |
[out] | favorite | true if access point is favorite, otherwise false if access point is not favorite |
WIFI_MANAGER_ERROR_NONE | Successful |
WIFI_MANAGER_ERROR_NOT_INITIALIZED | Not initialized |
WIFI_MANAGER_ERROR_INVALID_PARAMETER | Invalid parameter |
WIFI_MANAGER_ERROR_OPERATION_FAILED | Operation failed |
WIFI_MANAGER_ERROR_NOT_SUPPORTED | Not supported |
int wifi_manager_ap_is_hidden | ( | wifi_manager_ap_h | ap, |
bool * | is_hidden | ||
) |
Checks whether the access point is hidden or not.
[in] | ap | The access point handle |
[out] | is_hidden | true if the access point is hidden, false if the access point is not hidden. |
WIFI_MANAGER_ERROR_NONE | Successful |
WIFI_MANAGER_ERROR_NOT_INITIALIZED | Not initialized |
WIFI_MANAGER_ERROR_INVALID_PARAMETER | Invalid parameter |
WIFI_MANAGER_ERROR_OPERATION_FAILED | Operation failed |
WIFI_MANAGER_ERROR_NOT_SUPPORTED | Not supported |
int wifi_manager_ap_is_passpoint | ( | wifi_manager_ap_h | ap, |
bool * | passpoint | ||
) |
Checks whether the access point is passpoint or not.
[in] | ap | The access point handle |
[out] | passpoint | true if access point is passpoint, otherwise false if access point is not passpoint. |
WIFI_MANAGER_ERROR_NONE | Successful |
WIFI_MANAGER_ERROR_NOT_INITIALIZED | Not initialized |
WIFI_MANAGER_ERROR_INVALID_PARAMETER | Invalid parameter |
WIFI_MANAGER_ERROR_OPERATION_FAILED | Operation failed |
WIFI_MANAGER_ERROR_NOT_SUPPORTED | Not supported |
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 | ||
) |
Sets the DNS address.
2
[in] | ap | The access point handle |
[in] | order | The order of DNS address It starts from 1 , which means first DNS address. |
[in] | address_family | The address family |
[in] | dns_address | The DNS address If you set this value to NULL , then the existing value will be deleted. |
WIFI_MANAGER_ERROR_NONE | Successful |
WIFI_MANAGER_ERROR_NOT_INITIALIZED | Not initialized |
WIFI_MANAGER_ERROR_INVALID_PARAMETER | Invalid parameter |
WIFI_MANAGER_ERROR_OPERATION_FAILED | Operation failed |
WIFI_MANAGER_ERROR_ADDRESS_FAMILY_NOT_SUPPORTED | Address family not supported |
WIFI_MANAGER_ERROR_PERMISSION_DENIED | Permission Denied |
WIFI_MANAGER_ERROR_NOT_SUPPORTED | Not supported |
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 | ||
) |
Sets the DNS config type.
[in] | ap | The access point handle |
[in] | address_family | The address family |
[in] | type | The DNS config type |
WIFI_MANAGER_ERROR_NONE | Successful |
WIFI_MANAGER_ERROR_NOT_INITIALIZED | Not initialized |
WIFI_MANAGER_ERROR_INVALID_PARAMETER | Invalid parameter |
WIFI_MANAGER_ERROR_OPERATION_FAILED | Operation failed |
WIFI_MANAGER_ERROR_NOT_SUPPORTED | Not supported |
int wifi_manager_ap_set_gateway_address | ( | wifi_manager_ap_h | ap, |
wifi_manager_address_family_e | address_family, | ||
const char * | gateway_address | ||
) |
Sets the gateway address.
[in] | ap | The access point handle |
[in] | address_family | The address family |
[in] | gateway_address | The gateway address If you set this value to NULL , then the existing value will be deleted. |
WIFI_MANAGER_ERROR_NONE | Successful |
WIFI_MANAGER_ERROR_NOT_INITIALIZED | Not initialized |
WIFI_MANAGER_ERROR_INVALID_PARAMETER | Invalid parameter |
WIFI_MANAGER_ERROR_OPERATION_FAILED | Operation failed |
WIFI_MANAGER_ERROR_ADDRESS_FAMILY_NOT_SUPPORTED | Address family not supported |
WIFI_MANAGER_ERROR_PERMISSION_DENIED | Permission Denied |
WIFI_MANAGER_ERROR_NOT_SUPPORTED | Not supported |
int wifi_manager_ap_set_ip_address | ( | wifi_manager_ap_h | ap, |
wifi_manager_address_family_e | address_family, | ||
const char * | ip_address | ||
) |
Sets the IP address.
[in] | ap | The access point handle |
[in] | address_family | The address family |
[in] | ip_address | The IP address; if you set this value to NULL, then the existing value will be deleted |
WIFI_MANAGER_ERROR_NONE | Successful |
WIFI_MANAGER_ERROR_NOT_INITIALIZED | Not initialized |
WIFI_MANAGER_ERROR_INVALID_PARAMETER | Invalid parameter |
WIFI_MANAGER_ERROR_OPERATION_FAILED | Operation failed |
WIFI_MANAGER_ERROR_ADDRESS_FAMILY_NOT_SUPPORTED | Address family not supported |
WIFI_MANAGER_ERROR_PERMISSION_DENIED | Permission Denied |
WIFI_MANAGER_ERROR_NOT_SUPPORTED | Not supported |
int wifi_manager_ap_set_ip_config_type | ( | wifi_manager_ap_h | ap, |
wifi_manager_address_family_e | address_family, | ||
wifi_manager_ip_config_type_e | type | ||
) |
Sets the config type of IP.
If you set IP config type to WIFI_MANAGER_IP_CONFIG_TYPE_STATIC, then IP address, Gateway and Subnet mask will be set to the initial value "0.0.0.0".
[in] | ap | The access point handle |
[in] | address_family | The address family |
[in] | type | The type of IP config |
WIFI_MANAGER_ERROR_NONE | Successful |
WIFI_MANAGER_ERROR_NOT_INITIALIZED | Not initialized |
WIFI_MANAGER_ERROR_INVALID_PARAMETER | Invalid parameter |
WIFI_MANAGER_ERROR_OPERATION_FAILED | Operation failed |
WIFI_MANAGER_ERROR_ADDRESS_FAMILY_NOT_SUPPORTED | Address family not supported |
WIFI_MANAGER_ERROR_PERMISSION_DENIED | Permission Denied |
WIFI_MANAGER_ERROR_NOT_SUPPORTED | Not supported |
int wifi_manager_ap_set_prefix_length | ( | wifi_manager_ap_h | ap, |
wifi_manager_address_family_e | address_family, | ||
int | prefix_len | ||
) |
Sets the network prefix length.
[in] | ap | The access point handle |
[in] | address_family | The address family |
[in] | prefix_len | The network prefix length. In case of IPv4, it means netmask length (also called a prefix, e.g. 8, 16, 24, 32) |
WIFI_MANAGER_ERROR_NONE | Successful |
WIFI_MANAGER_ERROR_NOT_INITIALIZED | Not initialized |
WIFI_MANAGER_ERROR_INVALID_PARAMETER | Invalid parameter |
WIFI_MANAGER_ERROR_NOT_SUPPORTED | Not supported |
int wifi_manager_ap_set_proxy_address | ( | wifi_manager_ap_h | ap, |
wifi_manager_address_family_e | address_family, | ||
const char * | proxy_address | ||
) |
Sets the proxy address.
[in] | ap | The access point handle |
[in] | address_family | The address family |
[in] | proxy_address | The proxy address If you set this value to NULL , then the existing value will be deleted. |
WIFI_MANAGER_ERROR_NONE | Successful |
WIFI_MANAGER_ERROR_NOT_INITIALIZED | Not initialized |
WIFI_MANAGER_ERROR_INVALID_PARAMETER | Invalid parameter |
WIFI_MANAGER_ERROR_OPERATION_FAILED | Operation failed |
WIFI_MANAGER_ERROR_ADDRESS_FAMILY_NOT_SUPPORTED | Address family not supported |
WIFI_MANAGER_ERROR_PERMISSION_DENIED | Permission Denied |
WIFI_MANAGER_ERROR_NOT_SUPPORTED | Not supported |
int wifi_manager_ap_set_proxy_type | ( | wifi_manager_ap_h | ap, |
wifi_manager_proxy_type_e | proxy_type | ||
) |
Sets the Proxy address.
If you set Proxy type to WIFI_MANAGER_PROXY_TYPE_AUTO or WIFI_MANAGER_PROXY_TYPE_MANUAL, then Proxy will be restored.
[in] | ap | The access point handle |
[in] | proxy_type | The type of proxy |
WIFI_MANAGER_ERROR_NONE | Successful |
WIFI_MANAGER_ERROR_NOT_INITIALIZED | Not initialized |
WIFI_MANAGER_ERROR_INVALID_PARAMETER | Invalid parameter |
WIFI_MANAGER_ERROR_OPERATION_FAILED | Operation failed |
WIFI_MANAGER_ERROR_PERMISSION_DENIED | Permission Denied |
WIFI_MANAGER_ERROR_NOT_SUPPORTED | Not supported |
int wifi_manager_ap_set_subnet_mask | ( | wifi_manager_ap_h | ap, |
wifi_manager_address_family_e | address_family, | ||
const char * | subnet_mask | ||
) |
Sets the subnet mask.
[in] | ap | The access point handle |
[in] | address_family | The address family |
[in] | subnet_mask | The subnet mask; if you set this value to NULL, then the existing value will be deleted |
WIFI_MANAGER_ERROR_NONE | Successful |
WIFI_MANAGER_ERROR_NOT_INITIALIZED | Not initialized |
WIFI_MANAGER_ERROR_INVALID_PARAMETER | Invalid parameter |
WIFI_MANAGER_ERROR_OPERATION_FAILED | Operation failed |
WIFI_MANAGER_ERROR_ADDRESS_FAMILY_NOT_SUPPORTED | Address family not supported |
WIFI_MANAGER_ERROR_PERMISSION_DENIED | Permission Denied |
WIFI_MANAGER_ERROR_NOT_SUPPORTED | Not supported |
int wifi_manager_foreach_found_bssid | ( | wifi_manager_ap_h | ap, |
wifi_manager_found_bssid_cb | callback, | ||
void * | user_data | ||
) |
Gets the BSSID list.
[in] | ap | The access point handle |
[in] | callback | The callback to be called |
[in] | user_data | The user data passed to the callback function |
WIFI_MANAGER_ERROR_NONE | Successful |
WIFI_MANAGER_ERROR_NOT_INITIALIZED | Not initialized |
WIFI_MANAGER_ERROR_INVALID_PARAMETER | Invalid parameter |
WIFI_MANAGER_ERROR_OPERATION_FAILED | Operation failed |
WIFI_MANAGER_ERROR_NOT_SUPPORTED | Not supported |