rad 6.2.0
Loading...
Searching...
No Matches
Public Member Functions | List of all members
rad::Signal Class Reference

#include <signal.hpp>

Public Member Functions

 Signal (boost::asio::io_context &ios, SMAdapter &sm, UniqueEvent &&event)
 
virtual ~Signal ()
 
void Add (const int signal_number)
 
void Install (const int signal_number)
 
void Install (void)
 
void Cancel (void)
 
 Signal (const Signal &)=delete
 
Signaloperator= (const Signal &)=delete
 

Detailed Description

This class can be used to trigger an event when a UNIX signal is fired.

Constructor & Destructor Documentation

◆ Signal() [1/2]

rad::Signal::Signal ( boost::asio::io_context & ios,
SMAdapter & sm,
UniqueEvent && event )

Signal constructor.

Parameters
[in]iosEvent loop used for the timeout callback.
[in]smReference to the SM adapter used to trigger events.
[in]eventEvent associated to be triggered when the signal is detected.

◆ ~Signal()

rad::Signal::~Signal ( )
virtual

Cancel the signals.

◆ Signal() [2/2]

rad::Signal::Signal ( const Signal & )
delete

Member Function Documentation

◆ Add()

void rad::Signal::Add ( const int signal_number)

Defines which signal triggers the event.

Parameters
[in]signal_numberLinux signal to detect.

◆ Cancel()

void rad::Signal::Cancel ( void )

Cancel the triggering an event when signal is detected.

◆ Install() [1/2]

void rad::Signal::Install ( const int signal_number)

Defines which signal triggers the event.

Parameters
[in]signal_numberLinux signal to detect.

◆ Install() [2/2]

void rad::Signal::Install ( void )

◆ operator=()

Signal & rad::Signal::operator= ( const Signal & )
delete

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