StateOS
Loading...
Searching...
No Matches
stateos::Flag Struct Reference

create and initialize a flag object More...

#include <osflag.h>

Inheritance diagram for stateos::Flag:

Public Types

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

Public Member Functions

constexpr Flag (const unsigned _init=0)
 constructor, see the constructor parameters of the class
 Flag (Flag &&_src)
 move constructor
 Flag (const Flag &)=delete
Flag & operator= (Flag &&)=delete
Flag & operator= (const Flag &)=delete
void reset ()
 flg_reset()
void kill ()
 flg_kill()
void destroy ()
 flg_destroy()
unsigned take (unsigned _flags, unsigned _mode=flgAll)
 flg_take()
unsigned tryWait (unsigned _flags, unsigned _mode=flgAll)
 flg_tryWait()
unsigned takeISR (unsigned _flags, unsigned _mode=flgAll)
 flg_takeISR()
template<typename T>
int waitFor (unsigned _flags, unsigned _mode, const T &_delay)
 flg_waitFor()
template<typename T>
int waitUntil (unsigned _flags, unsigned _mode, const T &_time)
 flg_waitUntil()
int wait (unsigned _flags, unsigned _mode=flgAll)
 flg_wait()
unsigned give (unsigned _flags)
 flg_give()
unsigned set (unsigned _flags)
 flg_set()
unsigned giveISR (unsigned _flags)
 flg_giveISR()
unsigned clear (unsigned _flags)
 flg_clear()
unsigned clearISR (unsigned _flags)
 flg_clearISR()
unsigned get ()
 flg_get()
unsigned getISR ()
 flg_getISR()

Static Public Member Functions

static Ptr Create (const unsigned _init=0)
 create dynamic object with manageable resources

Detailed Description

create and initialize a flag object

Constructor parameters
  • init: initial value of flag

Member Function Documentation

◆ Create()

Ptr stateos::Flag::Create ( const unsigned _init = 0)
inlinestatic

create dynamic object with manageable resources

Parameters
_initinitial value of flag
Returns
std::unique_pointer / pointer to Flag object
Note
use only in thread mode

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