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

create and initialize a message queue object More...

#include <osmessagequeue.h>

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

Public Types

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

Public Member Functions

constexpr MessageQueueT ()
 constructor, see the constructor parameters of the class
 MessageQueueT (MessageQueueT &&_src)
 move constructor
 MessageQueueT (const MessageQueueT &)=delete
MessageQueueT & operator= (MessageQueueT &&)=delete
MessageQueueT & operator= (const MessageQueueT &)=delete
void reset ()
 msg_reset()
void kill ()
 msg_kill()
void destroy ()
 msg_destroy()
int take (void *_data, size_t _size, size_t *_read=nullptr)
 msg_take()
int tryWait (void *_data, size_t _size, size_t *_read=nullptr)
 msg_tryWait()
int takeISR (void *_data, size_t _size, size_t *_read=nullptr)
 msg_takeISR()
template<typename T>
int waitFor (void *_data, size_t _size, size_t *_read, const T &_delay)
 msg_waitFor()
template<typename T>
int waitUntil (void *_data, size_t _size, size_t *_read, const T &_time)
 msg_waitUntil()
int wait (void *_data, size_t _size, size_t *_read=nullptr)
 msg_wait()
int give (const void *_data, size_t _size)
 msg_give()
int giveISR (const void *_data, size_t _size)
 msg_giveISR()
template<typename T>
int sendFor (const void *_data, size_t _size, const T &_delay)
 msg_sendFor()
template<typename T>
int sendUntil (const void *_data, size_t _size, const T &_time)
 msg_sendUntil()
int send (const void *_data, size_t _size)
 msg_send()
int push (const void *_data, size_t _size)
 msg_push()
int pushISR (const void *_data, size_t _size)
 msg_pushISR()
size_t count ()
 msg_count()
size_t countISR ()
 msg_countISR()
size_t space ()
 msg_space()
size_t spaceISR ()
 msg_spaceISR()
size_t limit ()
 msg_limit()
size_t limitISR ()
 msg_limitISR()
size_t size ()
 msg_size()
size_t sizeISR ()
 msg_sizeISR()
int takeAsync (void *_data, size_t _size, size_t *_read=nullptr)
 msg_takeAsync()
int waitAsync (void *_data, size_t _size, size_t *_read=nullptr)
 msg_waitAsync()
int giveAsync (const void *_data, size_t _size)
 msg_giveAsync()
int sendAsync (const void *_data, size_t _size)
 msg_sendAsync()

Static Public Member Functions

static Ptr Create ()
 create dynamic object with manageable resources

Detailed Description

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

create and initialize a message queue object

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

Member Function Documentation

◆ Create()

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

create dynamic object with manageable resources

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

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