Thread Safe FIFO bounded queue

Typedefs
typedef struct apr_queue_t	apr_queue_t

Functions
apr_status_t	apr_queue_create (apr_queue_t **queue, unsigned int queue_capacity, apr_pool_t *a)
apr_status_t	apr_queue_push (apr_queue_t *queue, void *data)
apr_status_t	apr_queue_pop (apr_queue_t *queue, void **data)
apr_status_t	apr_queue_trypush (apr_queue_t *queue, void *data)
apr_status_t	apr_queue_trypop (apr_queue_t *queue, void **data)
apr_status_t	apr_queue_timedpush (apr_queue_t *queue, void *data, apr_interval_time_t timeout)
apr_status_t	apr_queue_timedpop (apr_queue_t *queue, void **data, apr_interval_time_t timeout)
unsigned int	apr_queue_size (apr_queue_t *queue)
apr_status_t	apr_queue_interrupt_all (apr_queue_t *queue)
apr_status_t	apr_queue_term (apr_queue_t *queue)

Detailed Description

Typedef Documentation

typedef struct apr_queue_t apr_queue_t

opaque structure

Function Documentation

apr_status_t apr_queue_create	(	apr_queue_t **	queue,
		unsigned int	queue_capacity,
		apr_pool_t *	a
	)

create a FIFO queue

Parameters

queue	The new queue
queue_capacity	maximum size of the queue
a	pool to allocate queue from

apr_status_t apr_queue_interrupt_all

(

apr_queue_t *

queue

)

interrupt all the threads blocking on this queue.

Parameters

queue

the queue

apr_status_t apr_queue_pop	(	apr_queue_t *	queue,
		void **	data
	)

pop/get an object from the queue, blocking if the queue is already empty

Parameters

queue	the queue
data	the data

Returns

APR_EINTR the blocking was interrupted (try again)

APR_EOF if the queue has been terminated

APR_SUCCESS on a successful pop

apr_status_t apr_queue_push	(	apr_queue_t *	queue,
		void *	data
	)

push/add an object to the queue, blocking if the queue is already full

Parameters

queue	the queue
data	the data

Returns

APR_EINTR the blocking was interrupted (try again)

APR_EOF the queue has been terminated

APR_SUCCESS on a successful push

unsigned int apr_queue_size

(

apr_queue_t *

queue

)

returns the size of the queue.

Warning

this is not threadsafe, and is intended for reporting/monitoring of the queue.

Parameters

queue

the queue

Returns

the size of the queue

apr_status_t apr_queue_term

(

apr_queue_t *

queue

)

terminate the queue, sending an interrupt to all the blocking threads

Parameters

queue

the queue

apr_status_t apr_queue_timedpop	(	apr_queue_t *	queue,
		void **	data,
		apr_interval_time_t	timeout
	)

pop/get an object from the queue, waiting a maximum of timeout microseconds before returning if the queue is empty

Parameters

queue	the queue
data	the data
timeout	the timeout

Returns

APR_EINTR the blocking operation was interrupted (try again)

APR_EAGAIN the queue is empty and timeout is 0

APR_TIMEUP the queue is empty and the timeout expired

APR_EOF the queue has been terminated

APR_SUCCESS on a successful pop

apr_status_t apr_queue_timedpush	(	apr_queue_t *	queue,
		void *	data,
		apr_interval_time_t	timeout
	)

push/add an object to the queue, waiting a maximum of timeout microseconds before returning if the queue is empty

Parameters

queue	the queue
data	the data
timeout	the timeout

Returns

APR_EINTR the blocking operation was interrupted (try again)

APR_EAGAIN the queue is empty and timeout is 0

APR_TIMEUP the queue is empty and the timeout expired

APR_EOF the queue has been terminated

APR_SUCCESS on a successful pop

apr_status_t apr_queue_trypop	(	apr_queue_t *	queue,
		void **	data
	)

pop/get an object from the queue, returning immediately if the queue is empty

Parameters

queue	the queue
data	the data

Returns

APR_EINTR the blocking operation was interrupted (try again)

APR_EAGAIN the queue is empty

APR_EOF the queue has been terminated

APR_SUCCESS on a successful pop

apr_status_t apr_queue_trypush	(	apr_queue_t *	queue,
		void *	data
	)

push/add an object to the queue, returning immediately if the queue is full

Parameters

queue	the queue
data	the data

Returns

APR_EINTR the blocking operation was interrupted (try again)

APR_EAGAIN the queue is full

APR_EOF the queue has been terminated

APR_SUCCESS on a successful push