5.11.0.0R3
Software Development Kit
 
Loading...
Searching...
No Matches
Keep-Alive functions

Functions

wiced_result_t wiced_wifi_add_keep_alive (wiced_keep_alive_packet_t *keep_alive_packet_info)
 
wiced_result_t wiced_wifi_disable_keep_alive (uint8_t id)
 
wiced_result_t wiced_wifi_get_keep_alive (wiced_keep_alive_packet_t *keep_alive_packet_info)
 

Detailed Description

WICED WiFi functions for automatically sending regular keep alive packets

Function Documentation

◆ wiced_wifi_add_keep_alive()

wiced_result_t wiced_wifi_add_keep_alive ( wiced_keep_alive_packet_t * keep_alive_packet_info)
extern

Add a network keep alive packet

Keep alive functionality enables the WLAN chip to automatically send an arbitrary IP packet and/or 802.11 Null Function data frame at a regular interval

This feature may be used to maintain connectivity with a Wi-Fi AP and/or remote network application

A maximum of 4 keep alive packets can be configured to operate concurrently Keep alive packet functionality only works with client (STA) mode If the keep alive packet length is set to 0, a Null-Function Data frame is automatically used as the keep alive Any ethernet packet can be sent as a keep alive packet

Parameters
[in]keep_alive_packet_info: Pointer to a wiced_keep_alive_packet_t structure used to setup the keep alive packet
Returns
wiced_result_t

◆ wiced_wifi_disable_keep_alive()

wiced_result_t wiced_wifi_disable_keep_alive ( uint8_t id)
extern

Disable a keep alive packet specified by id

Parameters
[in]id: ID of the keep alive packet to be disabled
Returns
wiced_result_t

◆ wiced_wifi_get_keep_alive()

wiced_result_t wiced_wifi_get_keep_alive ( wiced_keep_alive_packet_t * keep_alive_packet_info)
extern

Get information about a keep alive packet

The ID of the keep alive packet should be provided in the keep_alive_info structure The application must pre-allocate a buffer to store the keep alive packet that is read from the WLAN chip The length of the buffer must be provided in the packet_length field of the structure The repeat period and keep alive packet bytes are populated by this function upon successful return

Parameters
[in,out]keep_alive_packet_info: Pointer to the wiced_keep_alive_t structure to be populated
Returns
wiced_result_t