distortos  v0.4.0
object-oriented C++ RTOS for microcontrollers
distortos::SignalInformation Class Reference

SignalInformation class contains information about queued signal. More...

#include <SignalInformation.hpp>

Collaboration diagram for distortos::SignalInformation:
[legend]

Public Types

enum  Code : uint8_t { Code::generated, Code::queued }
 replacement for predefined si_code values More...
 

Public Member Functions

constexpr SignalInformation (const uint8_t signalNumber, const Code code, const sigval value)
 SignalInformation's constructor. More...
 
Code getCode () const
 
uint8_t getSignalNumber () const
 
sigval getValue () const
 

Private Attributes

sigval value_
 signal value (similar to si_value member of siginfo_t) More...
 
Code code_
 signal code (similar to si_code member of siginfo_t) More...
 
uint8_t signalNumber_
 signal number (similar to si_signo member of siginfo_t) More...
 

Detailed Description

SignalInformation class contains information about queued signal.

Similar to siginfo_t - http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/signal.h.html

Member Enumeration Documentation

◆ Code

enum distortos::SignalInformation::Code : uint8_t
strong

replacement for predefined si_code values

Enumerator
generated 

signal generated by Thread::generateSignal() or ThisThread::Signals::generateSignal() (similar to SI_USER)

queued 

signal queued by Thread::queueSignal() or ThisThread::Signals::queueSignal() (similar to SI_QUEUE)

Constructor & Destructor Documentation

◆ SignalInformation()

constexpr distortos::SignalInformation::SignalInformation ( const uint8_t  signalNumber,
const Code  code,
const sigval  value 
)
inline

SignalInformation's constructor.

Parameters
[in]signalNumberis the signal number (similar to si_signo member of siginfo_t)
[in]codeis the signal code (similar to si_code member of siginfo_t)
[in]valueis the signal value (similar to si_value member of siginfo_t)

Member Function Documentation

◆ getCode()

Code distortos::SignalInformation::getCode ( ) const
inline
Returns
signal code (similar to si_code member of siginfo_t)
Here is the caller graph for this function:

◆ getSignalNumber()

uint8_t distortos::SignalInformation::getSignalNumber ( ) const
inline
Returns
signal number (similar to si_signo member of siginfo_t)
Here is the caller graph for this function:

◆ getValue()

sigval distortos::SignalInformation::getValue ( ) const
inline
Returns
signal value (similar to si_value member of siginfo_t)
Here is the caller graph for this function:

Member Data Documentation

◆ code_

Code distortos::SignalInformation::code_
private

signal code (similar to si_code member of siginfo_t)

◆ signalNumber_

uint8_t distortos::SignalInformation::signalNumber_
private

signal number (similar to si_signo member of siginfo_t)

◆ value_

sigval distortos::SignalInformation::value_
private

signal value (similar to si_value member of siginfo_t)


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