StateOS
Loading...
Searching...
No Matches
stateos::EventQueueT< limit_ > Struct Template Reference

create and initialize an event queue object More...

#include <oseventqueue.h>

Inheritance diagram for stateos::EventQueueT< limit_ >:

Public Types

using Ptr = std::unique_ptr<EventQueueT<limit_>>
 result type of Create()

Public Member Functions

constexpr EventQueueT ()
 constructor, see the constructor parameters of the class
 EventQueueT (EventQueueT &&_src)
 move constructor
 EventQueueT (const EventQueueT &)=delete
EventQueueT & operator= (EventQueueT &&)=delete
EventQueueT & operator= (const EventQueueT &)=delete
void reset ()
 evq_reset()
void kill ()
 evq_kill()
void destroy ()
 evq_destroy()
int take (unsigned *_event=nullptr)
 evq_take()
int take (unsigned &_event)
 evq_take()
int tryWait (unsigned *_event=nullptr)
 evq_tryWait()
int tryWait (unsigned &_event)
 evq_tryWait()
int takeISR (unsigned *_event)
 evq_takeISR()
template<typename T>
int waitFor (unsigned *_event, const T &_delay)
 evq_waitFor()
template<typename T>
int waitUntil (unsigned *_event, const T &_time)
 evq_waitUntil()
int wait (unsigned *_event=nullptr)
 evq_wait()
int wait (unsigned &_event)
 evq_wait()
int give (unsigned _event)
 evq_give()
int giveISR (unsigned _event)
 evq_giveISR()
template<typename T>
int sendFor (unsigned _event, const T &_delay)
 evq_sendFor()
template<typename T>
int sendUntil (unsigned _event, const T &_time)
 evq_sendUntil()
int send (unsigned _event)
 evq_send()
void push (unsigned _event)
 evq_push()
void pushISR (unsigned _event)
 evq_pushISR()
unsigned count ()
 evq_count()
unsigned countISR ()
 evq_countISR()
unsigned space ()
 evq_space()
unsigned spaceISR ()
 evq_spaceISR()
unsigned limit ()
 evq_limit()
unsigned limitISR ()
 evq_limitISR()
int takeAsync (unsigned *_event=nullptr)
 evq_takeAsync()
int takeAsync (unsigned &_event)
 evq_takeAsync()
int waitAsync (unsigned *_event=nullptr)
 evq_waitAsync()
int waitAsync (unsigned &_event)
 evq_waitAsync()
int giveAsync (unsigned _event)
 evq_giveAsync()
int sendAsync (unsigned _event)
 evq_sendAsync()

Static Public Member Functions

static Ptr Create ()
 create dynamic object with manageable resources

Detailed Description

template<unsigned limit_>
struct stateos::EventQueueT< limit_ >

create and initialize an event queue object

Constructor parameters
  • limit: size of a queue (max number of stored events)

Member Function Documentation

◆ Create()

template<unsigned limit_>
Ptr stateos::EventQueueT< limit_ >::Create ( )
inlinestatic

create dynamic object with manageable resources

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

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