Cordio Stack and Cordio Profiles  r2p3-02rel0
WSF Queue API

Data Structures

struct  wsfQueue_t
 Queue structure. More...
 

Macros

#define WSF_QUEUE_INIT(pQueue)    {(pQueue)->pHead = NULL; (pQueue)->pTail = NULL;}
 Initialize a queue.
 

Functions

void WsfQueueEnq (wsfQueue_t *pQueue, void *pElem)
 Enqueue an element to the tail of a queue. More...
 
void * WsfQueueDeq (wsfQueue_t *pQueue)
 Dequeue an element from the head of a queue. More...
 
void WsfQueuePush (wsfQueue_t *pQueue, void *pElem)
 Push an element to the head of a queue. More...
 
void WsfQueueInsert (wsfQueue_t *pQueue, void *pElem, void *pPrev)
 Insert an element into a queue. This function is typically used when iterating over a queue. More...
 
void WsfQueueRemove (wsfQueue_t *pQueue, void *pElem, void *pPrev)
 Remove an element from a queue. This function is typically used when iterating over a queue. More...
 
uint16_t WsfQueueCount (wsfQueue_t *pQueue)
 Count the number of elements in a queue. More...
 
bool_t WsfQueueEmpty (wsfQueue_t *pQueue)
 Return TRUE if queue is empty. More...
 

Description

Function Documentation

void WsfQueueEnq ( wsfQueue_t pQueue,
void *  pElem 
)

Enqueue an element to the tail of a queue.

Parameters
pQueuePointer to queue.
pElemPointer to element.
Returns
None.
void* WsfQueueDeq ( wsfQueue_t pQueue)

Dequeue an element from the head of a queue.

Parameters
pQueuePointer to queue.
Returns
Pointer to element that has been dequeued or NULL if queue is empty.
void WsfQueuePush ( wsfQueue_t pQueue,
void *  pElem 
)

Push an element to the head of a queue.

Parameters
pQueuePointer to queue.
pElemPointer to element.
Returns
None.
void WsfQueueInsert ( wsfQueue_t pQueue,
void *  pElem,
void *  pPrev 
)

Insert an element into a queue. This function is typically used when iterating over a queue.

Parameters
pQueuePointer to queue.
pElemPointer to element to be inserted.
pPrevPointer to previous element in the queue before element to be inserted. Note: set pPrev to NULL if pElem is first element in queue.
Returns
None.
void WsfQueueRemove ( wsfQueue_t pQueue,
void *  pElem,
void *  pPrev 
)

Remove an element from a queue. This function is typically used when iterating over a queue.

Parameters
pQueuePointer to queue.
pElemPointer to element to be removed.
pPrevPointer to previous element in the queue before element to be removed.
Returns
None.
uint16_t WsfQueueCount ( wsfQueue_t pQueue)

Count the number of elements in a queue.

Parameters
pQueuePointer to queue.
Returns
Number of elements in queue.
bool_t WsfQueueEmpty ( wsfQueue_t pQueue)

Return TRUE if queue is empty.

Parameters
pQueuePointer to queue.
Returns
TRUE if queue is empty, FALSE otherwise.