inc/queue.h File Reference

This graph shows which files directly or indirectly include this file:

Data Structures
struct	queue_t
	Circular queue data structure. More...
Defines
#define	BUFF_NUM_MAX   (32)
	maximum number of buffers storable in the queue note this can be different from actual queue capacity
Functions
int	queue_init (queue_t *pThis, unsigned int maxSize)
	Initialize a circular queue.
int	queue_get (queue_t *pThis, void **ppChunk)
	Get chunk from queue.
int	queue_put (queue_t *pThis, void *pChunk)
	Attach a filled chunk into the queue.
int	queue_is_empty (queue_t *pThis)
	Check whether queue is empty.
int	queue_is_full (queue_t *pThis)
	Check whether queue is full.

---

Define Documentation

#define BUFF_NUM_MAX   (32)

maximum number of buffers storable in the queue note this can be different from actual queue capacity

---

Function Documentation

int queue_get	(	queue_t *	pThis,
		void **	ppChunk
	)

Get chunk from queue.

Non blocking, returns PASS if success, FAIL if empty

Parameters:

Parameters:

	pqueue	pointer to queue data structure
	ppChunk	pointer pointer to retrieved chunk

Returns:

PASS on success. FAIL value on failure.

int queue_init	(	queue_t *	pThis,
		unsigned int	maxSize
	)

Initialize a circular queue.

All elements empty.

Parameters:

Parameters:

	pThis	pointer to queue data structure
	maxSize	number of queue elements

Returns:

PASS/Zero on success. FAIL/Negative value on failure.

int queue_is_empty

(

queue_t *

pThis

)

Check whether queue is empty.

Parameters:

Parameters:

pqueue

pointer to queue data structure

Returns:

non zero if queue is empty zero if queue contains at least one element

int queue_is_full

(

queue_t *

pThis

)

Check whether queue is full.

Parameters:

Parameters:

pqueue

pointer to queue data structure

Returns:

non zero if queue is full zero if queue has least one free element

int queue_put	(	queue_t *	pThis,
		void *	pChunk
	)

Attach a filled chunk into the queue.

Non blocking, will return FAIL if queue already full

Parameters:

Parameters:

	pThis	pointer to queue data structure
	pChunk	pointer to filled chunk

Returns:

PASS on success. FAIL value on failure.

---