clockUtils  1.1
clockUtils::container::LockFreeQueue< T, SIZE > Class Template Reference

#include <LockFreeQueue.h>

Public Member Functions

 LockFreeQueue ()
 default constructor More...
 
ClockError push (const T &value)
 pushes the given value into the queue More...
 
ClockError pop ()
 removes first entry of the queue More...
 
ClockError front (T &value)
 returns first entry of the queue, but keeps it in the queue More...
 
ClockError poll (T &value)
 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, size_t SIZE>
class clockUtils::container::LockFreeQueue< T, SIZE >

class LockFreeQueue

T defines the data type being contained in the queue size defines the maximum amount of entries this queue has space for

Definition at line 46 of file LockFreeQueue.h.

Constructor & Destructor Documentation

§ LockFreeQueue()

template<typename T , size_t SIZE>
clockUtils::container::LockFreeQueue< T, SIZE >::LockFreeQueue ( )
inline

default constructor

Definition at line 51 of file LockFreeQueue.h.

Here is the caller graph for this function:

Member Function Documentation

§ clear()

template<typename T , size_t SIZE>
void clockUtils::container::LockFreeQueue< T, SIZE >::clear ( )
inline

removes all elements in the queue

Definition at line 164 of file LockFreeQueue.h.

Here is the call graph for this function:

§ empty()

template<typename T , size_t SIZE>
bool clockUtils::container::LockFreeQueue< T, SIZE >::empty ( ) const
inline

returns true if the queue is empty, otherwise false

Definition at line 146 of file LockFreeQueue.h.

§ front()

template<typename T , size_t SIZE>
ClockError clockUtils::container::LockFreeQueue< T, SIZE >::front ( T &  value)
inline

returns first entry of the queue, but keeps it in the queue

Definition at line 101 of file LockFreeQueue.h.

§ poll()

template<typename T , size_t SIZE>
ClockError clockUtils::container::LockFreeQueue< T, SIZE >::poll ( T &  value)
inline

removes first entry of the queue and returns its value

Definition at line 123 of file LockFreeQueue.h.

§ pop()

template<typename T , size_t SIZE>
ClockError clockUtils::container::LockFreeQueue< T, SIZE >::pop ( )
inline

removes first entry of the queue

Definition at line 80 of file LockFreeQueue.h.

§ push()

template<typename T , size_t SIZE>
ClockError clockUtils::container::LockFreeQueue< T, SIZE >::push ( const T &  value)
inline

pushes the given value into the queue

Definition at line 57 of file LockFreeQueue.h.

§ size()

template<typename T , size_t SIZE>
size_t clockUtils::container::LockFreeQueue< T, SIZE >::size ( ) const
inline

returns size of the queue

Definition at line 155 of file LockFreeQueue.h.


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