Cyclic FIFO Queue of Opaque void* Objects. More...

#include "apt.h"

Typedefs
typedef struct apt_cyclic_queue_t	apt_cyclic_queue_t

Functions
apt_cyclic_queue_t *	apt_cyclic_queue_create (apr_size_t size)

void	apt_cyclic_queue_destroy (apt_cyclic_queue_t *queue)

apt_bool_t	apt_cyclic_queue_push (apt_cyclic_queue_t queue, void obj)

void *	apt_cyclic_queue_pop (apt_cyclic_queue_t *queue)

void	apt_cyclic_queue_clear (apt_cyclic_queue_t *queue)

apt_bool_t	apt_cyclic_queue_is_empty (const apt_cyclic_queue_t *queue)

Detailed Description

Cyclic FIFO Queue of Opaque void* Objects.

Macro Definition Documentation

#define CYCLIC_QUEUE_DEFAULT_SIZE 100

Default size (number of elements) of cyclic queue

Opaque cyclic queue declaration

void apt_cyclic_queue_clear ( apt_cyclic_queue_t * queue )

Clear the queue (remove all the elements from the queue).

Parameters

queue the queue to clear

apt_cyclic_queue_t* apt_cyclic_queue_create ( apr_size_t size )

Create cyclic queue.

Parameters

size	the initial size of the queue

void apt_cyclic_queue_destroy ( apt_cyclic_queue_t * queue )

Destroy cyclic queue.

Parameters

queue the queue to destroy

apt_bool_t apt_cyclic_queue_is_empty ( const apt_cyclic_queue_t * queue )

Query whether the queue is empty.

Parameters

queue the queue to query

void* apt_cyclic_queue_pop ( apt_cyclic_queue_t * queue )

Pop object from the queue.

Parameters

queue the queue to pop message from

apt_bool_t apt_cyclic_queue_push	(	apt_cyclic_queue_t *	queue,
		void *	obj
	)

Push object to the queue.

Parameters

queue	the queue to push object to
obj	the object to push