Tizen Native API  4.0
Wi-Fi Monitor

The Wi-Fi API provides functions for monitoring the state of Wi-Fi.

Required Header

#include <wifi-manager.h>

Overview

The Wi-Fi Monitor allows monitoring the changes of Wi-Fi.

Related Features

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_get_connection_state (wifi_manager_h wifi, wifi_manager_connection_state_e *connection_state)
 Gets the connection state.
int wifi_manager_set_device_state_changed_cb (wifi_manager_h wifi, wifi_manager_device_state_changed_cb callback, void *user_data)
 Registers the callback called when the device state is changed.
int wifi_manager_unset_device_state_changed_cb (wifi_manager_h wifi)
 Unregisters the callback called when the device state is changed.
int wifi_manager_set_background_scan_cb (wifi_manager_h wifi, wifi_manager_scan_finished_cb callback, void *user_data)
 Registers the callback called when the background scan is finished.
int wifi_manager_unset_background_scan_cb (wifi_manager_h wifi)
 Unregisters the callback called when the scan is finished.
int wifi_manager_set_scan_state_changed_cb (wifi_manager_h wifi, wifi_manager_scan_state_changed_cb callback, void *user_data)
 Registers the callback called when the scanning state is changed.
int wifi_manager_unset_scan_state_changed_cb (wifi_manager_h wifi)
 Unregisters the callback called when the scanning state is changed.
int wifi_manager_set_connection_state_changed_cb (wifi_manager_h wifi, wifi_manager_connection_state_changed_cb callback, void *user_data)
 Registers the callback called when the connection state is changed.
int wifi_manager_unset_connection_state_changed_cb (wifi_manager_h wifi)
 Unregisters the callback called when the connection state is changed.
int wifi_manager_set_rssi_level_changed_cb (wifi_manager_h wifi, wifi_manager_rssi_level_changed_cb callback, void *user_data)
 Registers callback called when the RSSI of connected Wi-Fi is changed.
int wifi_manager_unset_rssi_level_changed_cb (wifi_manager_h wifi)
 Unregisters callback called when the RSSI of connected Wi-Fi is changed.
int wifi_manager_set_module_state_changed_cb (wifi_manager_h wifi, wifi_manager_module_state_changed_cb callback, void *user_data)
 Registers a callback called when the Wi-Fi Module state is changed.
int wifi_manager_unset_module_state_changed_cb (wifi_manager_h wifi)
 Unregisters the callback called when the Wi-Fi Module state is changed.
int wifi_manager_get_module_state (wifi_manager_h wifi, wifi_manager_module_state_e *state)
 Gets the Wi-Fi Module state.
int wifi_manager_bssid_scan (wifi_manager_h wifi, wifi_manager_bssid_scan_finished_cb callback, void *user_data)
 Starts BSSID scan asynchronously.

Typedefs

typedef void(* wifi_manager_device_state_changed_cb )(wifi_manager_device_state_e state, void *user_data)
 Called when the device state is changed.
typedef void(* wifi_manager_connection_state_changed_cb )(wifi_manager_connection_state_e state, wifi_manager_ap_h ap, void *user_data)
 Called when the connection state is changed.
typedef void(* wifi_manager_ip_conflict_cb )(char *mac, wifi_manager_ip_conflict_state_e state, void *user_data)
 Called when the IP conflict state is changed.
typedef void(* wifi_manager_rssi_level_changed_cb )(wifi_manager_rssi_level_e rssi_level, void *user_data)
 Called when the RSSI of connected Wi-Fi is changed.
typedef void(* wifi_manager_module_state_changed_cb )(wifi_manager_module_state_e wifi_module_state, void *user_data)
 Called when the Wi-Fi Module state is changed.

Typedef Documentation

Called when the connection state is changed.

Since :
3.0
Parameters:
[in]stateThe connection state
[in]apThe access point
[in]user_dataThe user data passed from the callback registration function
See also:
wifi_manager_set_connection_state_changed_cb()
wifi_manager_unset_connection_state_changed_cb()
typedef void(* wifi_manager_device_state_changed_cb)(wifi_manager_device_state_e state, void *user_data)

Called when the device state is changed.

Since :
3.0
Parameters:
[in]stateThe device state
[in]user_dataThe user data passed from the callback registration function
See also:
wifi_manager_set_device_state_changed_cb()
wifi_manager_unset_device_state_changed_cb()
typedef void(* wifi_manager_ip_conflict_cb)(char *mac, wifi_manager_ip_conflict_state_e state, void *user_data)

Called when the IP conflict state is changed.

