57 #ifndef _CL_QUEUE_API_H_
58 #define _CL_QUEUE_API_H_
105 CL_IN void *userArg);
282 CL_IN void* userArg);
Typical defines found in any software project.
ClUint32T ClRcT
Clovis return code type.
Definition: clCommon.h:168
#define CL_OUT
CL_OUT macro assists in clearly defining arguments of an API, but has no actual meaning.
Definition: clCommon.h:110
#define CL_IN
CL_IN macro assists in clearly defining arguments of an API, but has no actual meaning.
Definition: clCommon.h:106
ClRcT(* ClQueueWalkCallbackT)(CL_IN ClQueueDataT userData, CL_IN void *userArg)
Walk Callback gets called, whenever traverse happens on the Queue.
Definition: clQueueApi.h:104
void(* ClQueueDequeueCallbackT)(CL_IN ClQueueDataT userData)
Dequeue callback gets called, whenever a Node is getting deleted.
Definition: clQueueApi.h:128
ClRcT clQueueWalk(CL_IN ClQueueT queueHandle, CL_IN ClQueueWalkCallbackT fpUserWalkFunction, CL_IN void *userArg)
Walks through the queue.
ClHandleT ClQueueNodeT
The type of the handle for the queue node.
Definition: clQueueApi.h:74
ClPtrT ClQueueT
The type of the handle for the queue.
Definition: clQueueApi.h:69
ClRcT clQueueNodeInsert(CL_IN ClQueueT queueHandle, CL_IN ClQueueDataT userData)
Enqueues an element (user-data) into the Queue.
ClRcT clQueueNodeDelete(CL_IN ClQueueT queueHandle, CL_OUT ClQueueDataT *userData)
Dequeues an element from the queue.
ClRcT clQueueDelete(CL_IN ClQueueT *pQueueHandle)
Destroys the queue.
ClRcT clQueueCreate(CL_IN ClUint32T maxSize, CL_IN ClQueueDequeueCallbackT fpUserDequeueCallBack, CL_IN ClQueueDequeueCallbackT fpUserDestroyCallBack, CL_OUT ClQueueT *pQueueHandle)
Creates a queue.
ClPtrT ClQueueDataT
The type of the handle for the user-data.
Definition: clQueueApi.h:79
ClRcT clQueueSizeGet(CL_IN ClQueueT queueHandle, CL_OUT ClUint32T *pSize)
Retrieves the number of data elements in the queue.