5.13.0.0R1
Software Development Kit
Event Flags

Functions

wiced_result_t wiced_rtos_deinit_event_flags (wiced_event_flags_t *event_flags)
 
wiced_result_t wiced_rtos_init_event_flags (wiced_event_flags_t *event_flags)
 
wiced_result_t wiced_rtos_set_event_flags (wiced_event_flags_t *event_flags, uint32_t flags_to_set)
 
wiced_result_t wiced_rtos_wait_for_event_flags (wiced_event_flags_t *event_flags, uint32_t flags_to_wait_for, uint32_t *flags_set, wiced_bool_t clear_set_flags, wiced_event_flags_wait_option_t wait_option, uint32_t timeout_ms)
 

Detailed Description

Event flags management functions

Function Documentation

wiced_result_t wiced_rtos_deinit_event_flags ( wiced_event_flags_t *  event_flags)

De-initialize an event flags

Parameters
[in]event_flags: Pointer to the event flags handle
Returns
WICED_SUCCESS : on success.
WICED_ERROR : if an error occurred
wiced_result_t wiced_rtos_init_event_flags ( wiced_event_flags_t *  event_flags)

Initialize an event flags

Parameters
[in]event_flags: A pointer to the event flags handle
Returns
WICED_SUCCESS : on success.
WICED_ERROR : if an error occurred
wiced_result_t wiced_rtos_set_event_flags ( wiced_event_flags_t *  event_flags,
uint32_t  flags_to_set 
)

Set event flags

Parameters
[in]event_flags: Pointer to the event flags handle
[in]flags_to_set: Group of event flags (ORed bit-fields) to set
Returns
WICED_SUCCESS : on success.
WICED_ERROR : if an error occurred
wiced_result_t wiced_rtos_wait_for_event_flags ( wiced_event_flags_t *  event_flags,
uint32_t  flags_to_wait_for,
uint32_t *  flags_set,
wiced_bool_t  clear_set_flags,
wiced_event_flags_wait_option_t  wait_option,
uint32_t  timeout_ms 
)

Wait for event flags to be set

Parameters
[in]event_flags: Pointer to the event flags handle
[in]flags_to_wait_for: Group of event flags (ORed bit-fields) to wait for
[out]flags_set: Event flag(s) set
[in]clear_set_flags: TRUE to clear set flag, FALSE leaves flags unchanged.
[in]wait_option: Wait option
[in]timeout_ms: Timeout in milliseconds
Returns
WICED_SUCCESS : on success.
WICED_ERROR : if an error occurred