Events

RTOS events functions. More...

Functions

zos_result_t zn_rtos_event_flags_init (zos_event_flags_t *event_flags)
 Initialize an event flags. More...
 
zos_result_t zn_rtos_event_flags_wait_for_any (zos_event_flags_t *event_flags, uint32_t flags_to_wait_for, uint32_t *flags_set, uint32_t timeout_ms)
 Wait for event flags to be set. More...
 
zos_result_t zn_rtos_event_flags_wait_for_all (zos_event_flags_t *event_flags, uint32_t flags_to_wait_for, uint32_t *flags_set, uint32_t timeout_ms)
 Wait for event flags to be set. More...
 
zos_result_t zn_rtos_event_flags_set (zos_event_flags_t *event_flags, uint32_t flags_to_set)
 Set event flags. More...
 
zos_result_t zn_rtos_event_flags_deinit (zos_event_flags_t *event_flags)
 De-initialise an event flags. More...
 

Detailed Description

RTOS events functions.

Function Documentation

zos_result_t zn_rtos_event_flags_deinit ( zos_event_flags_t *  event_flags)

De-initialise an event flags.

Parameters
event_flags: a pointer to the event flags handle
Returns
ZOS_SUCCESS : on success.
ZOS_ERROR : if an error occurred
zos_result_t zn_rtos_event_flags_init ( zos_event_flags_t *  event_flags)

Initialize an event flags.

Parameters
event_flags: a pointer to the event flags handle
Returns
ZOS_SUCCESS : on success.
ZOS_ERROR : if an error occurred
zos_result_t zn_rtos_event_flags_set ( zos_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
ZOS_SUCCESS : on success.
ZOS_ERROR : if an error occurred
zos_result_t zn_rtos_event_flags_wait_for_all ( zos_event_flags_t *  event_flags,
uint32_t  flags_to_wait_for,
uint32_t *  flags_set,
uint32_t  timeout_ms 
)

Wait for event flags to be set.

Parameters
event_flags
flags_to_wait_for
flags_set
timeout_ms
Returns
zos_result_t zn_rtos_event_flags_wait_for_any ( zos_event_flags_t *  event_flags,
uint32_t  flags_to_wait_for,
uint32_t *  flags_set,
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
timeout_ms: timeout in milliseconds
Returns
ZOS_SUCCESS : on success.
ZOS_ERROR : if an error occurred