Queue

Introduction

Queue interface

Files
file	Queue.h
	Queue Handling routines for RTOS.

Data Structures
struct	Osal_Queue_Elem
	Function to write back and invalidate cache lines. More...

Functions
void	Osal_Queue_construct (void *structPtr, const void *queueParams)
	Function to construct the queue. More...
Osal_Queue_Handle	Osal_Queue_handle (void *structPtr)
	Function to return the queue handle from the structure. More...
bool	Osal_Queue_empty (Osal_Queue_Handle queueHandle)
	Function to empty the queue. More...
void *	Osal_Queue_get (Osal_Queue_Handle queueHandle)
	Function to return the element at the front of the queue. More...
void	Osal_Queue_put (Osal_Queue_Handle queueHandle, Osal_Queue_Elem *ptr)
	Function to put the element to the queue. More...

Typedefs
typedef void *	Osal_Queue_Handle

Typedef Documentation

Osal_Queue_Handle

typedef void* Osal_Queue_Handle

OSAL Queue handle Type

Function Documentation

Osal_Queue_construct()

void Osal_Queue_construct	(	void *	structPtr,
		const void *	queueParams
	)

Function to construct the queue.

Parameters

structPtr	Pointer to the structure containing the queue element
queueParams	queue parameters

Osal_Queue_handle()

Osal_Queue_Handle Osal_Queue_handle

(

void *

structPtr

)

Function to return the queue handle from the structure.

Parameters

structPtr

Pointer to the structure containing the queue element

Osal_Queue_empty()

bool Osal_Queue_empty

(

Osal_Queue_Handle

queueHandle

)

Function to empty the queue.

Parameters

queueHandle

The queue handle

Osal_Queue_get()

void* Osal_Queue_get

(

Osal_Queue_Handle

queueHandle

)

Function to return the element at the front of the queue.

Parameters

queueHandle

The queue handle

Osal_Queue_put()

void Osal_Queue_put	(	Osal_Queue_Handle	queueHandle,
		Osal_Queue_Elem *	ptr
	)

Function to put the element to the queue.

Parameters

queueHandle	The queue handle
ptr	Pointer to the queue element