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

create and initialize a signal object More...

#include <ossignal.h>

Inheritance diagram for stateos::Signal:

Public Types

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

Public Member Functions

constexpr Signal ()
 constructor, see the constructor parameters of the class
 Signal (Signal &&_src)
 move constructor
 Signal (const Signal &)=delete
Signal & operator= (Signal &&)=delete
Signal & operator= (const Signal &)=delete
void reset ()
 sig_reset()
void kill ()
 sig_kill()
void destroy ()
 sig_destroy()
int take (unsigned _sigset, unsigned *_signo=nullptr)
 sig_take()
int tryWait (unsigned _sigset, unsigned *_signo=nullptr)
 sig_tryWait()
int takeISR (unsigned _sigset, unsigned *_signo=nullptr)
 sig_takeISR()
template<typename T>
int waitFor (unsigned _sigset, unsigned *_signo, const T &_delay)
 sig_waitFor()
template<typename T>
int waitUntil (unsigned _sigset, unsigned *_signo, const T &_time)
 sig_waitUntil()
int wait (unsigned _sigset, unsigned *_signo=nullptr)
 sig_wait()
void give (unsigned _signo)
 sig_give()
void set (unsigned _signo)
 sig_set()
void giveISR (unsigned _signo)
 sig_giveISR()
void clear (unsigned _signo)
 sig_clear()
void clearISR (unsigned _signo)
 sig_clearISR()

Static Public Member Functions

static Ptr Create ()
 create dynamic object with manageable resources

Detailed Description

create and initialize a signal object

Member Function Documentation

◆ Create()

Ptr stateos::Signal::Create ( )
inlinestatic

create dynamic object with manageable resources

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

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