Since :
5.0
Remarks:
mac should not be freed. mac is available only in the callback. To use outside the callback, make a copy.
Parameters:
[in]macThe destination MAC address causing conflict
[in]stateThe current state
[in]user_dataThe user data passed from the callback registration function
See also:
wifi_manager_set_ip_conflict_cb()
wifi_manager_unset_ip_conflict_cb()
typedef void(* wifi_manager_module_state_changed_cb)(wifi_manager_module_state_e wifi_module_state, void *user_data)

Called when the Wi-Fi Module state is changed.

Since :
4.0
Parameters:
[in]wifi_module_stateThe Wi-Fi Module state
[in]user_dataThe user data passed from the callback registration function
See also:
wifi_manager_set_module_state_changed_cb()
wifi_manager_unset_module_state_changed_cb()
typedef void(* wifi_manager_rssi_level_changed_cb)(wifi_manager_rssi_level_e rssi_level, void *user_data)

Called when the RSSI of connected Wi-Fi is changed.

Since :
3.0
Parameters:
[in]rssi_levelThe level of RSSI
[in]user_dataThe user data passed from the callback registration function
See also:
wifi_manager_set_rssi_level_changed_cb()
wifi_manager_unset_rssi_level_changed_cb()

Enumeration Type Documentation

Enumeration for the state of the Wi-Fi connection.

Since :
3.0
Enumerator:
WIFI_MANAGER_CONNECTION_STATE_FAILURE 

Connection failed state

WIFI_MANAGER_CONNECTION_STATE_DISCONNECTED 

Disconnected state

WIFI_MANAGER_CONNECTION_STATE_ASSOCIATION 

Association state

WIFI_MANAGER_CONNECTION_STATE_CONFIGURATION 

Configuration state

WIFI_MANAGER_CONNECTION_STATE_CONNECTED 

Connected state

Enumeration for the state of the Wi-Fi device.

Since :
3.0
Enumerator:
WIFI_MANAGER_DEVICE_STATE_DEACTIVATED 

Wi-Fi is Deactivated

WIFI_MANAGER_DEVICE_STATE_ACTIVATED 

Wi-Fi is activated

Enumeration for the state of the static IP conflict.

Since :
5.0
Enumerator:
WIFI_MANAGER_IP_CONFLICT_STATE_UNKNOWN 

Unknown state

WIFI_MANAGER_IP_CONFLICT_STATE_CONFLICT_NOT_DETECTED 

Resolved state

WIFI_MANAGER_IP_CONFLICT_STATE_CONFLICT_DETECTED 

Conflict state

Enumeration for the Wi-Fi Module state.

Since :
4.0
Enumerator:
WIFI_MANAGER_MODULE_STATE_DETACHED 

Wi-Fi Module is detached

WIFI_MANAGER_MODULE_STATE_ATTACHED 

Wi-Fi Module is attached

Enumeration for the RSSI level.

Since :
3.0
Enumerator:
WIFI_MANAGER_RSSI_LEVEL_0 

No signal

WIFI_MANAGER_RSSI_LEVEL_1 

Very weak signal ~ -83dBm

WIFI_MANAGER_RSSI_LEVEL_2 

Weak signal -82 ~ -75dBm

WIFI_MANAGER_RSSI_LEVEL_3 

Strong signal -74 ~ -64dBm

WIFI_MANAGER_RSSI_LEVEL_4 

Very strong signal -63dBm ~

Enumeration for the wifi scanning state.

Since :
4.0
Enumerator:
WIFI_MANAGER_SCAN_STATE_NOT_SCANNING 

Scan is not running

WIFI_MANAGER_SCAN_STATE_SCANNING 

Scan is in progress

Enumeration for the TDLS Discovery State.

Since :
4.0
Enumerator:
WIFI_MANAGER_TDLS_DISCOVERY_STATE_ONGOING 

Discovery is in progress

WIFI_MANAGER_TDLS_DISCOVERY_STATE_FINISHED 

Discovery is finished


Function Documentation

int wifi_manager_bssid_scan ( wifi_manager_h  wifi,
wifi_manager_bssid_scan_finished_cb  callback,
void *  user_data 
)

Starts BSSID scan asynchronously.

