Kea  1.5.0
isc::asiolink::IntervalTimerImpl Class Reference

This class holds a call back function of asynchronous operations. More...

+ Inheritance diagram for isc::asiolink::IntervalTimerImpl:

Public Member Functions

 IntervalTimerImpl (IOService &io_service)
 
 ~IntervalTimerImpl ()
 
void callback (const boost::system::error_code &error)
 
void cancel ()
 
long getInterval () const
 
void setup (const IntervalTimer::Callback &cbfunc, const long interval, const IntervalTimer::Mode &interval_mode=IntervalTimer::REPEATING)
 

Detailed Description

This class holds a call back function of asynchronous operations.

To ensure the object is alive while an asynchronous operation refers to it, we use shared_ptr and enable_shared_from_this. The object will be destructed in case IntervalTimer has been destructed and no asynchronous operation refers to it. Please follow the link to get an example: http://think-async.com/asio/asio-1.4.8/doc/asio/tutorial/tutdaytime3.html#asio.tutorial.tutdaytime3.the_tcp_connection_class

Definition at line 28 of file interval_timer.cc.

Constructor & Destructor Documentation

◆ IntervalTimerImpl()

isc::asiolink::IntervalTimerImpl::IntervalTimerImpl ( IOService io_service)

Definition at line 65 of file interval_timer.cc.

◆ ~IntervalTimerImpl()

isc::asiolink::IntervalTimerImpl::~IntervalTimerImpl ( )

Definition at line 70 of file interval_timer.cc.

Member Function Documentation

◆ callback()

void isc::asiolink::IntervalTimerImpl::callback ( const boost::system::error_code &  error)

Definition at line 117 of file interval_timer.cc.

References isc::asiolink::IntervalTimer::REPEATING.

◆ cancel()

void isc::asiolink::IntervalTimerImpl::cancel ( )
inline

Definition at line 42 of file interval_timer.cc.

◆ getInterval()

long isc::asiolink::IntervalTimerImpl::getInterval ( ) const
inline

Definition at line 46 of file interval_timer.cc.

◆ setup()

void isc::asiolink::IntervalTimerImpl::setup ( const IntervalTimer::Callback cbfunc,
const long  interval,
const IntervalTimer::Mode interval_mode = IntervalTimer::REPEATING 
)

Definition at line 75 of file interval_timer.cc.

References isc_throw.


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