SimpleEventQueueBuffer Class Reference

In-memory event queue buffer. More...

#include <SimpleEventQueueBuffer.h>

Inheritance diagram for SimpleEventQueueBuffer:

Collaboration diagram for SimpleEventQueueBuffer:

Public Member Functions
	SimpleEventQueueBuffer ()
	SimpleEventQueueBuffer (SimpleEventQueueBuffer const &)=delete
	SimpleEventQueueBuffer (SimpleEventQueueBuffer &&)=delete
	~SimpleEventQueueBuffer () override
SimpleEventQueueBuffer &	operator= (SimpleEventQueueBuffer const &)=delete
SimpleEventQueueBuffer &	operator= (SimpleEventQueueBuffer &&)=delete
void	init () override
	Initialize.
void	waitForEvent (double timeout) override
	Block waiting for an event.
Type	getEvent (Event &event, uint32_t &dataID) override
	Get the next event.
bool	addEvent (uint32_t dataID) override
	Post an event.
bool	isEmpty () const override
	Check if event queue buffer is empty.
EventQueueTimer *	newTimer (double duration, bool oneShot) const override
	Create a timer object.
void	deleteTimer (EventQueueTimer *) const override
	Destroy a timer object.
Public Member Functions inherited from IEventQueueBuffer
virtual	~IEventQueueBuffer ()=default

Additional Inherited Members
Public Types inherited from IEventQueueBuffer
enum class	Type : uint8_t { Unknown , System , User }

Detailed Description

In-memory event queue buffer.

An event queue buffer provides a queue of events for an IEventQueue.

Constructor & Destructor Documentation

SimpleEventQueueBuffer() [1/3]

SimpleEventQueueBuffer::SimpleEventQueueBuffer

(

)

SimpleEventQueueBuffer() [2/3]

SimpleEventQueueBuffer::SimpleEventQueueBuffer ( SimpleEventQueueBuffer const & )

delete

SimpleEventQueueBuffer() [3/3]

SimpleEventQueueBuffer::SimpleEventQueueBuffer ( SimpleEventQueueBuffer && )

delete

~SimpleEventQueueBuffer()

SimpleEventQueueBuffer::~SimpleEventQueueBuffer ( )

override

Member Function Documentation

addEvent()

bool SimpleEventQueueBuffer::addEvent ( uint32_t dataID )

overridevirtual

Post an event.

Add the given event to the end of the queue buffer. This is a user event and getEvent() must be able to identify it as such and return dataID. This method must cause waitForEvent() to return at some future time if it's blocked waiting on an event.

Implements IEventQueueBuffer.

deleteTimer()

void SimpleEventQueueBuffer::deleteTimer ( EventQueueTimer * ) const

overridevirtual

Destroy a timer object.

Destroy a timer object previously returned by newTimer().

Implements IEventQueueBuffer.

getEvent()

IEventQueueBuffer::Type SimpleEventQueueBuffer::getEvent ( Event & event, uint32_t & dataID )

overridevirtual

Get the next event.

Get the next event from the buffer. Return None if no event is available. If a system event is next, return System and fill in event. The event data in a system event can point to a static buffer (because Event::deleteData() will not attempt to delete data in a System event). Otherwise, return User and fill in dataID with the value passed to addEvent().

Implements IEventQueueBuffer.

init()

void SimpleEventQueueBuffer::init ( )

inlineoverridevirtual

Initialize.

Useful for platform-specific initialisation from a specific thread.

Implements IEventQueueBuffer.

isEmpty()

bool SimpleEventQueueBuffer::isEmpty ( ) const

overridevirtual

Check if event queue buffer is empty.

Return true iff the event queue buffer is empty.

Implements IEventQueueBuffer.

newTimer()

EventQueueTimer * SimpleEventQueueBuffer::newTimer ( double duration, bool oneShot ) const

overridevirtual

Create a timer object.

Create and return a timer object. The object is opaque and is used only by the buffer but it must be a valid object (i.e. not nullptr).

Implements IEventQueueBuffer.

operator=() [1/2]

SimpleEventQueueBuffer & SimpleEventQueueBuffer::operator= ( SimpleEventQueueBuffer && )

delete

operator=() [2/2]

SimpleEventQueueBuffer & SimpleEventQueueBuffer::operator= ( SimpleEventQueueBuffer const & )

delete

waitForEvent()

void SimpleEventQueueBuffer::waitForEvent ( double timeout )

overridevirtual

Block waiting for an event.

Wait for an event in the event queue buffer for up to timeout seconds.

Implements IEventQueueBuffer.

---

The documentation for this class was generated from the following files:

• src/lib/base/SimpleEventQueueBuffer.h
• src/lib/base/SimpleEventQueueBuffer.cpp