#include <rtt/BufferLockFree.hpp>
Optionally block (synchronize) on an empty of full buffer (See Policy below ). The default Policy is thus completely Asynchronous (non-blocking). No memory allocation is done during read or write, any number of threads may access this buffer concurrently.
| T | The value type to be stored in the Buffer. Example : BufferLockFree is a buffer which holds values of type A. | |
| ReadPolicy | The Policy to block (wait) on empty (during read), using BlockingPolicy, or to return false, using NonBlockingPolicy (Default). This does not influence partial filled buffer behaviour. | |
| WritePolicy | The Policy to block (wait) on full (during write), using BlockingPolicy, or to return false, using NonBlockingPolicy (Default). This does not influence partial filled buffer behaviour. |
Definition at line 76 of file BufferLockFree.hpp.
Public Types | |
|
typedef ReadInterface< T > ::reference_t | reference_t |
|
typedef WriteInterface< 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()) | |
| Create a lock-free buffer wich can store bufsize elements. | |
| size_type | capacity () const |
| Returns the maximum number of items that can be stored in the buffer. | |
| size_type | size () const |
| Returns the actual number of items that are stored in the buffer. | |
| bool | empty () const |
| Check if this buffer is empty. | |
| bool | full () const |
| Check if this buffer is full. | |
| void | clear () |
| Clears all contents of this buffer. | |
| bool | write (param_t d) |
| Write a single value to the buffer. | |
| bool | Push (param_t item) |
| size_type | write (const std::vector< T > &d) |
| Write a sequence of values to the buffer. | |
| size_type | Push (const std::vector< T > &items) |
| Write a sequence of values to the buffer. | |
| bool | read (T &res) |
| Read the oldest value from the buffer. | |
| value_t | front () const |
| Get the next value to be Pop()'ed, or the default value if empty. | |
| bool | Pop (reference_t item) |
| size_type | read (std::vector< T > &res) |
| Read the whole buffer. | |
| size_type | Pop (std::vector< T > &items) |
| Read the whole buffer. | |
| virtual bool | Pop (reference_t item)=0 |
| Read the oldest value from the buffer. | |
| virtual bool | Push (param_t item)=0 |
| Write a single value to the buffer. | |
| BufferLockFree | ( | unsigned int | bufsize, | |
| const T & | initial_value = T() | |||
| ) | [inline] |
Create a lock-free buffer wich can store bufsize elements.
| bufsize | the capacity of the buffer. ' |
Definition at line 94 of file BufferLockFree.hpp.
| size_type capacity | ( | ) | const [inline, virtual] |
Returns the maximum number of items that can be stored in the buffer.
Implements BufferBase.
Definition at line 99 of file BufferLockFree.hpp.
| size_type size | ( | ) | const [inline, virtual] |
Returns the actual number of items that are stored in the buffer.
Implements BufferBase.
Definition at line 104 of file BufferLockFree.hpp.
| bool empty | ( | ) | const [inline, virtual] |
Check if this buffer is empty.
Implements BufferBase.
Definition at line 109 of file BufferLockFree.hpp.
| bool full | ( | ) | const [inline, virtual] |
Check if this buffer is full.
Implements BufferBase.
Definition at line 114 of file BufferLockFree.hpp.
| bool write | ( | param_t | d | ) | [inline] |
Write a single value to the buffer.
| d | the value to write |
Definition at line 132 of file BufferLockFree.hpp.
References BufferLockFree::Push().
| size_type write | ( | const std::vector< T > & | d | ) | [inline] |
Write a sequence of values to the buffer.
Block if full if Policy is BlockingPolicy.
| d | the values to write |
Definition at line 158 of file BufferLockFree.hpp.
References BufferLockFree::Push().
| size_type Push | ( | const std::vector< T > & | items | ) | [inline, virtual] |
Write a sequence of values to the buffer.
| items | the values to write |
Implements WriteInterface.
Definition at line 162 of file BufferLockFree.hpp.
| bool read | ( | T & | res | ) | [inline] |
Read the oldest value from the buffer.
Block if empty if Policy is BlockingPolicy.
| res | is to be filled with a value from the buffer. |
Definition at line 180 of file BufferLockFree.hpp.
References BufferLockFree::Pop().
| size_type read | ( | std::vector< T > & | res | ) | [inline] |
Read the whole buffer.
Block if empty if Policy is BlockingPolicy.
| res | is to be filled with all values in the buffer, with res.begin() the oldest value. |
Definition at line 215 of file BufferLockFree.hpp.
References BufferLockFree::Pop().
| size_type Pop | ( | std::vector< T > & | items | ) | [inline, virtual] |
Read the whole buffer.
| items | is to be filled with all values in the buffer, with items.begin() the oldest value. |
Implements ReadInterface.
Definition at line 220 of file BufferLockFree.hpp.
| virtual bool Pop | ( | reference_t | item | ) | [pure virtual, inherited] |
Read the oldest value from the buffer.
| item | is to be set with a value from the buffer. |
| virtual bool Push | ( | param_t | item | ) | [pure virtual, inherited] |
Write a single value to the buffer.
| item | the value to write |
1.5.3