Event flags management functions.
More...
Event flags management functions.
| wiced_event_flags_t* wiced_rtos_create_event_flags |
( |
void |
| ) |
|
Creates a new instance of event flags.
Creates a new event_flag (Allocates memory for a new event flags instance and returns the pointer)
- Returns
- valid pointer : on success.
-
NULL : if an error occurred
| wiced_result_t wiced_rtos_init_event_flags |
( |
wiced_event_flags_t * |
event_flags | ) |
|
Initialise an event flags.
- Parameters
-
| 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
-
| event_flags | : a pointer to the event flags handle |
| flags_to_set | : a 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
-
| event_flags | : a pointer to the event flags handle |
| flags_to_wait_for | : a group of event flags (ORed bit-fields) to wait for |
| flags_set | : event flag(s) set |
| clear_set_flags | : option to clear set flag(s) |
| wait_option | : wait option |
| timeout_ms | : timeout in milliseconds |
- Returns
- WICED_SUCCESS : on success.
-
WICED_ERROR : if an error occurred
