Embed: (wiki syntax)

« Back to documentation index

EventQueue Struct Reference

EventQueue Struct Reference

Simple interface which allow upper layer to post an event into the event mechanism of the abstracted stack. More...

#include <EventQueue.h>

Inherited by SimpleEventQueue.

Public Member Functions

 EventQueue ()
 Base constructor of an event queue.
 ~EventQueue ()
 Destructor, needs to be overiden in implementation.
virtual bool post (const mbed::Callback< void()> &event)=0
 Post an event into the event queue.

Detailed Description

Simple interface which allow upper layer to post an event into the event mechanism of the abstracted stack.

When an event is posted then it's availability shall be signaled to the upper layer in order to inform the upper layer that events are ready to be processed.

Implementation can realize that operation by calling the function signalEventsToProcess of their implementation of BLEInstanceBase.

Events in the queue shall be processed at the next invocation of BLEInstanceBase::processEvents.

Definition at line 39 of file features/FEATURE_BLE/ble/pal/EventQueue.h.


Constructor & Destructor Documentation

EventQueue (  )

Base constructor of an event queue.

Definition at line 43 of file features/FEATURE_BLE/ble/pal/EventQueue.h.

~EventQueue (  )

Destructor, needs to be overiden in implementation.

Definition at line 48 of file features/FEATURE_BLE/ble/pal/EventQueue.h.


Member Function Documentation

virtual bool post ( const mbed::Callback< void()> &  event ) [pure virtual]

Post an event into the event queue.

Parameters:
eventThe event to store in the queue, it shall be processed at the next invocation of BLE::processEvent.
Returns:
true in case of success and false otherwise
Attention:
Event availability shall be signaled to the upper layer and the event queue shall be processed at the next invocation of BLEInstanceBase::process

Implemented in SimpleEventQueue.