![]() |
PDK API Guide for AM65xx
|
Queue interface
Files | |
file | QueueP.h |
Queue Handling routines for RTOS. | |
Data Structures | |
struct | QueueP_Elem |
Opaque QueueP element. More... | |
struct | QueueP_Params |
Basic QueueP Parameters. More... | |
struct | Osal_Queue_Elem |
Queue element. 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... | |
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... | |
typedef void* QueueP_Handle |
Opaque client reference to an instance of a QueueP.
A QueueP_Handle returned from the QueueP_create represents that instance and is used in the other instance based functions
typedef void* Osal_Queue_Handle |
OSAL Queue handle Type [NOTE: This will be obsolete in next release]
enum QueueP_Status |
enum QueueP_State |
void QueueP_Params_init | ( | QueueP_Params * | params | ) |
Initialize params structure to default values.
params | [out] Pointer to the instance configuration parameters. |
QueueP_Handle QueueP_create | ( | const QueueP_Params * | params | ) |
Function to create a queue.
params | [in] Pointer to the instance configuration parameters. |
QueueP_Status QueueP_delete | ( | QueueP_Handle | handle | ) |
Function to delete a queue.
handle | [in] A QueueP_Handle returned from QueueP_create |
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.
handle | [in] A QueueP_Handle returned from QueueP_create |
QueueP_Status QueueP_put | ( | QueueP_Handle | handle, |
void * | elem | ||
) |
Function to Put an element at end of queue.
handle | [in] A QueueP_Handle returned from QueueP_create |
elem | [in] Pointer to new queue element |
QueueP_State QueueP_isEmpty | ( | QueueP_Handle | handle | ) |
Function to perform queue empty check.
handle | [in] A QueueP_Handle returned from QueueP_create |
void* QueueP_getQPtr | ( | QueueP_Handle | handle | ) |
Function to get pointer to the queue.
handle | [in] A QueueP_Handle returned from QueueP_create |
void Osal_Queue_construct | ( | void * | structPtr, |
const void * | queueParams | ||
) |
Function to construct the queue [NOTE: This will be obsolete in next release].
structPtr | Pointer to the structure containing the queue element |
queueParams | queue parameters |
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].
structPtr | Pointer to the structure containing the queue element |
bool Osal_Queue_empty | ( | Osal_Queue_Handle | queueHandle | ) |
Function to perform queue empty check [NOTE: This will be obsolete in next release].
queueHandle | The queue handle |
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].
queueHandle | The queue handle |
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].
queueHandle | The queue handle |
ptr | Pointer to the queue element |