Mistake on this page?
Report an issue in GitHub or email us
Typedefs | Functions
WHD Event handling API

Functions that allow user applications to receive event callbacks and set event handlers. More...

Typedefs

typedef void *(* whd_event_handler_t) (whd_interface_t ifp, const whd_event_header_t *event_header, const uint8_t *event_data, void *handler_user_data)
 Event handler prototype definition. More...
 

Functions

uint32_t whd_wifi_set_event_handler (whd_interface_t ifp, const uint32_t *event_type, whd_event_handler_t handler_func, void *handler_user_data, uint16_t *event_index)
 Registers a handler to receive event callbacks. More...
 

Detailed Description

Functions that allow user applications to receive event callbacks and set event handlers.

Typedef Documentation

typedef void*(* whd_event_handler_t) (whd_interface_t ifp, const whd_event_header_t *event_header, const uint8_t *event_data, void *handler_user_data)

Event handler prototype definition.

Parameters
ifpPointer to handle instance of whd interface
event_headerwhd event header
event_dataevent data
handler_user_datasemaphore data

Definition at line 187 of file whd_events.h.

Function Documentation

uint32_t whd_wifi_set_event_handler ( whd_interface_t  ifp,
const uint32_t *  event_type,
whd_event_handler_t  handler_func,
void *  handler_user_data,
uint16_t *  event_index 
)

Registers a handler to receive event callbacks.

This function registers a callback handler to be notified when a particular event is received.

Note
Currently each event may only be registered to one handler and there is a limit to the number of simultaneously registered events. Maximum of 5 event handlers can registered simultaneously, this also includes the internal event handler registration which happens during scan, join and starting an AP.
Parameters
ifpPointer to handle instance of whd interface
event_typePointer to the event list array
handler_funcA function pointer to the handler callback
handler_user_dataA pointer value which will be passed to the event handler function at the time an event is triggered (NULL is allowed)
event_indexEntry where the event handler is registered in the list
Returns
WHD_SUCCESS or Error code
Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.