StateOS
Loading...
Searching...
No Matches
stateos::MailBoxQueueT< limit_, size_ > Struct Template Reference

create and initialize a mailbox queue object More...

#include <osmailboxqueue.h>

Inheritance diagram for stateos::MailBoxQueueT< limit_, size_ >:

Public Types

using Ptr = std::unique_ptr<MailBoxQueueT<limit_, size_>>
 result type of Create()

Public Member Functions

constexpr MailBoxQueueT ()
 constructor, see the constructor parameters of the class
 MailBoxQueueT (MailBoxQueueT &&_src)
 move constructor
 MailBoxQueueT (const MailBoxQueueT &)=delete
MailBoxQueueT & operator= (MailBoxQueueT &&)=delete
MailBoxQueueT & operator= (const MailBoxQueueT &)=delete
void reset ()
 box_reset()
void kill ()
 box_kill()
void destroy ()
 box_destroy()
int take (void *_data)
 box_take()
int tryWait (void *_data)
 box_tryWait()
int takeISR (void *_data)
 box_takeISR()
template<typename T>
int waitFor (void *_data, const T &_delay)
 box_waitFor()
template<typename T>
int waitUntil (void *_data, const T &_time)
 box_waitUntil()
int wait (void *_data)
 box_wait()
int give (const void *_data)
 box_give()
int giveISR (const void *_data)
 box_giveISR()
template<typename T>
int sendFor (const void *_data, const T &_delay)
 box_sendFor()
template<typename T>
int sendUntil (const void *_data, const T &_time)
 box_sendUntil()
int send (const void *_data)
 box_send()
void push (const void *_data)
 box_push()
void pushISR (const void *_data)
 box_pushISR()
unsigned count ()
 box_count()
unsigned countISR ()
 box_countISR()
unsigned space ()
 box_space()
unsigned spaceISR ()
 box_spaceISR()
unsigned limit ()
 box_limit()
unsigned limitISR ()
 box_limitISR()
size_t size ()
 box_size()
size_t sizeISR ()
 box_sizeISR()
int takeAsync (void *_data)
 box_takeAsync()
int waitAsync (void *_data)
 box_waitAsync()
int giveAsync (const void *_data)
 box_giveAsync()
int sendAsync (const void *_data)
 box_sendAsync()

Static Public Member Functions

static Ptr Create ()
 create dynamic object with manageable resources

Detailed Description

template<unsigned limit_, size_t size_>
struct stateos::MailBoxQueueT< limit_, size_ >

create and initialize a mailbox queue object

Constructor parameters
  • limit: size of a queue (max number of stored mails)
  • size: size of a single mail (in bytes)

Member Function Documentation

◆ Create()

template<unsigned limit_, size_t size_>
Ptr stateos::MailBoxQueueT< limit_, size_ >::Create ( )
inlinestatic

create dynamic object with manageable resources

Parameters
  • limit: size of a queue (max number of stored mails)
  • size: size of a single mail (in bytes)
Returns
std::unique_pointer / pointer to MailBoxQueueT<> object
Note
use only in thread mode

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