Create an atomic, non-blocking Multi-Writer Single-Reader FIFO for storing a pointer T by value. More...

#include <rtt/internal/AtomicMWSRQueue.hpp>

Inheritance diagram for RTT::internal::AtomicMWSRQueue< T >:

Public Types
typedef unsigned int	size_type

Public Member Functions
	AtomicMWSRQueue (unsigned int size)
	Create an AtomicMWSRQueue with queue size size. More...

	~AtomicMWSRQueue ()

bool	isFull () const
	Inspect if the Queue is full. More...

bool	isEmpty () const
	Inspect if the Queue is empty. More...

size_type	capacity () const
	Return the maximum number of items this queue can contain. More...

size_type	size () const
	Return the number of elements in the queue. More...

bool	enqueue (const T &value)
	Enqueue an item. More...

bool	dequeue (T &result)
	Dequeue an item. More...

const T	front () const
	Return the next to be read value. More...

void	clear ()
	Clear all contents of the Queue and thus make it empty. More...

Detailed Description

template<class T>
class RTT::internal::AtomicMWSRQueue< T >

Create an atomic, non-blocking Multi-Writer Single-Reader FIFO for storing a pointer T by value.

Any number of writer threads may access the queue concurrently, but only one thread may read it.

Warning: You can not store null pointers.

Parameters

T	The pointer type to be stored in the Queue. Example : AtomicMWSRQueue< A* > is a queue of pointers to A.

Definition at line 59 of file AtomicMWSRQueue.hpp.

Member Typedef Documentation

template<class T>

typedef unsigned int RTT::internal::AtomicMWSRQueue< T >::size_type

Definition at line 161 of file AtomicMWSRQueue.hpp.

Constructor & Destructor Documentation

template<class T>

RTT::internal::AtomicMWSRQueue< T >::AtomicMWSRQueue ( unsigned int size )

inline

Create an AtomicMWSRQueue with queue size size.

Parameters

size	The size of the queue, should be 1 or greater.

Definition at line 167 of file AtomicMWSRQueue.hpp.

template<class T>

RTT::internal::AtomicMWSRQueue< T >::~AtomicMWSRQueue ( )

inline

Definition at line 174 of file AtomicMWSRQueue.hpp.

Member Function Documentation

template<class T>

size_type RTT::internal::AtomicMWSRQueue< T >::capacity ( ) const

inline

Return the maximum number of items this queue can contain.

Definition at line 208 of file AtomicMWSRQueue.hpp.

Referenced by RTT::base::BufferLockFree< T >::capacity().

template<class T>

void RTT::internal::AtomicMWSRQueue< T >::clear ( )

inline

Clear all contents of the Queue and thus make it empty.

Definition at line 268 of file AtomicMWSRQueue.hpp.

Referenced by RTT::internal::AtomicMWSRQueue< Item * >::AtomicMWSRQueue().

template<class T>

bool RTT::internal::AtomicMWSRQueue< T >::dequeue ( T & result )

inline

Dequeue an item.

Parameters

value Stores the dequeued value. It is unchanged when dequeue returns false and contains the dequeued value when it returns true.

Returns: false if queue is empty, true if result was written.

Definition at line 247 of file AtomicMWSRQueue.hpp.

Referenced by RTT::base::BufferLockFree< T >::clear(), RTT::base::BufferLockFree< T >::Pop(), RTT::base::BufferLockFree< T >::PopWithoutRelease(), and RTT::base::BufferLockFree< T >::Push().

template<class T>

bool RTT::internal::AtomicMWSRQueue< T >::enqueue ( const T & value )

inline

Enqueue an item.

Parameters

value The value to enqueue.

Returns: false if queue is full, true if queued.

Definition at line 229 of file AtomicMWSRQueue.hpp.

Referenced by RTT::base::BufferLockFree< T >::Push().

template<class T>

const T RTT::internal::AtomicMWSRQueue< T >::front ( ) const

inline

Return the next to be read value.

Definition at line 260 of file AtomicMWSRQueue.hpp.

template<class T>

bool RTT::internal::AtomicMWSRQueue< T >::isEmpty ( ) const

inline

Inspect if the Queue is empty.

Returns: true if empty, false otherwise.

Definition at line 197 of file AtomicMWSRQueue.hpp.

Referenced by RTT::base::BufferLockFree< T >::empty().

template<class T>

bool RTT::internal::AtomicMWSRQueue< T >::isFull ( ) const

inline

Inspect if the Queue is full.

Returns: true if full, false otherwise.

Definition at line 183 of file AtomicMWSRQueue.hpp.

Referenced by RTT::base::BufferLockFree< T >::full().

template<class T>

size_type RTT::internal::AtomicMWSRQueue< T >::size ( ) const

inline

Return the number of elements in the queue.

Definition at line 216 of file AtomicMWSRQueue.hpp.

Referenced by RTT::base::BufferLockFree< T >::Push(), and RTT::base::BufferLockFree< T >::size().

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

rtt/internal/AtomicMWSRQueue.hpp

Public Types

Public Member Functions

Detailed Description

template<class T> class RTT::internal::AtomicMWSRQueue< T >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

template<class T>
class RTT::internal::AtomicMWSRQueue< T >