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

create and initialize a job queue object More...

#include <osjobqueue.h>

Inheritance diagram for stateos::JobQueueT< limit_ >:

Public Types

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

Public Member Functions

constexpr JobQueueT ()
 constructor, see the constructor parameters of the class
 JobQueueT (JobQueueT &&_src)
 move constructor
 JobQueueT (const JobQueueT &)=delete
JobQueueT & operator= (JobQueueT &&)=delete
JobQueueT & operator= (const JobQueueT &)=delete
void reset ()
 job_reset()
void kill ()
 job_kill()
void destroy ()
 job_destroy()
int take ()
 job_take()
int tryWait ()
 job_tryWait()
int takeISR ()
 job_takeISR()
template<typename T>
int waitFor (const T &_delay)
 job_waitFor()
template<typename T>
int waitUntil (const T &_time)
 job_waitUntil()
int wait ()
 job_wait()
int give (fun_t *_fun)
 job_give()
int giveISR (fun_t *_fun)
 job_giveISR()
template<typename T>
int sendFor (fun_t *_fun, const T &_delay)
 job_sendFor()
template<typename T>
int sendUntil (fun_t *_fun, const T &_time)
 job_sendUntil()
int send (fun_t *_fun)
 job_send()
void push (fun_t *_fun)
 job_push()
void pushISR (fun_t *_fun)
 job_pushISR()
unsigned count ()
 job_count()
unsigned countISR ()
 job_countISR()
unsigned space ()
 job_space()
unsigned spaceISR ()
 job_spaceISR()
unsigned limit ()
 job_limit()
unsigned limitISR ()
 job_limitISR()
int takeAsync ()
 job_takeAsync()
int waitAsync ()
 job_waitAsync()
int giveAsync (fun_t *_fun)
 job_giveAsync()
int sendAsync (fun_t *_fun)
 job_sendAsync()

Static Public Member Functions

static Ptr Create ()
 create dynamic object with manageable resources

Detailed Description

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

create and initialize a job queue object

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

Member Function Documentation

◆ Create()

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

create dynamic object with manageable resources

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

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