Since :
4.0
Privilege Level:
public
Privilege:
http://tizen.org/privilege/network.set
http://tizen.org/privilege/network.get
Remarks:
This function needs both privileges.
Parameters:
[in]wifiThe Wi-Fi handle
[in]callbackThe callback function to be called
[in]user_dataThe user data passed to the callback function
Returns:
0 on success, otherwise negative error value
Return values:
WIFI_MANAGER_ERROR_NONESuccessful
WIFI_MANAGER_ERROR_INVALID_PARAMETERInvalid parameter
WIFI_MANAGER_ERROR_INVALID_OPERATIONInvalid operation
WIFI_MANAGER_ERROR_OPERATION_FAILEDOperation failed
WIFI_MANAGER_ERROR_PERMISSION_DENIEDPermission Denied
WIFI_MANAGER_ERROR_NOT_SUPPORTEDNot supported
Postcondition:
This function invokes wifi_manager_bssid_scan_finished_cb().

Gets the connection state.

Since :
3.0
Privilege Level:
public
Privilege:
http://tizen.org/privilege/network.get
Parameters:
[in]wifiThe Wi-Fi handle
[out]connection_stateThe connection state
Returns:
0 on success, otherwise negative error value
Return values:
WIFI_MANAGER_ERROR_NONESuccessful
WIFI_MANAGER_ERROR_INVALID_PARAMETERInvalid parameter
WIFI_MANAGER_ERROR_OPERATION_FAILEDOperation failed
WIFI_MANAGER_ERROR_PERMISSION_DENIEDPermission Denied
WIFI_MANAGER_ERROR_NOT_SUPPORTEDNot supported

Gets the Wi-Fi Module state.

Since :
4.0
Parameters:
[in]wifiThe Wi-Fi handle
[out]stateThe Wi-Fi Module state
Returns:
0 on success, otherwise negative error value
Return values:
WIFI_MANAGER_ERROR_NONESuccessful
WIFI_MANAGER_ERROR_INVALID_OPERATIONInvalid operation
WIFI_MANAGER_ERROR_INVALID_PARAMETERInvalid parameter
WIFI_MANAGER_ERROR_OPERATION_FAILEDOperation failed
WIFI_MANAGER_ERROR_NOT_SUPPORTEDNot supported
int wifi_manager_set_background_scan_cb ( wifi_manager_h  wifi,
wifi_manager_scan_finished_cb  callback,
void *  user_data 
)

Registers the callback called when the background scan is finished.

Since :
3.0
Parameters:
[in]wifiThe Wi-Fi handle
[in]callbackThe callback function to be called
[in]user_dataThe user data passed to the callback function
Returns:
0 on success, otherwise negative error value
Return values:
WIFI_MANAGER_ERROR_NONESuccessful
WIFI_MANAGER_ERROR_INVALID_OPERATIONInvalid operation
WIFI_MANAGER_ERROR_INVALID_PARAMETERInvalid parameter
WIFI_MANAGER_ERROR_NOT_SUPPORTEDNot supported

Registers the callback called when the connection state is changed.

Since :
3.0
Parameters:
[in]wifiThe Wi-Fi handle
[in]callbackThe callback function to be called
[in]user_dataThe user data passed to the callback function
Returns:
0 on success, otherwise negative error value
Return values:
WIFI_MANAGER_ERROR_NONESuccessful
WIFI_MANAGER_ERROR_INVALID_OPERATIONInvalid operation
WIFI_MANAGER_ERROR_INVALID_PARAMETERInvalid parameter
WIFI_MANAGER_ERROR_NOT_SUPPORTEDNot supported

Registers the callback called when the device state is changed.

Since :
3.0
Parameters:
[in]wifiThe Wi-Fi handle
[in]callbackThe callback function to be called
[in]user_dataThe user data passed to the callback function
Returns:
0 on success, otherwise negative error value
Return values:
WIFI_MANAGER_ERROR_NONESuccessful
WIFI_MANAGER_ERROR_INVALID_OPERATIONInvalid operation
WIFI_MANAGER_ERROR_INVALID_PARAMETERInvalid parameter
WIFI_MANAGER_ERROR_NOT_SUPPORTEDNot supported

Registers a callback called when the Wi-Fi Module state is changed.

Since :
4.0
Parameters:
[in]wifiThe Wi-Fi handle
[in]callbackThe callback function to be called
[in]user_dataThe user data passed to the callback function
Returns:
0 on success, otherwise negative error value
Return values:
WIFI_MANAGER_ERROR_NONESuccessful
WIFI_MANAGER_ERROR_INVALID_OPERATIONInvalid operation
WIFI_MANAGER_ERROR_INVALID_PARAMETERInvalid parameter
WIFI_MANAGER_ERROR_OPERATION_FAILEDOperation failed
WIFI_MANAGER_ERROR_NOT_SUPPORTEDNot supported
See also:
wifi_manager_module_state_changed_cb()
wifi_manager_unset_module_state_changed_cb()

