AceSmartSoft API Documentation
Public Member Functions | List of all members
SmartACE::ShutdownTimer Class Reference

#include <smartComponent.hh>

Inheritance diagram for SmartACE::ShutdownTimer:
SmartACE::TimerHandler

Public Member Functions

 ShutdownTimer (SmartComponent *comp)
 
virtual ~ShutdownTimer ()
 
void start (const Smart::Duration &timeout=std::chrono::seconds(2))
 
void stop ()
 
virtual void timerExpired (const Smart::TimePoint &abs_time, const void *act) override
 
- Public Member Functions inherited from SmartACE::TimerHandler
 TimerHandler ()
 
virtual ~TimerHandler ()
 
virtual void timerCancelled () override
 This method is called when the timer is cancelled. More...
 
virtual void timerDeleted (const void *act) override
 This method is called when the timer queue is destroyed and the timer is still contained in it. More...
 

Detailed Description

ShutdownTimer

This class implements a watchdog timer, which kills the component (given in the constructor) after a timeout. This helps to stop a component, even if the tasks of this component do not cooperate to shut-down and thus must be force-killed.

Constructor & Destructor Documentation

◆ ShutdownTimer()

SmartACE::ShutdownTimer::ShutdownTimer ( SmartComponent comp)

◆ ~ShutdownTimer()

virtual SmartACE::ShutdownTimer::~ShutdownTimer ( )
inlinevirtual

Member Function Documentation

◆ start()

void SmartACE::ShutdownTimer::start ( const Smart::Duration &  timeout = std::chrono::seconds(2))

◆ stop()

void SmartACE::ShutdownTimer::stop ( )

◆ timerExpired()

virtual void SmartACE::ShutdownTimer::timerExpired ( const Smart::TimePoint &  abs_time,
const void *  act 
)
overridevirtual

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