![]() |
PDK API Guide for J721E
|
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... | |
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... | |
Typedefs | |
typedef void * | QueueP_Handle |
Opaque client reference to an instance of a QueueP. More... | |
Status codes for QueueP APIs | |
typedef int32_t | QueueP_Status |
Status codes for QueueP APIs. More... | |
#define | QueueP_OK (int32_t)(0) |
#define | QueueP_FAILURE (int32_t)(-1) |
State codes for current queue state | |
typedef bool | QueueP_State |
State codes for current queue state. More... | |
#define | QueueP_NOTEMPTY ((bool)false) |
#define | QueueP_EMPTY ((bool)true) |
#define QueueP_OK (int32_t)(0) |
API completed successfully
#define QueueP_FAILURE (int32_t)(-1) |
API failed
#define QueueP_NOTEMPTY ((bool)false) |
Elements are present in the the queue
#define QueueP_EMPTY ((bool)true) |
Queue is empty. No elements are present.
typedef int32_t QueueP_Status |
Status codes for QueueP APIs.
typedef bool QueueP_State |
State codes for current queue state.
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
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 |