List of timers objects of class rofl::ctimer. More...

#include <ctimers.h>

Public Member Functions
virtual	~ctimers ()
	ctimers destructor

	ctimers ()
	ctimers default constructor

	ctimers (const rofl::ctimers &timers)
	ctimers copy constructor

Operators
ctimers &	operator= (const rofl::ctimers &t)
	Assignment operator.

Managing timers
bool	empty ()
	Deletes all timers in this timer list.

rofl::ctimer	get_next_timer ()
	Returns a copy of the next expiring timer in this timer list. More...

const rofl::ctimerid &	add_timer (const rofl::ctimer &t)
	Inserts a new timer into the timer list. More...

const rofl::ctimerid &	reset (const rofl::ctimerid &timer_id, const rofl::ctimespec &timespec)
	Resets an existing timer identifier by its handle with a new timeout value. More...

rofl::ctimer	get_expired_timer ()
	Returns the next timer from timer list, when it has already expired. More...

bool	pending (const rofl::ctimerid &timer_id)
	Checks whether a certain timer identified by the given handle is still pending. More...

void	cancel (const ctimerid &timer_id)
	Removes a timer identified by the given timer handle from this timer list. More...

void	clear ()
	Removes all timers from this timer list.

Friends
std::ostream &	operator<< (std::ostream &os, const rofl::ctimers &t)

Detailed Description

List of timers objects of class rofl::ctimer.

Member Function Documentation

const rofl::ctimerid& rofl::ctimers::add_timer ( const rofl::ctimer & t )

inline

Inserts a new timer into the timer list.

void rofl::ctimers::cancel ( const ctimerid & timer_id )

inline

Removes a timer identified by the given timer handle from this timer list.

Parameters

timer_id timer handle

rofl::ctimer rofl::ctimers::get_expired_timer ( )

inline

Returns the next timer from timer list, when it has already expired.

This method is used for reading in a loop all timers that have already expired. If no or no further timers have expired, an exception is thrown.

Exceptions

eTimersNotFound no (or no further) expired timer in timer list

rofl::ctimer rofl::ctimers::get_next_timer ( )

inline

Returns a copy of the next expiring timer in this timer list.

Exceptions

eTimersNotFound timer list is empty

bool rofl::ctimers::pending ( const rofl::ctimerid & timer_id )

inline

Checks whether a certain timer identified by the given handle is still pending.

Parameters

timer_id timer handle

const rofl::ctimerid& rofl::ctimers::reset	(	const rofl::ctimerid &	timer_id,
		const rofl::ctimespec &	timespec
	)

inline

Resets an existing timer identifier by its handle with a new timeout value.

Please note, the returned timer handle differs from the one previously identifying the timer!

Parameters

timer_id	handle to existing timer
timespec	new timeout value

Exceptions

eTimersNotFound timer handle not found

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