A templated typed class for buffering of objects. More...
#include <containers.h>
Public Member Functions | |
bufferof (unsigned count) | |
Create a buffer to hold a series of typed objects. | |
void | copy (T *object) |
Copy the next typed object from the buffer. | |
bool | get (T *object, timeout_t timeout) |
Copy the next typed object from the buffer. | |
T * | get (timeout_t timeout) |
Get the next typed object from the buffer. | |
T * | get (void) |
Get the next typed object from the buffer. | |
bool | put (T *object, timeout_t timeout) |
Put (copy) an object into the buffer. | |
void | put (T *object) |
Put (copy) a typed object into the buffer. |
A templated typed class for buffering of objects.
This operates as a fifo buffer of typed objects which are physically copied into the buffer. The objects that are buffered are accessed from allocated buffer space. As designed this may be used with multiple producer threads and one consumer thread. To use multiple consumers, one can copy the typed object from the buffer through the get pointer and then call release. The copied object can then be used safely. This is what the copy method is used for.
Definition at line 483 of file containers.h.
ucommon::bufferof< T >::bufferof | ( | unsigned | count | ) | [inline] |
Create a buffer to hold a series of typed objects.
count | of typed objects in the buffer. |
Definition at line 490 of file containers.h.
void ucommon::bufferof< T >::copy | ( | T * | object | ) | [inline] |
Copy the next typed object from the buffer.
This blocks until an object becomes available.
object | pointer to copy typed object into. |
Definition at line 531 of file containers.h.
bool ucommon::bufferof< T >::get | ( | T * | object, | |
timeout_t | timeout | |||
) | [inline] |
Copy the next typed object from the buffer.
object | pointer to copy typed object into. | |
timeout | to wait when buffer is empty in milliseconds. |
Definition at line 540 of file containers.h.
T* ucommon::bufferof< T >::get | ( | timeout_t | timeout | ) | [inline] |
Get the next typed object from the buffer.
timeout | to wait when buffer is empty in milliseconds. |
Reimplemented from ucommon::Buffer.
Definition at line 506 of file containers.h.
T* ucommon::bufferof< T >::get | ( | void | ) | [inline] |
Get the next typed object from the buffer.
This blocks until an object becomes available.
Reimplemented from ucommon::Buffer.
Definition at line 498 of file containers.h.
bool ucommon::bufferof< T >::put | ( | T * | object, | |
timeout_t | timeout | |||
) | [inline] |
Put (copy) an object into the buffer.
object | to copy into the buffer. | |
timeout | to wait if buffer is full. |
Definition at line 523 of file containers.h.
void ucommon::bufferof< T >::put | ( | T * | object | ) | [inline] |
Put (copy) a typed object into the buffer.
This blocks while the buffer is full.
object | to copy into the buffer. |
Definition at line 514 of file containers.h.