corium::BlockingQueuePolicy< EventVariant > Class Template Reference

Queue Policy for a traditional mutex-protected blocking queue (power saving). More...

#include <QueuePolicies.hpp>

Collaboration diagram for corium::BlockingQueuePolicy< EventVariant >:

Classes
struct	PushResult

Public Types
using	EventType = EventVariant

Public Member Functions
bool	empty () const
	Check if queue is empty.
bool	tryPop (EventVariant &event)
	Try to pop an event from the blocking queue.
PushResult	tryPush (EventVariant event, EventPriority priority=EventPriority::Normal)
	Try to push an event into the blocking queue.

Detailed Description

template<typename EventVariant = DefaultEvents>
class corium::BlockingQueuePolicy< EventVariant >

Queue Policy for a traditional mutex-protected blocking queue (power saving).

Template Parameters

EventVariant

The variant type list of supported events.

Member Typedef Documentation

EventType

template<typename EventVariant = DefaultEvents>

using corium::BlockingQueuePolicy< EventVariant >::EventType = EventVariant

Member Function Documentation

empty()

template<typename EventVariant = DefaultEvents>

bool corium::BlockingQueuePolicy< EventVariant >::empty ( ) const

inline

Check if queue is empty.

tryPop()

template<typename EventVariant = DefaultEvents>

bool corium::BlockingQueuePolicy< EventVariant >::tryPop ( EventVariant &  event )

inline

Try to pop an event from the blocking queue.

tryPush()

template<typename EventVariant = DefaultEvents>

PushResult corium::BlockingQueuePolicy< EventVariant >::tryPush ( EventVariant  event, EventPriority  priority = EventPriority::Normal  )

inline

Try to push an event into the blocking queue.

---

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

• include/corium/policies/QueuePolicies.hpp