Defines a group of APIs to expose the event flags RTOS functionality.
More...
Defines a group of APIs to expose the event flags RTOS functionality.
| wiced_event_flags_t* wiced_rtos_create_event_flags |
( |
void |
| ) |
|
Allocates memory for a new event flags instance and returns the pointer.
- Parameters
-
- Returns
- NULL an error occurred and the instance was not allocated, do not init
- valid pointer to event flags instance, which can now we initialized
| wiced_result_t wiced_rtos_init_event_flags |
( |
wiced_event_flags_t * |
event_flags | ) |
|
Initializes the event flags instance (malloc'd by wiced_rtos_create_event_flags)
- Parameters
-
| [in] | event_flags | a pointer to the event flags handle |
- Returns
- WICED_SUCCESS
- WICED_ERROR
| wiced_result_t wiced_rtos_set_event_flags |
( |
wiced_event_flags_t * |
event_flags, |
|
|
uint32_t |
flags_to_set |
|
) |
| |
Set the event flags in logical OR operation.
- Parameters
-
| [in] | event_flags | a pointer to the event flags handle |
| [in] | flags_to_set | a group of event flags (ORed bit-fields) to set |
- Returns
- WICED_SUCCESS
- WICED_ERROR
| 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 |
|
) |
| |
Blocking wait for specific bit patter of event flags to be set elsewhere.
- Parameters
-
| [in] | event_flags | a pointer to the event flags handle |
| [in] | flags_to_wait_for | bit pattern of event flags to wait for |
| [in] | flags_set | event flag(s) set |
| [in] | clear_set_flags | option to clear set flag(s) |
| [in] | wait_option | WAIT_FOR_ANY_EVENT or WAIT_FOR_ALL_EVENTS |
| [in] | timeout_ms | milliseconds to block |
- Returns
- WICED_SUCCESS
- WICED_ERROR
