i6engine  1.0
i6e::utils::DoubleBufferQueue< T, producer, consumer > Class Template Reference

#include <D:/Projekte/i6engine/libs/i6engine-utils/include/i6engine/utils/DoubleBufferQueue.h>

Public Member Functions

 DoubleBufferQueue ()
 default constructor More...
 
void push (const T &value)
 pushes the given value into the queue More...
 
void pop ()
 removes first entry of the queue More...
 
front ()
 returns first entry of the queue More...
 
poll ()
 removes first entry of the queue and returns its value More...
 
bool empty () const
 returns true if the queue is empty, otherwise false More...
 
size_t size () const
 returns size of the queue More...
 
void clear ()
 removes all elements in the queue More...
 

Detailed Description

template<typename T, bool producer = true, bool consumer = true>
class i6e::utils::DoubleBufferQueue< T, producer, consumer >

class DoubleBufferQueue

T defines the data type being contained in the queue producer tells whether more than one thread pushes data into the queue consumer tells whether more than one thread pulls data from the queue

Definition at line 45 of file DoubleBufferQueue.h.

Constructor & Destructor Documentation

template<typename T, bool producer = true, bool consumer = true>
i6e::utils::DoubleBufferQueue< T, producer, consumer >::DoubleBufferQueue ( )
inline

default constructor

Definition at line 58 of file DoubleBufferQueue.h.

Member Function Documentation

template<typename T, bool producer = true, bool consumer = true>
void i6e::utils::DoubleBufferQueue< T, producer, consumer >::clear ( )
inline

removes all elements in the queue

Definition at line 107 of file DoubleBufferQueue.h.

template<typename T, bool producer = true, bool consumer = true>
bool i6e::utils::DoubleBufferQueue< T, producer, consumer >::empty ( ) const
inline

returns true if the queue is empty, otherwise false

Definition at line 93 of file DoubleBufferQueue.h.

template<typename T, bool producer = true, bool consumer = true>
T i6e::utils::DoubleBufferQueue< T, producer, consumer >::front ( )
inline

returns first entry of the queue

Definition at line 79 of file DoubleBufferQueue.h.

template<typename T, bool producer = true, bool consumer = true>
T i6e::utils::DoubleBufferQueue< T, producer, consumer >::poll ( )
inline

removes first entry of the queue and returns its value

Definition at line 86 of file DoubleBufferQueue.h.

template<typename T, bool producer = true, bool consumer = true>
void i6e::utils::DoubleBufferQueue< T, producer, consumer >::pop ( )
inline

removes first entry of the queue

Definition at line 72 of file DoubleBufferQueue.h.

template<typename T, bool producer = true, bool consumer = true>
void i6e::utils::DoubleBufferQueue< T, producer, consumer >::push ( const T &  value)
inline

pushes the given value into the queue

Definition at line 64 of file DoubleBufferQueue.h.

template<typename T, bool producer = true, bool consumer = true>
size_t i6e::utils::DoubleBufferQueue< T, producer, consumer >::size ( ) const
inline

returns size of the queue

Definition at line 100 of file DoubleBufferQueue.h.


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