Queue< T > Class Template Reference

Consumer/producer queue. More...

#include <tdme/os/threading/Queue.h>

Collaboration diagram for Queue< T >:

Public Member Functions
	Queue (const unsigned int maxElements)
	Public constructor. More...
virtual	~Queue ()
	Destructor, removes remaining elements from queue. More...
void	stop ()
	Requests this queue to be stopped, any gets will be woke up and return NULL. More...
T *	getElement ()
	Gets an element from this queue, if no element exists yet the calling thread will be blocked until an element is available. More...
bool	addElement (T *element, const bool declinable)
	Adds an element to this queue, signals threads which waits for an element. More...

Protected Types
typedef queue< T * >	QueueType

Protected Attributes
QueueType	data
unsigned int	maxElements

Private Attributes
Mutex	m
Condition	c
volatile bool	stopRequested

Detailed Description

template<typename T>
class tdme::os::threading::Queue< T >

Consumer/producer queue.

Author

Andreas Drewke

Definition at line 24 of file Queue.h.

Member Typedef Documentation

QueueType

typedef queue<T*> QueueType

protected

Definition at line 96 of file Queue.h.

Constructor & Destructor Documentation

Queue()

Queue ( const unsigned int  maxElements )

inline

Public constructor.

Definition at line 29 of file Queue.h.

~Queue()

virtual ~Queue ( )

inlinevirtual

Destructor, removes remaining elements from queue.

Definition at line 40 of file Queue.h.

Member Function Documentation

addElement()

bool addElement ( T *  element, const bool  declinable  )

inline

Adds an element to this queue, signals threads which waits for an element.

Parameters

element	T* element
declinable	bool if element is declinable

Returns

if element was added

Definition at line 83 of file Queue.h.

getElement()

T * getElement ( )

inline

Gets an element from this queue, if no element exists yet the calling thread will be blocked until an element is available.

Returns

T*

Definition at line 60 of file Queue.h.

stop()

void stop ( )

inline

Requests this queue to be stopped, any gets will be woke up and return NULL.

Definition at line 51 of file Queue.h.

Member Data Documentation

c

Condition c

private

Definition at line 102 of file Queue.h.

data

QueueType data

protected

Definition at line 97 of file Queue.h.

m

Mutex m

private

Definition at line 101 of file Queue.h.

maxElements

unsigned int maxElements

protected

Definition at line 98 of file Queue.h.

stopRequested

volatile bool stopRequested

private

Definition at line 103 of file Queue.h.

---

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

• /home/andreas/Development/drewke.net/tdme2/src/tdme/os/threading/Queue.h