#include <ti/sysbios/knl/Mailbox.h>

Collaboration diagram for Mailbox_Params:

Data Fields
IHeap_Handle	heap
	The IHeap instance used for dynamic creates. More...

Event_Handle	readerEvent
	Mailbox not empty event if using Events. Default is null. More...

unsigned int	readerEventId
	Mailbox not empty event Id if using Events. Default is 1. More...

Event_Handle	writerEvent
	Mailbox not full event if using Events. Default is null. More...

unsigned int	writerEventId
	Mailbox not full event Id if using Events. More...

void *	buf
	The address of the buffer used for creating messages. More...

unsigned int	bufSize
	The size of the buffer that 'buf' references. More...

Field Documentation

§ heap

IHeap_Handle Mailbox_Params::heap

The IHeap instance used for dynamic creates.

This heap is used only for dynamic instances is ignored for static instances.

§ readerEvent

Event_Handle Mailbox_Params::readerEvent

Mailbox not empty event if using Events. Default is null.

Posted whenever a mailbox is written to. Reader task pends on this event. Note that the configuration parameter Semaphore.supportsEvents has to be set to true for Mailbox to support Events.

§ readerEventId

unsigned int Mailbox_Params::readerEventId

Mailbox not empty event Id if using Events. Default is 1.

Posted whenever a mailbox is written to. Reader task pends on this eventId. Note that the configuration parameter Semaphore.supportsEvents has to be set to true for Mailbox to support Events.

§ writerEvent

Event_Handle Mailbox_Params::writerEvent

Mailbox not full event if using Events. Default is null.

Posted whenever a mailbox is read from. Writer task pends on this event. Note that the configuration parameter Semaphore.supportsEvents has to be set to true for Mailbox to support * Events.

§ writerEventId

unsigned int Mailbox_Params::writerEventId

Mailbox not full event Id if using Events.

Posted whenever a mailbox is read from. Writer task pends on this eventId. Note that the configuration parameter Semaphore.supportsEvents has to be set to true for Mailbox to support Events.

§ buf

void* Mailbox_Params::buf

The address of the buffer used for creating messages.

This property is only used for dynamically created Mailboxes. If set to 'null', the messages will be allocated from the heap during runtime, otherwise the user may set this to a buffer of their creation to be used for allocating the messages.

The module will split the buf into "numMsgs" number of blocks (one block per Mailbox message).

Please note that if the buffer is user supplied, then it is the user's responsibility to ensure that it is aligned properly and is also large enough to contain "numMsgs" number of blocks. The size of each block is defined as follows:

sizeof(Mailbox_MbxElem) + msgSize

Since the buffer must be a aligned properly, it may be necessary to 'round up' the total size of the buffer to the next multiple of the alignment for odd sized messages.

§ bufSize

unsigned int Mailbox_Params::bufSize

The size of the buffer that 'buf' references.

This property is only used for dynamically created Mailboxes.

The documentation for this struct was generated from the following file:

ti/sysbios/knl/Mailbox.h

Data Fields