Orocos Real-Time Toolkit  2.9.0
Public Types | Public Member Functions | List of all members
RTT::internal::AtomicMWSRQueue< T > Class Template Reference

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 >:
RTT::internal::AtomicQueue< T > RTT::internal::MWSRQueue< base::RTT::base::DisposableInterface * > RTT::internal::MWSRQueue< base::RTT::base::ExecutableInterface * > RTT::internal::MWSRQueue< base::RTT::base::PortInterface * > RTT::internal::MWSRQueue< T >

Public Types

typedef AtomicQueue< T >::size_type 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
TThe pointer type to be stored in the Queue. Example : AtomicMWSRQueue< A* > is a queue of pointers to A.

Definition at line 60 of file AtomicMWSRQueue.hpp.

Member Typedef Documentation

template<class T >
typedef AtomicQueue<T>::size_type RTT::internal::AtomicMWSRQueue< T >::size_type

Definition at line 163 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
sizeThe size of the queue, should be 1 or greater.

Definition at line 169 of file AtomicMWSRQueue.hpp.

References RTT::internal::AtomicMWSRQueue< T >::clear().

template<class T >
RTT::internal::AtomicMWSRQueue< T >::~AtomicMWSRQueue ( )
inline

Definition at line 176 of file AtomicMWSRQueue.hpp.

Member Function Documentation

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

Return the maximum number of items this queue can contain.

Implements RTT::internal::AtomicQueue< T >.

Definition at line 210 of file AtomicMWSRQueue.hpp.

template<class T >
void RTT::internal::AtomicMWSRQueue< T >::clear ( )
inlinevirtual

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

Implements RTT::internal::AtomicQueue< T >.

Definition at line 270 of file AtomicMWSRQueue.hpp.

Referenced by RTT::internal::AtomicMWSRQueue< T >::AtomicMWSRQueue().

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

Dequeue an item.

Parameters
valueStores 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.

Implements RTT::internal::AtomicQueue< T >.

Definition at line 249 of file AtomicMWSRQueue.hpp.

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

Enqueue an item.

Parameters
valueThe value to enqueue.
Returns
false if queue is full, true if queued.

Implements RTT::internal::AtomicQueue< T >.

Definition at line 231 of file AtomicMWSRQueue.hpp.

template<class T >
const T RTT::internal::AtomicMWSRQueue< T >::front ( ) const
inlinevirtual

Return the next to be read value.

Implements RTT::internal::AtomicQueue< T >.

Definition at line 262 of file AtomicMWSRQueue.hpp.

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

Inspect if the Queue is empty.

Returns
true if empty, false otherwise.

Implements RTT::internal::AtomicQueue< T >.

Definition at line 199 of file AtomicMWSRQueue.hpp.

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

Inspect if the Queue is full.

Returns
true if full, false otherwise.

Implements RTT::internal::AtomicQueue< T >.

Definition at line 185 of file AtomicMWSRQueue.hpp.

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

Return the number of elements in the queue.

Implements RTT::internal::AtomicQueue< T >.

Definition at line 218 of file AtomicMWSRQueue.hpp.


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