General timer class. More...

#include <Timer.h>

Inheritance diagram for trippingcyril::timing::Timer:

Collaboration diagram for trippingcyril::timing::Timer:

Public Member Functions
	Timer (const Module *module)

	Timer (const Module *module, double interval, unsigned int maxCycles=0)

virtual	~Timer ()

void	Start (double interval)

void	Start (struct timeval &tv)

void	StartMaxCycles (double interval, unsigned int maxCycles)

void	Stop ()

Public Member Functions inherited from trippingcyril::trippingcyril::Event
	Event (const Module *module)

virtual	~Event ()

const Module *	GetModule () const

Protected Member Functions
virtual void	RunJob ()=0

virtual void	Finished ()

Protected Member Functions inherited from trippingcyril::trippingcyril::Event
event_base *	GetEventBase () const

evdns_base *	GetDNSBase () const

Additional Inherited Members
Protected Attributes inherited from trippingcyril::trippingcyril::Event
const Module *	module

Detailed Description

General timer class.

Constructor & Destructor Documentation

trippingcyril::timing::Timer::Timer ( const Module * module )

General constructor

Parameters

module The module to register this timer on

trippingcyril::timing::Timer::Timer	(	const Module *	module,
		double	interval,
		unsigned int	maxCycles = `0`
	)

General constructor that will automatically start the timer

Parameters

module	The module to register this timer on
interval	The interval this timer should run on
maxCycles	The maximum amount of cycles this timer should run, 0 is infinite

virtual trippingcyril::timing::Timer::~Timer ( )

virtual

General deconstructor

virtual void trippingcyril::timing::Timer::Finished ( )

inlineprotectedvirtual

Called once our timer has ran its last cycle, will not get called if you delete the timer yourself.

virtual void trippingcyril::timing::Timer::RunJob ( )

protectedpure virtual

Called on every interval

void trippingcyril::timing::Timer::Start ( double interval )

Starts the timer with interval

void trippingcyril::timing::Timer::Start ( struct timeval & tv )

Starts the timer with tv as its interval

void trippingcyril::timing::Timer::StartMaxCycles	(	double	interval,
		unsigned int	maxCycles
	)

Starts the timer with interval, but it'll only run for maxCycles

void trippingcyril::timing::Timer::Stop ( )

Stops the timer and it'll get deleted as soon as possible.

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