StateOS
Loading...
Searching...
No Matches
stateos::MessageQueueTT< limit_, C > Struct Template Reference

create and initialize a message queue object More...

#include <osmessagequeue.h>

Inheritance diagram for stateos::MessageQueueTT< limit_, C >:
stateos::MessageQueueT< limit_, sizeof(C)>

Public Types

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

Public Member Functions

constexpr MessageQueueTT ()
 constructor, see the constructor parameters of the class
int take (C *_data, size_t *_read=nullptr)
 msg_take()
int tryWait (C *_data, size_t *_read=nullptr)
 msg_tryWait()
int takeISR (C *_data, size_t *_read=nullptr)
 msg_takeISR()
template<typename T>
int waitFor (C *_data, size_t *_read, const T &_delay)
 msg_waitFor()
template<typename T>
int waitUntil (C *_data, size_t *_read, const T &_time)
 msg_waitUntil()
int wait (C *_data, size_t *_read=nullptr)
 msg_wait()
int give (const C *_data)
 msg_give()
int giveISR (const C *_data)
 msg_giveISR()
template<typename T>
int sendFor (const C *_data, const T &_delay)
 msg_sendFor()
template<typename T>
int sendUntil (const C *_data, const T &_time)
 msg_sendUntil()
int send (const C *_data)
 msg_send()
int push (const C *_data)
 msg_push()
int pushISR (const C *_data)
 msg_pushISR()
int takeAsync (C *_data, size_t *_read=nullptr)
 msg_takeAsync()
int waitAsync (C *_data, size_t *_read=nullptr)
 msg_waitAsync()
int giveAsync (const C *_data)
 msg_giveAsync()
int sendAsync (const C *_data)
 msg_sendAsync()

Static Public Member Functions

static Ptr Create ()
 create dynamic object with manageable resources

Detailed Description

template<unsigned limit_, class C>
struct stateos::MessageQueueTT< limit_, C >

create and initialize a message queue object

Constructor parameters
  • limit: size of a buffer (max number of stored objects)
  • C: class of a single message

Member Function Documentation

◆ Create()

template<unsigned limit_, class C>
Ptr stateos::MessageQueueTT< limit_, C >::Create ( )
inlinestatic

create dynamic object with manageable resources

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

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