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...

void *	WsfMsgNPeek (wsfQueue_t pQueue, uint8_t n, wsfHandlerId_t pHandlerId)
	Get the Nth message without removing it from the queue. More...

Detailed Description

Function Documentation

void* WsfMsgAlloc ( uint16_t len )

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

Parameters

len	Message length in bytes.

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

Parameters

len	Message length in bytes.
tailroom	Tailroom length in bytes.

Dequeue a message.

Parameters

pQueue	Pointer to queue.
pHandlerId	Handler ID of returned message; this is a return parameter.

Returns: Pointer to message that has been dequeued or NULL if queue is empty.

Enqueue a message.

Parameters

pQueue	Pointer to queue.
handlerId	Set message handler ID to this value.
pMsg	Pointer to message buffer.

void WsfMsgFree ( void * pMsg )

Free a message buffer allocated with WsfMsgAlloc().

Parameters

pMsg	Pointer to message buffer.

Get the Nth message without removing it from the queue.

Parameters

pQueue	Pointer to queue.
n	Nth item from the top (0 = top element).
pHandlerId	Handler ID of returned message; this is a return parameter.

Returns: Pointer to the next message on the queue or NULL if queue is empty.

Get the next message without removing it from the queue.

Parameters

pQueue	Pointer to queue.
pHandlerId	Handler ID of returned message; this is a return parameter.

Returns: Pointer to the next message on the queue or NULL if queue is empty.

Send a message to an event handler.

Parameters

handlerId	Event handler ID.
pMsg	Pointer to message buffer.