Dataflow Runtime API  3.0.3.0
Public Member Functions | List of all members
imt::base::os::embos::MailboxImpl Class Reference

The actual implementation of the mailbox with a fixed size byte array as message. More...

#include <Imt.Base.OS.EmbOS/MailboxImpl.h>

Public Member Functions

 MailboxImpl (void *const pHandle, uint8_t *const pBuffer, const size_t messageSize, const size_t mailboxSize)
 Constructor. More...
 
virtual ~MailboxImpl (void)
 Destructor. More...
 
void initialize (void)
 
void deinitialize (void)
 
void clear (void)
 
void getMail (uint8_t *const pData, const size_t dataSize)
 
bool getMailConditional (uint8_t *const pData, const size_t dataSize)
 
void putMail (const uint8_t *const pData, const size_t dataSize)
 
bool putMailConditional (const uint8_t *const pData, const size_t dataSize)
 
void waitMail (void)
 

Detailed Description

The actual implementation of the mailbox with a fixed size byte array as message.

Use the Mailbox template to create a mailbox and not this class.

Constructor & Destructor Documentation

◆ MailboxImpl()

imt::base::os::embos::MailboxImpl::MailboxImpl ( void *const  pHandle,
uint8_t *const  pBuffer,
const size_t  messageSize,
const size_t  mailboxSize 
)

Constructor.

◆ ~MailboxImpl()

virtual imt::base::os::embos::MailboxImpl::~MailboxImpl ( void  )
virtual

Destructor.

Member Function Documentation

◆ clear()

void imt::base::os::embos::MailboxImpl::clear ( void  )
See also
Mailbox

◆ deinitialize()

void imt::base::os::embos::MailboxImpl::deinitialize ( void  )
See also
Mailbox

◆ getMail()

void imt::base::os::embos::MailboxImpl::getMail ( uint8_t *const  pData,
const size_t  dataSize 
)
See also
Mailbox

◆ getMailConditional()

bool imt::base::os::embos::MailboxImpl::getMailConditional ( uint8_t *const  pData,
const size_t  dataSize 
)
See also
Mailbox

◆ initialize()

void imt::base::os::embos::MailboxImpl::initialize ( void  )
See also
Mailbox

◆ putMail()

void imt::base::os::embos::MailboxImpl::putMail ( const uint8_t *const  pData,
const size_t  dataSize 
)
See also
Mailbox

◆ putMailConditional()

bool imt::base::os::embos::MailboxImpl::putMailConditional ( const uint8_t *const  pData,
const size_t  dataSize 
)
See also
Mailbox

◆ waitMail()

void imt::base::os::embos::MailboxImpl::waitMail ( void  )
See also
Mailbox

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