5.11.0.0R3
Software Development Kit
 
Loading...
Searching...
No Matches
WiFi (Preferred Network Offload)

Functions

wiced_result_t wiced_wifi_pno_start (wiced_ssid_t *ssid, wiced_security_t security, wiced_scan_result_handler_t handler, void *user_data)
 
wiced_result_t wiced_wifi_pno_stop (void)
 
wiced_result_t wiced_wifi_register_pno_callback (wiced_scan_result_handler_t pno_handler, void *user_data)
 
wwd_result_t wwd_wifi_pno_add_network (wiced_ssid_t *ssid, wiced_security_t security)
 
wwd_result_t wwd_wifi_pno_clear (void)
 
wwd_result_t wwd_wifi_pno_start (void)
 
wwd_result_t wwd_wifi_pno_stop (void)
 

Detailed Description

WICED Wi-Fi functions for WLAN Preferred Network Offload

Preferred Network Offload functions (pno)

Wiced Wi-Fi Driver (WWD) functions for WLAN preferred Network Offload

Function Documentation

◆ wiced_wifi_pno_start()

wiced_result_t wiced_wifi_pno_start ( wiced_ssid_t * ssid,
wiced_security_t security,
wiced_scan_result_handler_t handler,
void * user_data )
extern

Preferred Network Offload start

Parameters
[in]wiced_ssid_t*:ssid
[in]wiced_security_t*: security
[in]wiced_scan_result_handler_t: A function to the event handler
[in]void*: user_data
Returns
wiced_result_t

◆ wiced_wifi_pno_stop()

wiced_result_t wiced_wifi_pno_stop ( void )
extern

Preferred Network Offload stop Halts the preferred network offload scanning process and clears all state associated with it

Returns
wiced_result_t

◆ wiced_wifi_register_pno_callback()

wiced_result_t wiced_wifi_register_pno_callback ( wiced_scan_result_handler_t pno_handler,
void * user_data )
extern

Preferred Network register callback function

Parameters
[in]wiced_scan_result_handler_t: pno_handler
[in]void*: user_data
Returns
wiced_result_t

◆ wwd_wifi_pno_add_network()

wwd_result_t wwd_wifi_pno_add_network ( wiced_ssid_t * ssid,
wiced_security_t security )

Add another preferred network to be searched for in the background. Adds are cumulative and can be called one after another.

Parameters
[in]ssidssid of the network
[in]securitysecurity settings for the preferred network
Returns
WWD_SUCCESS or error; pno will always be left in a stopped state after calling this API; use wwd_wifi_pno_start to get pno process started again.

◆ wwd_wifi_pno_clear()

wwd_result_t wwd_wifi_pno_clear ( void )

clear added networks and disable pno scanning

Parameters
[in]voidNo parameters needed.
Returns
WWD_SUCCESS or Error code

◆ wwd_wifi_pno_start()

wwd_result_t wwd_wifi_pno_start ( void )

enable pno scan process now; use previously added networks

Parameters
[in]voidNo parameters needed.
Returns
WWD_SUCCESS or Error code

◆ wwd_wifi_pno_stop()

wwd_result_t wwd_wifi_pno_stop ( void )

disable pno scan process now; do not clear previously added networks

Parameters
[in]voidNo parameters needed.
Returns
WWD_SUCCESS or Error code