Lee Shen / FTHR_USB_serial_qSPI
Embed: (wiki syntax)

« Back to documentation index

EventFlags Class Reference

EventFlags Class Reference
[Rtos]

The EventFlags class is used to signal or wait for an arbitrary event or events. More...

#include <EventFlags.h>

Inherits NonCopyable< EventFlags >.

Public Member Functions

 EventFlags ()
 Create and Initialize a EventFlags object.
 EventFlags (const char *name)
 Create and Initialize a EventFlags object.
uint32_t set (uint32_t flags)
 Set the specified Event Flags.
uint32_t clear (uint32_t flags=0x7fffffff)
 Clear the specified Event Flags.
uint32_t get () const
 Get the currently set Event Flags.
uint32_t wait_all (uint32_t flags=0, uint32_t timeout=osWaitForever, bool clear=true)
 Wait for all of the specified event flags to become signaled.
uint32_t wait_any (uint32_t flags=0, uint32_t timeout=osWaitForever, bool clear=true)
 Wait for any of the specified event flags to become signaled.

Detailed Description

The EventFlags class is used to signal or wait for an arbitrary event or events.

Note:
EventFlags support 31 flags so the MSB flag is ignored, it is used to return an error code (osFlagsError)
Memory considerations: The EventFlags control structures will be created on current thread's stack, both for the mbed OS and underlying RTOS objects (static or dynamic RTOS memory pools are not being used).

Definition at line 43 of file EventFlags.h.


Constructor & Destructor Documentation

EventFlags (  )

Create and Initialize a EventFlags object.

Definition at line 29 of file EventFlags.cpp.