OpenClovis Logo

Typedefs | Functions
clQueueApi.h File Reference

Header file of Queue Management related APIs. More...

#include <clCommon.h>

Go to the source code of this file.

Typedefs

typedef ClPtrT ClQueueDataT
 The type of the handle for the user-data.
 
typedef void(* ClQueueDequeueCallbackT) (CL_IN ClQueueDataT userData)
 Dequeue callback gets called, whenever a Node is getting deleted. More...
 
typedef ClHandleT ClQueueNodeT
 The type of the handle for the queue node.
 
typedef ClPtrT ClQueueT
 The type of the handle for the queue.
 
typedef ClRcT(* ClQueueWalkCallbackT) (CL_IN ClQueueDataT userData, CL_IN void *userArg)
 Walk Callback gets called, whenever traverse happens on the Queue. More...
 

Functions

ClRcT clQueueCreate (CL_IN ClUint32T maxSize, CL_IN ClQueueDequeueCallbackT fpUserDequeueCallBack, CL_IN ClQueueDequeueCallbackT fpUserDestroyCallBack, CL_OUT ClQueueT *pQueueHandle)
 Creates a queue. More...
 
ClRcT clQueueDelete (CL_IN ClQueueT *pQueueHandle)
 Destroys the queue. More...
 
ClRcT clQueueNodeDelete (CL_IN ClQueueT queueHandle, CL_OUT ClQueueDataT *userData)
 Dequeues an element from the queue. More...
 
ClRcT clQueueNodeInsert (CL_IN ClQueueT queueHandle, CL_IN ClQueueDataT userData)
 Enqueues an element (user-data) into the Queue. More...
 
ClRcT clQueueSizeGet (CL_IN ClQueueT queueHandle, CL_OUT ClUint32T *pSize)
 Retrieves the number of data elements in the queue. More...
 
ClRcT clQueueWalk (CL_IN ClQueueT queueHandle, CL_IN ClQueueWalkCallbackT fpUserWalkFunction, CL_IN void *userArg)
 Walks through the queue. More...
 

Detailed Description

Header file of Queue Management related APIs.


Generated on Tue Jan 10 10:29:15 PST 2012 for OpenClovis SDK using Doxygen