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

create and initialize a condition variable object More...

#include <osconditionvariable.h>

Inheritance diagram for stateos::ConditionVariable:

Public Types

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

Public Member Functions

constexpr ConditionVariable ()
 constructor, see the constructor parameters of the class
 ConditionVariable (ConditionVariable &&_src)
 move constructor
 ConditionVariable (const ConditionVariable &)=delete
ConditionVariable & operator= (ConditionVariable &&)=delete
ConditionVariable & operator= (const ConditionVariable &)=delete
void reset ()
 cnd_reset()
void kill ()
 cnd_kill()
void destroy ()
 cnd_destroy()
template<typename T>
int waitFor (mtx_t &_mtx, const T &_delay)
 cnd_waitFor()
template<typename T>
int waitUntil (mtx_t &_mtx, const T &_time)
 cnd_waitUntil()
int wait (mtx_t &_mtx)
 cnd_wait()
void give (bool _all=cndAll)
 cnd_give()
void giveISR (bool _all=cndAll)
 cnd_giveISR()
void notifyOne ()
 cnd_notifyOne()
void notifyAll ()
 cnd_notifyAll()
template<typename T, typename F>
int waitFor (mtx_t &_mtx, const T &_delay, F _stopWaiting)
 wait for given duration of time until _stopWaiting() returns true (E_SUCCESS)
template<typename T, typename F>
int waitUntil (mtx_t &_mtx, const T &_time, F _stopWaiting)
 wait until given timepoint until _stopWaiting() returns true (E_SUCCESS)
template<typename F>
int wait (mtx_t &_mtx, F _stopWaiting)
 wait indefinitely until _stopWaiting() returns true (E_SUCCESS)

Static Public Member Functions

static Ptr Create ()
 create and initialize dynamic object with manageable resources

Detailed Description

create and initialize a condition variable object

Member Function Documentation

◆ Create()

Ptr stateos::ConditionVariable::Create ( )
inlinestatic

create and initialize dynamic object with manageable resources

Returns
std::unique_pointer / pointer to ConditionVariable object
Note
use only in thread mode

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