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

Functions

void * WsfMsgDataAlloc (uint16_t len, uint8_t tailroom)
 Allocate a data message buffer to be sent with WsfMsgSend(). More...
 
void * WsfMsgAlloc (uint16_t len)
 Allocate a message buffer to be sent with WsfMsgSend(). More...
 
void WsfMsgFree (void *pMsg)
 Free a message buffer allocated with WsfMsgAlloc(). More...
 
void WsfMsgSend (wsfHandlerId_t handlerId, void *pMsg)
 Send a message to an event handler. More...
 
void WsfMsgEnq (wsfQueue_t *pQueue, wsfHandlerId_t handlerId, void *pMsg)
 Enqueue a message. More...
 
void * WsfMsgDeq (wsfQueue_t *pQueue, wsfHandlerId_t *pHandlerId)
 Dequeue a message. More...
 
void * WsfMsgPeek (wsfQueue_t *pQueue, wsfHandlerId_t *pHandlerId)
 Get the next message without removing it from the queue. More...
 

Description

Function Documentation

void* WsfMsgDataAlloc ( uint16_t  len,
uint8_t  tailroom 
)

Allocate a data message buffer to be sent with WsfMsgSend().

Parameters
lenMessage length in bytes.
tailroomTailroom length in bytes.
Returns
Pointer to data message buffer or NULL if allocation failed.
void* WsfMsgAlloc ( uint16_t  len)

Allocate a message buffer to be sent with WsfMsgSend().

Parameters
lenMessage length in bytes.
Returns
Pointer to message buffer or NULL if allocation failed.
void WsfMsgFree ( void *  pMsg)

Free a message buffer allocated with WsfMsgAlloc().

Parameters
pMsgPointer to message buffer.
Returns
None.
void WsfMsgSend ( wsfHandlerId_t  handlerId,
void *  pMsg 
)

Send a message to an event handler.

Parameters
handlerIdEvent handler ID.
pMsgPointer to message buffer.
Returns
None.
void WsfMsgEnq ( wsfQueue_t pQueue,
wsfHandlerId_t  handlerId,
void *  pMsg 
)

Enqueue a message.

Parameters
pQueuePointer to queue.
handlerIdSet message handler ID to this value.
pMsgPointer to message buffer.
Returns
None.
void* WsfMsgDeq ( wsfQueue_t pQueue,
wsfHandlerId_t pHandlerId 
)

Dequeue a message.

Parameters
pQueuePointer to queue.
pHandlerIdHandler ID of returned message; this is a return parameter.
Returns
Pointer to message that has been dequeued or NULL if queue is empty.
void* WsfMsgPeek ( wsfQueue_t pQueue,
wsfHandlerId_t pHandlerId 
)

Get the next message without removing it from the queue.

Parameters
pQueuePointer to queue.
pHandlerIdHandler ID of returned message; this is a return parameter.
Returns
Pointer to the next message on the queue or NULL if queue is empty.