Orocos Real-Time Toolkit
2.8.3
|
A Lock-free buffer implementation to read and write data of type T in a FIFO way. More...
#include <rtt/base/BufferLockFree.hpp>
Public Types | |
typedef BufferInterface< T >::reference_t | reference_t |
typedef BufferInterface< T >::param_t | param_t |
typedef BufferInterface< T >::size_type | size_type |
typedef T | value_t |
typedef boost::shared_ptr< BufferInterface< T > > | shared_ptr |
Public Member Functions | |
BufferLockFree (unsigned int bufsize, const T &initial_value=T(), bool circular=false) | |
Create a lock-free buffer wich can store bufsize elements. More... | |
~BufferLockFree () | |
virtual void | data_sample (const T &sample) |
Initializes this buffer with a data sample, such that for dynamical allocated types T, the buffer can reserve place to hold these elements. More... | |
virtual T | data_sample () const |
Reads back a data sample. More... | |
size_type | capacity () const |
Returns the maximum number of items that can be stored in the buffer. More... | |
size_type | size () const |
Returns the actual number of items that are stored in the buffer. More... | |
bool | empty () const |
Check if this buffer is empty. More... | |
bool | full () const |
Check if this buffer is full. More... | |
void | clear () |
Clears all contents of this buffer. More... | |
virtual size_type | dropped () const |
Returns the number of dropped samples, because the buffer was full. More... | |
bool | Push (param_t item) |
Write a single value to the buffer. More... | |
size_type | Push (const std::vector< T > &items) |
Write a sequence of values to the buffer. More... | |
bool | Pop (reference_t item) |
Read the oldest value from the buffer. More... | |
size_type | Pop (std::vector< T > &items) |
Read the whole buffer. More... | |
value_t * | PopWithoutRelease () |
Returns a pointer to the first element in the buffer. More... | |
void | Release (value_t *item) |
Releases the pointer. More... | |
A Lock-free buffer implementation to read and write data of type T in a FIFO way.
No memory allocation is done during read or write. One thread may read and any number of threads may write this buffer.
T | The value type to be stored in the Buffer. Example : BufferLockFree is a buffer which holds values of type A. |
Definition at line 69 of file BufferLockFree.hpp.
typedef BufferInterface<T>::param_t RTT::base::BufferLockFree< T >::param_t |
Definition at line 74 of file BufferLockFree.hpp.
typedef BufferInterface<T>::reference_t RTT::base::BufferLockFree< T >::reference_t |
Definition at line 73 of file BufferLockFree.hpp.
|
inherited |
Definition at line 62 of file BufferInterface.hpp.
typedef BufferInterface<T>::size_type RTT::base::BufferLockFree< T >::size_type |
Definition at line 75 of file BufferLockFree.hpp.
typedef T RTT::base::BufferLockFree< T >::value_t |
Definition at line 76 of file BufferLockFree.hpp.
|
inline |
Create a lock-free buffer wich can store bufsize elements.
bufsize | the capacity of the buffer. ' |
Definition at line 90 of file BufferLockFree.hpp.
References RTT::internal::TsPool< T >::data_sample().
|
inline |
Definition at line 96 of file BufferLockFree.hpp.
References RTT::base::BufferLockFree< T >::clear().
|
inlinevirtual |
Returns the maximum number of items that can be stored in the buffer.
Implements RTT::base::BufferBase.
Definition at line 118 of file BufferLockFree.hpp.
References RTT::internal::AtomicMWSRQueue< T >::capacity().
Referenced by RTT::base::BufferLockFree< T >::Push().
|
inlinevirtual |
Clears all contents of this buffer.
Implements RTT::base::BufferBase.
Definition at line 138 of file BufferLockFree.hpp.
References RTT::internal::TsPool< T >::deallocate(), and RTT::internal::AtomicMWSRQueue< T >::dequeue().
Referenced by RTT::base::BufferLockFree< T >::~BufferLockFree().
|
inlinevirtual |
Initializes this buffer with a data sample, such that for dynamical allocated types T, the buffer can reserve place to hold these elements.
Implements RTT::base::BufferInterface< T >.
Definition at line 101 of file BufferLockFree.hpp.
References RTT::internal::TsPool< T >::data_sample().
|
inlinevirtual |
Reads back a data sample.
Implements RTT::base::BufferInterface< T >.
Definition at line 106 of file BufferLockFree.hpp.
References RTT::internal::TsPool< T >::allocate(), and RTT::internal::TsPool< T >::deallocate().
|
inlinevirtual |
Returns the number of dropped samples, because the buffer was full.
Implements RTT::base::BufferBase.
Definition at line 145 of file BufferLockFree.hpp.
References RTT::os::AtomicInt::read().
|
inlinevirtual |
Check if this buffer is empty.
Implements RTT::base::BufferBase.
Definition at line 128 of file BufferLockFree.hpp.
References RTT::internal::AtomicMWSRQueue< T >::isEmpty().
|
inlinevirtual |
Check if this buffer is full.
Implements RTT::base::BufferBase.
Definition at line 133 of file BufferLockFree.hpp.
References RTT::internal::AtomicMWSRQueue< T >::isFull().
|
inlinevirtual |
Read the oldest value from the buffer.
item | is to be set with a value from the buffer. |
Implements RTT::base::BufferInterface< T >.
Definition at line 221 of file BufferLockFree.hpp.
References RTT::internal::TsPool< T >::deallocate(), and RTT::internal::AtomicMWSRQueue< T >::dequeue().
|
inlinevirtual |
Read the whole buffer.
items | is to be filled with all values in the buffer, with items.begin() the oldest value. |
Implements RTT::base::BufferInterface< T >.
Definition at line 232 of file BufferLockFree.hpp.
References RTT::internal::TsPool< T >::deallocate(), and RTT::internal::AtomicMWSRQueue< T >::dequeue().
|
inlinevirtual |
Returns a pointer to the first element in the buffer.
The pointer is only garanteed to stay valid until the next pop operation.
Note the pointer needs the be released by calling Release on the buffer.
Implements RTT::base::BufferInterface< T >.
Definition at line 244 of file BufferLockFree.hpp.
References RTT::internal::AtomicMWSRQueue< T >::dequeue().
|
inlinevirtual |
Write a single value to the buffer.
item | the value to write |
Implements RTT::base::BufferInterface< T >.
Definition at line 150 of file BufferLockFree.hpp.
References RTT::internal::TsPool< T >::allocate(), RTT::base::BufferLockFree< T >::capacity(), RTT::internal::TsPool< T >::deallocate(), RTT::internal::AtomicMWSRQueue< T >::dequeue(), RTT::internal::AtomicMWSRQueue< T >::enqueue(), RTT::os::AtomicInt::inc(), and RTT::internal::AtomicMWSRQueue< T >::size().
Referenced by RTT::base::BufferLockFree< T >::Push().
|
inlinevirtual |
Write a sequence of values to the buffer.
items | the values to write |
Implements RTT::base::BufferInterface< T >.
Definition at line 204 of file BufferLockFree.hpp.
References RTT::os::AtomicInt::add(), and RTT::base::BufferLockFree< T >::Push().
|
inlinevirtual |
Releases the pointer.
item | pointer aquired using PopWithoutRelease() |
Implements RTT::base::BufferInterface< T >.
Definition at line 252 of file BufferLockFree.hpp.
References RTT::internal::TsPool< T >::deallocate().
|
inlinevirtual |
Returns the actual number of items that are stored in the buffer.
Implements RTT::base::BufferBase.
Definition at line 123 of file BufferLockFree.hpp.
References RTT::internal::AtomicMWSRQueue< T >::size().