Introduction

Data Structures
struct	node_t
	A generic node structure for a single link list. More...

struct	queue_t
	Generic queue. More...

Functions
void	CpswUtils_initQ (queue_t *pQueue)
	Init queue. More...

void	CpswUtils_copyQ (queue_t pDstQueue, const queue_t pSrcQueue)
	Copy queues. More...

void	CpswUtils_enQ (queue_t pQueue, node_t pNode)
	Enqueue a packet into the queue. More...

void	CpswUtils_enQHead (queue_t pQueue, node_t pNode)
	Enqueue a packet at head into the queue. More...

node_t *	CpswUtils_deQ (queue_t *pQueue)
	Dequeue a packet from the queue. More...

void	CpswUtils_appendQ (queue_t pDstQueue, queue_t pSrcQueue)
	Append queue. More...

uint32_t	CpswUtils_getQCount (queue_t *pQueue)
	Get queue count. More...

void	CpswUtils_verifyQCount (queue_t *pQueue)
	Checks queue corruption. More...

Function Documentation

void CpswUtils_initQ ( queue_t * pQueue )

Init queue.

Initializes a queue.

Parameters

pQueue Queue handle

void CpswUtils_copyQ	(	queue_t *	pDstQueue,
		const queue_t *	pSrcQueue
	)

Copy queues.

Copies queues. The copied queue will have the same head/tail pointers and count as the source queue.

Parameters

pDstQueue	Destination queue handle
pSrcQueue	Source queue handle

void CpswUtils_enQ	(	queue_t *	pQueue,
		node_t *	pNode
	)

Enqueue a packet into the queue.

Enqueues a packet into the queue.

Parameters

pQueue	Queue handle
pNode	Queue node handle

void CpswUtils_enQHead	(	queue_t *	pQueue,
		node_t *	pNode
	)

Enqueue a packet at head into the queue.

Enqueues a packet into head of queue.

Parameters

pQueue	Queue handle
pNode	Queue node handle

node_t* CpswUtils_deQ ( queue_t * pQueue )

Dequeue a packet from the queue.

Dequeues a packet from the queue. A null pointer is returned if the queue was already empty.

Parameters

pQueue Queue handle

Returns: Queue node handle or NULL if queue was empty

void CpswUtils_appendQ	(	queue_t *	pDstQueue,
		queue_t *	pSrcQueue
	)

Append queue.

Appends a packet queue into another queue. The packets in the source queue are queued to the tail of the destination queue.

Parameters

pDstQueue	Destination queue node handle
pSrcQueue	Source queue handle

uint32_t CpswUtils_getQCount ( queue_t * pQueue )

Get queue count.

Gets the number of packets in the queue.

Parameters

pQueue Queue handle

Returns: Number of packets in the queue

void CpswUtils_verifyQCount ( queue_t * pQueue )

Checks queue corruption.

Debug API which verifies the queue memory corruption by checking queue count to actual elements in queue. Asserts if queue count doesn't match.

Parameters

pQueue Queue handle

Introduction

Data Structures

Functions

Function Documentation