rad  2.0.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
rad::Timer Class Reference

#include <timer.hpp>

Public Member Functions

 Timer (boost::asio::io_service &ios, SMAdapter &sm, UniqueEvent &&event)
 
virtual ~Timer ()
 
void Install (const long timeout)
 
void Cancel ()
 
 Timer (const Timer &)=delete
 
Timeroperator= (const Timer &)=delete
 
 Timer (boost::asio::io_service &ios, SMAdapter &sm, UniqueEvent &&event)
 
virtual ~Timer ()
 
void Install (const long timeout)
 
void Cancel ()
 
 Timer (const Timer &)=delete
 
Timeroperator= (const Timer &)=delete
 

Detailed Description

This class can be used to trigger an event when a timer expires.

Constructor & Destructor Documentation

rad::Timer::Timer ( boost::asio::io_service &  ios,
SMAdapter sm,
UniqueEvent &&  event 
)
Parameters
[in]iosEvent loop used by the application.
[in]smReference to the SM adapter used to trigger events.
[in]eventEvent to be triggered when the timer expires.
rad::Timer::~Timer ( )
virtual

Cancel the timer if it is active.

rad::Timer::Timer ( const Timer )
delete
rad::Timer::Timer ( boost::asio::io_service &  ios,
SMAdapter sm,
UniqueEvent &&  event 
)
virtual rad::Timer::~Timer ( )
virtual
rad::Timer::Timer ( const Timer )
delete

Member Function Documentation

void rad::Timer::Cancel ( void  )

Cancel an installed deadline timer.

void rad::Timer::Cancel ( )
void rad::Timer::Install ( const long  timeout)

Install a deadline timer that expires after the given time.

Parameters
[in]timeoutDeadline time in msec. from now.
void rad::Timer::Install ( const long  timeout)
Timer& rad::Timer::operator= ( const Timer )
delete
Timer& rad::Timer::operator= ( const Timer )
delete

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