ucommon::queue Class Reference

Manage a thread-safe queue of objects through reference pointers. More...

#include <containers.h>

Inheritance diagram for ucommon::queue:

Collaboration diagram for ucommon::queue:

Public Member Functions
ObjectProtocol *	fifo (timeout_t timeout=0)
	Get and remove last object posted to the queue.
size_t	getCount (void)
	Get number of object points currently in the 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=NULL, 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.
Static Public Member Functions
static size_t	count (queue &queue)
	Convenience function to get count of objects in the queue.
static ObjectProtocol *	fifo (queue &queue, timeout_t timeout=0)
	Convenience function get first object from the queue.
static ObjectProtocol *	lifo (queue &queue, timeout_t timeout=0)
	Convenience function get last object from the queue.
static bool	post (queue &queue, ObjectProtocol *object, timeout_t timeout=0)
	Convenience function to post object into the queue.
static bool	remove (queue &queue, ObjectProtocol *object)
	Convenience function to remove an object from the queue.
Protected Attributes
size_t	limit
Friends
class	member

Detailed Description

Manage a thread-safe queue of objects through reference pointers.

This can be particularly interesting when used to enqueue/dequeue reference counted managed objects. Thread-safe access is managed through a conditional. Both lifo and fifo forms of queue access may be used. A pool of self-managed member objects are used to operate the queue. This queue is optimized for fifo access; while lifo is supported, it will be slow. If you need primarily lifo, you should use stack instead.

Author:: David Sugar <dyfet@gnutelephony.org>

Definition at line 203 of file containers.h.

Constructor & Destructor Documentation

ucommon::queue::queue	(	mempager *	pager = `NULL`,
		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.

Parameters:

	pager	to use for internal member object or NULL to use heap.
	number	of pointers that can be in the queue or 0 for unlimited. size limit.

ucommon::queue::~queue ( )

Destroy queue.

If no mempager is used, then frees heap.

Member Function Documentation

static size_t ucommon::queue::count ( queue & queue ) [inline, static]

Convenience function to get count of objects in the queue.

Parameters:

queue

to count.

Returns:: number of objects in the queue.

Definition at line 322 of file containers.h.

Here is the call graph for this function:

static ObjectProtocol* ucommon::queue::fifo	(	queue &	queue,
		timeout_t	timeout = `0`
	)			`[inline, static]`

Convenience function get first object from the queue.

Parameters:

	queue	to get from.
	timeout	to wait if empty.

Returns:: first object or NULL if timed out empty.

Definition at line 305 of file containers.h.

Here is the call graph for this function:

ObjectProtocol* ucommon::queue::fifo ( timeout_t timeout = 0 )

Get and remove last 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.

Parameters:

timeout

to wait if empty in milliseconds.

Returns:: object from queue or NULL if empty and timed out.

Reimplemented in ucommon::queueof< T >.

size_t ucommon::queue::getCount ( void )

Get number of object points currently in the queue.

Returns:: number of objects in queue.

static ObjectProtocol* ucommon::queue::lifo	(	queue &	queue,
		timeout_t	timeout = `0`
	)			`[inline, static]`

Convenience function get last object from the queue.

Parameters:

	queue	to get from.
	timeout	to wait if empty.

Returns:: last object or NULL if timed out empty.

Definition at line 314 of file containers.h.

Here is the call graph for this function:

ObjectProtocol* ucommon::queue::lifo ( timeout_t timeout = 0 )

Get and remove first 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.

Parameters:

timeout

to wait if empty in milliseconds.

Returns:: object from queue or NULL if empty and timed out.

Reimplemented in ucommon::queueof< T >.

static bool ucommon::queue::post	(	queue &	queue,
		ObjectProtocol *	object,
		timeout_t	timeout = `0`
	)			`[inline, static]`

Convenience function to post object into the queue.

Parameters:

	queue	to post into.
	object	to post.
	timeout	to wait if full.

Returns:: true if posted, false if timed out while full.

Definition at line 296 of file containers.h.

Here is the call graph for this function:

bool ucommon::queue::post	(	ObjectProtocol *	object,
		timeout_t	timeout = `0`
	)

Post an 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 also retains the object.

Parameters:

	object	to post.
	timeout	to wait if queue is full in milliseconds.

Returns:: true if object posted, false if queue full and timeout expired.

static bool ucommon::queue::remove	(	queue &	queue,
		ObjectProtocol *	object
	)			`[inline, static]`

Convenience function to remove an object from the queue.

Parameters:

	queue	to remove object from.
	object	to remove.

Returns:: true if removed, false if not found.

Definition at line 286 of file containers.h.

bool ucommon::queue::remove ( ObjectProtocol * object )

Remove a specific 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 also releases the object.

Parameters:

object

to remove.

Returns:: true if object was removed, false if not found.

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

ucommon/containers.h

ucommon::queue Class Reference

Public Member Functions

Static Public Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation