Ok

Dependencies:   mbed_rtos_types Mutex mbed_rtos_storage mbed Semaphore

Embed: (wiki syntax)

« Back to documentation index

EventFlags Class Reference

EventFlags Class Reference
[EventFlags class]

The EventFlags class is used to control event flags or wait for event flags other threads control. More...

#include <EventFlags.h>

Inherits mbed::NonCopyable< EventFlags >.

Public Member Functions

 EventFlags ()
 Create and initialize an EventFlags object.
 EventFlags (const char *name)
 Create and initialize an 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 millisec=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 millisec=osWaitForever, bool clear=true)
 Wait for any of the specified event flags to become signaled.
 ~EventFlags ()
 EventFlags destructor.

Detailed Description

The EventFlags class is used to control event flags or wait for event flags other threads control.

Note:
EventFlags support 31 flags. The MSB flag is ignored. It is used to return an error code (osFlagsError).
Memory considerations: The EventFlags control structures will be created on the 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 49 of file EventFlags.h.


Constructor & Destructor Documentation

EventFlags (  )

Create and initialize an EventFlags object.

Note:
You cannot call this function from ISR context.
EventFlags ( const char *  name )

Create and initialize an EventFlags object.

Parameters:
namename to be used for this EventFlags. It has to stay allocated for the lifetime of the thread.
Note:
You cannot call this function from ISR context.
~EventFlags (  )

EventFlags destructor.

Note:
You cannot call this function from ISR context.

Member Function Documentation

uint32_t clear ( uint32_t  flags = 0x7fffffff )

Clear the specified event flags.

Parameters:
flagsthe flags that will be cleared (default: 0x7fffffff -- all flags).
Returns:
event flags before clearing or error code if highest bit set (see osFlagsError for details).
Note:
You may call this function from ISR context.
uint32_t get (  ) const

Get the currently set event flags.

Returns:
current event flags.
Note:
You may call this function from ISR context.
uint32_t set ( uint32_t  flags )

Set the specified event flags.

Parameters:
flagsthe flags that will be set.
Returns:
event flags after setting or error code if highest bit set (see osFlagsError for details).
Note:
This function may be called from ISR context.
uint32_t wait_all ( uint32_t  flags = 0,
uint32_t  millisec = osWaitForever,
bool  clear = true 
)

Wait for all of the specified event flags to become signaled.

Parameters:
flagsthe flags to wait for (default: 0 -- no flags).
millisectimeout value (default: osWaitForever).
clearclear specified event flags after waiting for them (default: true).
Returns:
event flags before clearing or error code if highest bit set (see osFlagsError for details).
Note:
You may call this function from ISR context if the millisec parameter is set to 0.
uint32_t wait_any ( uint32_t  flags = 0,
uint32_t  millisec = osWaitForever,
bool  clear = true 
)

Wait for any of the specified event flags to become signaled.

Parameters:
flagsthe flags to wait for (default: 0 -- no flags).
millisectimeout value (default: osWaitForever).
clearclear specified event flags after waiting for them (default: true).
Returns:
event flags before clearing or error code if highest bit set (see osFlagsError for details).
Note:
This function may be called from ISR context if the millisec parameter is set to 0.