#include <evo/ioasync_base.h>

Detailed Description

Timer expired event.

When activated, the on_timer() is called after a given amount of time elapses (i.e. when timer expires)
Use AsyncBase::set_timer() to activate

Public Member Functions
	OnTimer ()
	Constructor. More...

virtual	~OnTimer ()
	Destructor. More...

virtual void	on_timer ()=0
	Called when timer expires. More...

bool	timer_reset (ulong msec)
	Reset and activate timer so the on_timer() event is called after given time elapses. More...

Public Attributes
struct event *	timer_handle
	Internal handle for event. More...

ulong	timer_msec
	Timer value in milliseconds, set by timer_reset() More...

Constructor & Destructor Documentation

◆ OnTimer()

OnTimer ( )

inline

Constructor.

◆ ~OnTimer()

virtual ~OnTimer ( )

inlinevirtual

Destructor.

Member Function Documentation

◆ on_timer()

virtual void on_timer ( )

pure virtual

Called when timer expires.

When the timer expires it is deactivated
To reset (reactivate) the timer call timer_reset(), use timer_msec for last timer value

◆ timer_reset()

bool timer_reset ( ulong msec )

inline

Reset and activate timer so the on_timer() event is called after given time elapses.

On success this sets timer_msec

Parameters

msec	Amount of timer to trigger timer in milliseconds

Returns: Whether successful, false on internal error

Member Data Documentation

◆ timer_handle

struct event* timer_handle

Internal handle for event.

◆ timer_msec

ulong timer_msec

Timer value in milliseconds, set by timer_reset()

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

evo/ioasync_base.h