Dataflow Runtime API  3.1.1.0
Public Member Functions | List of all members
imt::base::os::zephyr::QueueImpl Class Reference

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

#include <Imt.Base.OS.Zephyr/QueueImpl.h>

Public Member Functions

 QueueImpl (void *const pHandle, char *const pBuffer, const size_t messageSize, const size_t queueSize)
 Constructor. More...
 
virtual ~QueueImpl (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)
 
uint32_t getWaitingMails ()
 

Detailed Description

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

Use the Queue template to create a queue and not this class.

See also
https://docs.zephyrproject.org/latest/kernel/services/data_passing/message_queues.html

Constructor & Destructor Documentation

◆ QueueImpl()

imt::base::os::zephyr::QueueImpl::QueueImpl ( void *const  pHandle,
char *const  pBuffer,
const size_t  messageSize,
const size_t  queueSize 
)

Constructor.

◆ ~QueueImpl()

virtual imt::base::os::zephyr::QueueImpl::~QueueImpl ( void  )
virtual

Destructor.

Member Function Documentation

◆ clear()

void imt::base::os::zephyr::QueueImpl::clear ( void  )
See also
Mailbox

◆ deinitialize()

void imt::base::os::zephyr::QueueImpl::deinitialize ( void  )
See also
Mailbox

◆ getMail()

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

◆ getMailConditional()

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

◆ getWaitingMails()

uint32_t imt::base::os::zephyr::QueueImpl::getWaitingMails ( )
See also
Mailbox

◆ initialize()

void imt::base::os::zephyr::QueueImpl::initialize ( void  )
See also
Mailbox

◆ putMail()

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

◆ putMailConditional()

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

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