ucommon
|
A templated typed class for thread-safe queue of object pointers. More...
#include <containers.h>
Public Member Functions | |
const T & | at (unsigned offset=0) |
Examine past item in the queue. | |
T * | fifo (timeout_t timeout=0) |
Get and remove first typed object posted to the queue. | |
T * | lifo (timeout_t timeout=0) |
Get and remove last typed object posted to the queue. | |
T * | operator() (unsigned offset=0) |
T & | operator[] (unsigned offset) |
Examine past item in the queue. | |
bool | post (T *object, timeout_t timeout=0) |
Post a typed object into the queue by it's pointer. | |
queueof (mempager *memory, size_t size=0) | |
Create templated queue of typed objects. | |
bool | remove (T *object) |
Remove a specific typed object pointer for the queue. | |
![]() | |
size_t | count (void) |
Get number of object points currently in the queue. | |
ObjectProtocol * | fifo (timeout_t timeout=0) |
Get and remove last object posted to the queue. | |
ObjectProtocol * | get (unsigned offset=0) |
Examine pending existing object in queue. | |
ObjectProtocol * | lifo (timeout_t timeout=0) |
Get and remove first object posted to the queue. | |
bool | post (ObjectProtocol *object, timeout_t timeout=0) |
Post an object into the queue by it's pointer. | |
Queue (mempager *pager=((void *) 0), size_t number=0) | |
Create a queue that uses a memory pager for internally managed member objects for a specified maximum number of object pointers. | |
bool | remove (ObjectProtocol *object) |
Remove a specific object pointer for the queue. | |
~Queue () | |
Destroy queue. | |
Additional Inherited Members | |
![]() | |
virtual ObjectProtocol * | invalid (void) const |
![]() | |
static pthread_condattr_t * | initializer (void) |
Support function for getting conditional attributes for realtime scheduling. | |
static void | set (struct timespec *hires, timeout_t timeout) |
Convert a millisecond timeout into use for high resolution conditional timers. | |
![]() | |
size_t | limit |
A templated typed class for thread-safe queue of object pointers.
This allows one to use the queue class in a typesafe manner for a specific object type derived from Object rather than generically for any derived object class.
Definition at line 605 of file containers.h.
|
inline |
Create templated queue of typed objects.
memory | pool for internal use by queue. |
size | of queue to construct. Uses 0 if no size limit. |
Definition at line 613 of file containers.h.
|
inline |
Examine past item in the queue.
This is a typecast of the peek operation.
offset | in queue. |
Definition at line 662 of file containers.h.
|
inline |
Get and remove first typed object posted to the queue.
This can wait for a specified timeut of the queue is empty. The object is still retained and must be released or deleted by the receiving function.
timeout | to wait if empty in milliseconds. |
Definition at line 643 of file containers.h.
|
inline |
Get and remove last typed object posted to the queue.
This can wait for a specified timeout of the queue is empty. The object is still retained and must be released or deleted by the receiving function.
timeout | to wait if empty in milliseconds. |
Definition at line 653 of file containers.h.
|
inline |
Examine past item in the queue.
This is a typecast of the peek operation.
offset | in queue. |
Definition at line 671 of file containers.h.
|
inline |
Post a typed object into the queue by it's pointer.
This can wait for a specified timeout if the queue is full, for example, for another thread to remove an object pointer. This retains the object.
object | to post. |
timeout | to wait if queue is full in milliseconds. |
Definition at line 633 of file containers.h.
|
inline |
Remove a specific typed object pointer for the queue.
This can remove a member from any location in the queue, whether beginning, end, or somewhere in the middle. This releases the object.
object | to remove. |
Definition at line 622 of file containers.h.