imt::base::dff::runtime::rtos::Mailbox< MessageType, MailboxSize > Class Template Reference

A Mailbox represents an abstract way for runtime to send/receive events with fixed size messages from underlaying RTOS. More...

#include <Imt.Base.Dff.Runtime.RTOS/inc/Imt.Base.Dff.Runtime.RTOS/Mailbox.h>

Inheritance diagram for imt::base::dff::runtime::rtos::Mailbox< MessageType, MailboxSize >:

Public Member Functions
	Mailbox (imt::base::dff::runtime::rtos::MailboxImplIfc &impl)
	Constructor.
void	initialize ()
	Init the mailbox.
void	deinitialize ()
	Deletes the mailbox.
void	clear ()
	Removes all messages from the mailbox.
MessageType	getMail ()
	Gets the next message from the mailbox.
bool	getMailConditional (MessageType *const pMail)
	Gets the next message from the mailbox.
void	putMail (MessageType const message)
	Adds a message to the mailbox.
bool	putMailConditional (MessageType const message)
	Adds a message to the mailbox.
void	waitMail ()
	This method returns imediately when the mailbox contains at least one message.

Detailed Description

template<typename MessageType, size_t const MailboxSize>
class imt::base::dff::runtime::rtos::Mailbox< MessageType, MailboxSize >

A Mailbox represents an abstract way for runtime to send/receive events with fixed size messages from underlaying RTOS.

Definition at line 53 of file Mailbox.h.

Constructor & Destructor Documentation

Mailbox()

template<typename MessageType , size_t const MailboxSize>

imt::base::dff::runtime::rtos::Mailbox< MessageType, MailboxSize >::Mailbox

(

imt::base::dff::runtime::rtos::MailboxImplIfc &

impl

)

Constructor.

Parameters

pHandle

The OS handle for the mailbox.

Definition at line 133 of file Mailbox.h.

Member Function Documentation

clear()

template<typename MessageType , size_t const MailboxSize>

void imt::base::dff::runtime::rtos::Mailbox< MessageType, MailboxSize >::clear

inline

Removes all messages from the mailbox.

Definition at line 149 of file Mailbox.h.

deinitialize()

template<typename MessageType , size_t const MailboxSize>

void imt::base::dff::runtime::rtos::Mailbox< MessageType, MailboxSize >::deinitialize

inline

Deletes the mailbox.

Definition at line 144 of file Mailbox.h.

getMail()

template<typename MessageType , size_t const MailboxSize>

MessageType imt::base::dff::runtime::rtos::Mailbox< MessageType, MailboxSize >::getMail

inline

Gets the next message from the mailbox.

This removes the message from the mailbox. If the mailbox is empty the task will be suspended until the mailbox contains a message.

Returns

The received message.

Definition at line 154 of file Mailbox.h.

getMailConditional()

template<typename MessageType , size_t const MailboxSize>

bool imt::base::dff::runtime::rtos::Mailbox< MessageType, MailboxSize >::getMailConditional ( MessageType *const  pMail )

inline

Gets the next message from the mailbox.

This removes the message from the mailbox. If the mailbox is empty the method will return false but not suspend the task.

Parameters

pMail

The return message.

Returns

False if there is no message, true if there is one.

Definition at line 161 of file Mailbox.h.

initialize()

template<typename MessageType , size_t const MailboxSize>

void imt::base::dff::runtime::rtos::Mailbox< MessageType, MailboxSize >::initialize

inline

Init the mailbox.

Must be called before using any other method.

Definition at line 139 of file Mailbox.h.

putMail()

template<typename MessageType , size_t const MailboxSize>

void imt::base::dff::runtime::rtos::Mailbox< MessageType, MailboxSize >::putMail ( MessageType const  message )

inline

Adds a message to the mailbox.

This can be used from any task. If the mailbox is full the task will be suspended until the mailbox can hold the new message. The data is copied.

Parameters

message

The message to put into the mailbox

Definition at line 177 of file Mailbox.h.

putMailConditional()

template<typename MessageType , size_t const MailboxSize>

bool imt::base::dff::runtime::rtos::Mailbox< MessageType, MailboxSize >::putMailConditional ( MessageType const  message )

inline

Adds a message to the mailbox.

This can be used from any task or interrupt handler. If the mailbox is full the mthod returns false but task will not be suspended. The data is copied.

Parameters

message

The message to put into the mailbox.

Returns

False if there is no space left for the message, true otherwise.

Definition at line 184 of file Mailbox.h.

waitMail()

template<typename MessageType , size_t const MailboxSize>

void imt::base::dff::runtime::rtos::Mailbox< MessageType, MailboxSize >::waitMail ( )

inline

This method returns imediately when the mailbox contains at least one message.

If the mailbox is empty this method will suspend the calling task until a message is avaliable. This will not remove the message from the mailbox.

---

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

• C:/src/imt/Imt.Base-cpp/Imt.Base/Imt.Base.Dff.Runtime.RTOS/inc/Imt.Base.Dff.Runtime.RTOS/Mailbox.h