Kenji Arai / mbed-os_TYBLE16

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

Embed: (wiki syntax)

« Back to documentation index

EventFlags Class Reference
Public Member Functions | Private Member Functions

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 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.

Private Member Functions

 MBED_DEPRECATED ("Invalid copy construction of a NonCopyable resource.") NonCopyable(const NonCopyable &)
 NonCopyable copy constructor.
 MBED_DEPRECATED ("Invalid copy assignment of a NonCopyable resource.") NonCopyable &operator
 NonCopyable copy assignment operator.

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 51 of file EventFlags.h.

Constructor & Destructor Documentation

EventFlags (  )

Create and initialize an EventFlags object.

Note:
You cannot call this function from ISR context.

Definition at line 31 of file EventFlags.cpp.

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.

Definition at line 36 of file EventFlags.cpp.

~EventFlags (  )

EventFlags destructor.

Note:
You cannot call this function from ISR context.

Definition at line 92 of file EventFlags.cpp.

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.

Definition at line 64 of file EventFlags.cpp.

uint32_t get (  ) const

Get the currently set event flags.

Returns:
current event flags.
Note:
You may call this function from ISR context.

Definition at line 73 of file EventFlags.cpp.

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.

Definition at line 55 of file EventFlags.cpp.

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.

Definition at line 82 of file EventFlags.cpp.

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.

Definition at line 87 of file EventFlags.cpp.

Generated on Tue Jul 12 2022 13:55:44 by  doxygen 1.7.2