PDK API Guide for AM65xx
QueueP.h File Reference

Introduction

Queue Handling routines for RTOS.

============================================================================


Go to the source code of this file.

Data Structures

struct  QueueP_Elem
 Opaque QueueP element. More...
 
struct  QueueP_Params
 Basic QueueP Parameters. More...
 
struct  Osal_Queue_Elem
 Queue element. More...
 

Typedefs

typedef void * QueueP_Handle
 Opaque client reference to an instance of a QueueP. More...
 
typedef void * Osal_Queue_Handle
 

Enumerations

enum  QueueP_Status { QueueP_OK = 0, QueueP_FAILURE = (-(int32_t)1) }
 Status codes for QueueP APIs. More...
 
enum  QueueP_State { QueueP_NOTEMPTY = 0, QueueP_EMPTY = 1 }
 State codes for current queue state. More...
 

Functions

void QueueP_Params_init (QueueP_Params *params)
 Initialize params structure to default values. More...
 
QueueP_Handle QueueP_create (const QueueP_Params *params)
 Function to create a queue. More...
 
QueueP_Status QueueP_delete (QueueP_Handle handle)
 Function to delete a queue. More...
 
void * QueueP_get (QueueP_Handle handle)
 Function to Get the element at the front of the queue. This function removes an element from the front of a queue and returns it. More...
 
QueueP_Status QueueP_put (QueueP_Handle handle, void *elem)
 Function to Put an element at end of queue. More...
 
QueueP_State QueueP_isEmpty (QueueP_Handle handle)
 Function to perform queue empty check. More...
 
void * QueueP_getQPtr (QueueP_Handle handle)
 Function to get pointer to the queue. More...
 
void Osal_Queue_construct (void *structPtr, const void *queueParams)
 Function to construct the queue [NOTE: This will be obsolete in next release]. More...
 
Osal_Queue_Handle Osal_Queue_handle (void *structPtr)
 Function to return the queue handle from the structure [NOTE: This will be obsolete in next release]. More...
 
bool Osal_Queue_empty (Osal_Queue_Handle queueHandle)
 Function to perform queue empty check [NOTE: This will be obsolete in next release]. More...
 
void * Osal_Queue_get (Osal_Queue_Handle queueHandle)
 Function to return the element at the front of the queue [NOTE: This will be obsolete in next release]. More...
 
void Osal_Queue_put (Osal_Queue_Handle queueHandle, Osal_Queue_Elem *ptr)
 Function to put the element to the queue [NOTE: This will be obsolete in next release]. More...