diff options
Diffstat (limited to 'src/gqueue/gqueue.h')
| -rw-r--r-- | src/gqueue/gqueue.h | 45 |
1 files changed, 18 insertions, 27 deletions
diff --git a/src/gqueue/gqueue.h b/src/gqueue/gqueue.h index 40a41bce..c0da77d9 100644 --- a/src/gqueue/gqueue.h +++ b/src/gqueue/gqueue.h @@ -85,10 +85,6 @@ typedef struct GDataBuffer { /* Function declarations. */ /*===========================================================================*/ -#ifdef __cplusplus -extern "C" { -#endif - /** * @name Initialisation functions * @brief Initialise a queue. @@ -145,7 +141,7 @@ gfxQueueFSyncItem *gfxQueueFSyncGet(gfxQueueFSync *pqueue, delaytime_t ms); /** * @name Put() Functions * @brief Put an item on the end of the queue. - * @return none for ASync and GSync queues; For FSync queues - FALSE on timeout, otherwise TRUE + * @return none for ASync and GSync queues; For FSync queues - gFalse on timeout, otherwise gTrue * * @param[in] pqueue A pointer to the queue * @param[in] pitem A pointer to the queue item @@ -163,7 +159,7 @@ void gfxQueueASyncPut(gfxQueueASync *pqueue, gfxQueueASyncItem *pitem); void gfxQueueASyncPutI(gfxQueueASync *pqueue, gfxQueueASyncItem *pitem); void gfxQueueGSyncPut(gfxQueueGSync *pqueue, gfxQueueGSyncItem *pitem); void gfxQueueGSyncPutI(gfxQueueGSync *pqueue, gfxQueueGSyncItem *pitem); -bool_t gfxQueueFSyncPut(gfxQueueFSync *pqueue, gfxQueueFSyncItem *pitem, delaytime_t ms); +gBool gfxQueueFSyncPut(gfxQueueFSync *pqueue, gfxQueueFSyncItem *pitem, delaytime_t ms); /** @} */ /** @@ -183,7 +179,7 @@ bool_t gfxQueueFSyncPut(gfxQueueFSync *pqueue, gfxQueueFSyncItem *pitem, delayti /** * @name Push() Functions * @brief Push an item into the start of the queue. - * @return none for ASync and GSync queues; For FSync queues - FALSE on timeout, otherwise TRUE + * @return none for ASync and GSync queues; For FSync queues - gFalse on timeout, otherwise gTrue * * @param[in] pqueue A pointer to the queue * @param[in] pitem A pointer to the queue item @@ -201,13 +197,13 @@ void gfxQueueASyncPush(gfxQueueASync *pqueue, gfxQueueASyncItem *pitem); void gfxQueueASyncPushI(gfxQueueASync *pqueue, gfxQueueASyncItem *pitem); void gfxQueueGSyncPush(gfxQueueGSync *pqueue, gfxQueueGSyncItem *pitem); void gfxQueueGSyncPushI(gfxQueueGSync *pqueue, gfxQueueGSyncItem *pitem); -bool_t gfxQueueFSyncPush(gfxQueueFSync *pqueue, gfxQueueFSyncItem *pitem, delaytime_t ms); +gBool gfxQueueFSyncPush(gfxQueueFSync *pqueue, gfxQueueFSyncItem *pitem, delaytime_t ms); /** @} */ /** * @name Insert() Functions * @brief Insert an item on the queue after the specified item. - * @return none for ASync and GSync queues; For FSync queues - FALSE on timeout, otherwise TRUE + * @return none for ASync and GSync queues; For FSync queues - gFalse on timeout, otherwise gTrue * * @param[in] pqueue A pointer to the queue * @param[in] pitem A pointer to the queue item @@ -227,7 +223,7 @@ void gfxQueueASyncInsert(gfxQueueASync *pqueue, gfxQueueASyncItem *pitem, gfxQue void gfxQueueASyncInsertI(gfxQueueASync *pqueue, gfxQueueASyncItem *pitem, gfxQueueASyncItem *pafter); void gfxQueueGSyncInsert(gfxQueueGSync *pqueue, gfxQueueGSyncItem *pitem, gfxQueueASyncItem *pafter); void gfxQueueGSyncInsertI(gfxQueueGSync *pqueue, gfxQueueGSyncItem *pitem, gfxQueueASyncItem *pafter); -bool_t gfxQueueFSyncInsert(gfxQueueFSync *pqueue, gfxQueueFSyncItem *pitem, gfxQueueASyncItem *pafter, delaytime_t ms); +gBool gfxQueueFSyncInsert(gfxQueueFSync *pqueue, gfxQueueFSyncItem *pitem, gfxQueueASyncItem *pafter, delaytime_t ms); /** @} */ /** @@ -256,7 +252,7 @@ void gfxQueueFSyncRemove(gfxQueueFSync *pqueue, gfxQueueFSyncItem *pitem); /** * @name isEmpty() Functions * @brief Is the queue empty? - * @return TRUE if the queue is empty + * @return gTrue if the queue is empty * * @param[in] pqueue A pointer to the queue * @@ -276,7 +272,7 @@ void gfxQueueFSyncRemove(gfxQueueFSync *pqueue, gfxQueueFSyncItem *pitem); /** * @name IsInQueue() Functions * @brief Is an item in the queue? - * @return TRUE if the item is in the queue? + * @return gTrue if the item is in the queue? * * @param[in] pqueue A pointer to the queue * @param[in] pitem A pointer to the queue item @@ -287,12 +283,12 @@ void gfxQueueFSyncRemove(gfxQueueFSync *pqueue, gfxQueueFSyncItem *pitem); * @api * @{ */ -bool_t gfxQueueASyncIsIn(gfxQueueASync *pqueue, const gfxQueueASyncItem *pitem); -bool_t gfxQueueASyncIsInI(gfxQueueASync *pqueue, const gfxQueueASyncItem *pitem); -bool_t gfxQueueGSyncIsIn(gfxQueueGSync *pqueue, const gfxQueueGSyncItem *pitem); -bool_t gfxQueueGSyncIsInI(gfxQueueGSync *pqueue, const gfxQueueGSyncItem *pitem); -bool_t gfxQueueFSyncIsIn(gfxQueueFSync *pqueue, const gfxQueueFSyncItem *pitem); -bool_t gfxQueueFSyncIsInI(gfxQueueFSync *pqueue, const gfxQueueFSyncItem *pitem); +gBool gfxQueueASyncIsIn(gfxQueueASync *pqueue, const gfxQueueASyncItem *pitem); +gBool gfxQueueASyncIsInI(gfxQueueASync *pqueue, const gfxQueueASyncItem *pitem); +gBool gfxQueueGSyncIsIn(gfxQueueGSync *pqueue, const gfxQueueGSyncItem *pitem); +gBool gfxQueueGSyncIsInI(gfxQueueGSync *pqueue, const gfxQueueGSyncItem *pitem); +gBool gfxQueueFSyncIsIn(gfxQueueFSync *pqueue, const gfxQueueFSyncItem *pitem); +gBool gfxQueueFSyncIsInI(gfxQueueFSync *pqueue, const gfxQueueFSyncItem *pitem); /** @} */ /** @@ -348,7 +344,7 @@ bool_t gfxQueueFSyncIsInI(gfxQueueFSync *pqueue, const gfxQueueFSyncItem *pitem) /** * @name BufferAlloc() Functions * @brief Allocate some buffers and put them on the free list - * @return TRUE is it succeeded. FALSE on allocation failure. + * @return gTrue is it succeeded. gFalse on allocation failure. * * @param[in] num The number of buffers to allocate * @param[in] size The size (in bytes) of each buffer @@ -356,18 +352,18 @@ bool_t gfxQueueFSyncIsInI(gfxQueueFSync *pqueue, const gfxQueueFSyncItem *pitem) * @api * @{ */ -bool_t gfxBufferAlloc(unsigned num, size_t size); +gBool gfxBufferAlloc(unsigned num, size_t size); /** @} */ /** * @name BufferIsAvailable() Functions * @brief Is there one or more buffers currently available on the free list - * @return TRUE if there are buffers in the free list + * @return gTrue if there are buffers in the free list * * @api * @{ */ -bool_t gfxBufferIsAvailable(void); +gBool gfxBufferIsAvailable(void); /** @} */ /** @@ -402,11 +398,6 @@ void gfxBufferRelease(GDataBuffer *pd); void gfxBufferReleaseI(GDataBuffer *pd); /** @} */ - -#ifdef __cplusplus -} -#endif - #endif /* GFX_USE_GQUEUE */ #endif /* _GQUEUE_H */ /** @} */ |