PSDK QNX API Guide
Files | Data Structures | Variables
Queue
OSAL

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...
 

Variables

struct QueueP_Elem_s * QueueP_Elem::next
 
struct QueueP_Elem_s * QueueP_Elem::prev
 
void * QueueP_Params::pErrBlk
 

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...
 
typedef void * QueueP_Handle
 Opaque client reference to an instance of a QueueP. More...
 
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...
 
#define QueueP_NOTEMPTY   (BFALSE)
 
#define QueueP_EMPTY   (BTRUE)
 

Detailed Description

Queue interface

Macro Definition Documentation

◆ QueueP_OK

#define QueueP_OK   (int32_t)(0)

API completed successfully

◆ QueueP_FAILURE

#define QueueP_FAILURE   (int32_t)(-1)

API failed

◆ QueueP_NOTEMPTY

#define QueueP_NOTEMPTY   (BFALSE)

Elements are present in the the queue

◆ QueueP_EMPTY

#define QueueP_EMPTY   (BTRUE)

Queue is empty. No elements are present.

Typedef Documentation

◆ QueueP_Status

typedef int32_t QueueP_Status

Status codes for QueueP APIs.

◆ QueueP_State

typedef bool QueueP_State

State codes for current queue state.

◆ QueueP_Handle

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

Function Documentation

◆ QueueP_Params_init()

void QueueP_Params_init ( QueueP_Params *  params)

Initialize params structure to default values.

Parameters
params[out] Pointer to the instance configuration parameters.

◆ QueueP_create()

QueueP_Handle QueueP_create ( const QueueP_Params *  params)

Function to create a queue.

Parameters
params[in] Pointer to the instance configuration parameters.
Returns
A QueueP_Handle on success or a NULL on an error

◆ QueueP_delete()

QueueP_Status QueueP_delete ( QueueP_Handle  handle)

Function to delete a queue.

Parameters
handle[in] A QueueP_Handle returned from QueueP_create
Returns
Status of the functions
  • QueueP_OK: Deleted the queue instance
  • QueueP_FAILURE: Failed to delete the queue instance

◆ QueueP_get()

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.

Parameters
handle[in] A QueueP_Handle returned from QueueP_create
Returns
pointer to the element or pointer to queue itself incase of empty queue

◆ QueueP_put()

QueueP_Status QueueP_put ( QueueP_Handle  handle,
void *  elem 
)

Function to Put an element at end of queue.

Parameters
handle[in] A QueueP_Handle returned from QueueP_create
elem[in] Pointer to new queue element
Returns
Status of the functions
  • QueueP_OK: Put the element at end of queue
  • QueueP_FAILURE: Failed to Put the element at end of queue

◆ QueueP_isEmpty()

QueueP_State QueueP_isEmpty ( QueueP_Handle  handle)

Function to perform queue empty check.

Parameters
handle[in] A QueueP_Handle returned from QueueP_create
Returns
Current state of the Queue
  • QueueP_NOTEMPTY: queue is not empty
  • QueueP_EMPTY: queue is empty

◆ QueueP_getQPtr()

void* QueueP_getQPtr ( QueueP_Handle  handle)

Function to get pointer to the queue.

Parameters
handle[in] A QueueP_Handle returned from QueueP_create
Returns
pointer to the queue

Variable Documentation

◆ next

struct QueueP_Elem_s* QueueP_Elem::next

Pointer to the next queue element

◆ prev

struct QueueP_Elem_s* QueueP_Elem::prev

Pointer to the previous queue element

◆ pErrBlk

void* QueueP_Params::pErrBlk

Pointer to the error block for queue create