vdsQueue.h File Reference
Detailed Description
This file provides the API needed to access a VDSF FIFO queue.
#include <vdsf/vdsCommon.h>
Include dependency graph for vdsQueue.h:
This graph shows which files directly or indirectly include this file:
Functions | |
| VDSF_EXPORT int | vdsQueueClose (VDS_HANDLE objectHandle) |
| Close a FIFO queue. | |
| VDSF_EXPORT int | vdsQueueGetFirst (VDS_HANDLE objectHandle, void *buffer, size_t bufferLength, size_t *returnedLength) |
| Iterate through the queue - no data items are removed from the queue by this function. | |
| VDSF_EXPORT int | vdsQueueGetNext (VDS_HANDLE objectHandle, void *buffer, size_t bufferLength, size_t *returnedLength) |
| Iterate through the queue - no data items are removed from the queue by this function. | |
| VDSF_EXPORT int | vdsQueueOpen (VDS_HANDLE sessionHandle, const char *queueName, size_t nameLengthInBytes, VDS_HANDLE *objectHandle) |
| Open an existing FIFO queue (see vdsCreateObject to create a new queue). | |
| VDSF_EXPORT int | vdsQueuePop (VDS_HANDLE objectHandle, void *buffer, size_t bufferLength, size_t *returnedLength) |
| Remove the first item from the beginning of a FIFO queue and return it to the caller. | |
| VDSF_EXPORT int | vdsQueuePush (VDS_HANDLE objectHandle, const void *pItem, size_t length) |
| Insert a data element at the end of the FIFO queue. | |
| VDSF_EXPORT int | vdsQueueStatus (VDS_HANDLE objectHandle, vdsObjStatus *pStatus) |
| Return the status of the queue. | |
Last updated on April 07, 2008.