Registers callback called when the RSSI of connected Wi-Fi is changed.

Since :
3.0
Parameters:
[in]wifiThe Wi-Fi handle
[in]callbackThe callback function to be called
[in]user_dataThe user data passed to the callback function
Returns:
0 on success, otherwise negative error value
Return values:
WIFI_MANAGER_ERROR_NONESuccessful
WIFI_MANAGER_ERROR_INVALID_OPERATIONInvalid operation
WIFI_MANAGER_ERROR_INVALID_PARAMETERInvalid parameter
WIFI_MANAGER_ERROR_NOT_SUPPORTEDNot supported

Registers the callback called when the scanning state is changed.

Since :
4.0
Parameters:
[in]wifiThe Wi-Fi handle
[in]callbackThe callback function to be called
[in]user_dataThe user data passed to the callback function
Returns:
0 on success, otherwise negative error value
Return values:
WIFI_MANAGER_ERROR_NONESuccessful
WIFI_MANAGER_ERROR_INVALID_OPERATIONInvalid operation
WIFI_MANAGER_ERROR_INVALID_PARAMETERInvalid parameter
WIFI_MANAGER_ERROR_NOT_SUPPORTEDNot supported

Unregisters the callback called when the scan is finished.

Since :
3.0
Parameters:
[in]wifiThe Wi-Fi handle
Returns:
0 on success, otherwise negative error value
Return values:
WIFI_MANAGER_ERROR_NONESuccessful
WIFI_MANAGER_ERROR_INVALID_PARAMETERInvalid parameter
WIFI_MANAGER_ERROR_INVALID_OPERATIONInvalid operation
WIFI_MANAGER_ERROR_NOT_SUPPORTEDNot supported

Unregisters the callback called when the connection state is changed.

Since :
3.0
Parameters:
[in]wifiThe Wi-Fi handle
Returns:
0 on success, otherwise negative error value
Return values:
WIFI_MANAGER_ERROR_NONESuccessful
WIFI_MANAGER_ERROR_INVALID_PARAMETERInvalid parameter
WIFI_MANAGER_ERROR_INVALID_OPERATIONInvalid operation
WIFI_MANAGER_ERROR_NOT_SUPPORTEDNot supported

Unregisters the callback called when the device state is changed.

Since :
3.0
Parameters:
[in]wifiThe Wi-Fi handle
Returns:
0 on success, otherwise negative error value
Return values:
WIFI_MANAGER_ERROR_NONESuccessful
WIFI_MANAGER_ERROR_INVALID_PARAMETERInvalid parameter
WIFI_MANAGER_ERROR_INVALID_OPERATIONInvalid operation
WIFI_MANAGER_ERROR_NOT_SUPPORTEDNot supported

Unregisters the callback called when the Wi-Fi Module state is changed.

Since :
4.0
Parameters:
[in]wifiThe Wi-Fi handle
Returns:
0 on success, otherwise negative error value
Return values:
WIFI_MANAGER_ERROR_NONESuccessful
WIFI_MANAGER_ERROR_INVALID_OPERATIONInvalid operation
WIFI_MANAGER_ERROR_INVALID_PARAMETERInvalid parameter
WIFI_MANAGER_ERROR_OPERATION_FAILEDOperation failed
WIFI_MANAGER_ERROR_NOT_SUPPORTEDNot supported
See also:
wifi_manager_module_state_changed_cb()
wifi_manager_set_module_state_changed_cb()

Unregisters callback called when the RSSI of connected Wi-Fi is changed.

Since :
3.0
Parameters:
[in]wifiThe Wi-Fi handle
Returns:
0 on success, otherwise negative error value
Return values:
WIFI_MANAGER_ERROR_NONESuccessful
WIFI_MANAGER_ERROR_INVALID_PARAMETERInvalid parameter
WIFI_MANAGER_ERROR_INVALID_OPERATIONInvalid operation
WIFI_MANAGER_ERROR_NOT_SUPPORTEDNot supported

Unregisters the callback called when the scanning state is changed.

Since :
4.0
Parameters:
[in]wifiThe Wi-Fi handle
Returns:
0 on success, otherwise negative error value
Return values:
WIFI_MANAGER_ERROR_NONESuccessful
WIFI_MANAGER_ERROR_INVALID_PARAMETERInvalid parameter
WIFI_MANAGER_ERROR_INVALID_OPERATIONInvalid operation
WIFI_MANAGER_ERROR_NOT_SUPPORTEDNot supported