Timer class to use when scheduling realtime events. More...

#include <timers.h>

Inheritance diagram for Timer:

Public Types
typedef uint64_t	tick_t
Public Member Functions
void	clear (void)
	Clear pending timer, has no value.
timeout_t	get (void) const
	Get remaining time until the timer expires.
bool	isExpired (void)
	Check if timer expired.
bool	isUpdated (void)
	Check if timer has been updated since last check.
	operator bool () const
	Check if timer expired for is() expression.
bool	operator! () const
	Check if timer has expired.
bool	operator!= (const Timer &timer)
	Compare timers if not same timeout.
timeout_t	operator* () const
	Get remaining time until timer expires by reference.
Timer &	operator+= (time_t expire)
	Adjust timer expiration.
Timer &	operator+= (timeout_t expire)
	Adjust timer expiration.
timeout_t	operator- (const Timer &timer)
	Compute difference between two timers.
Timer &	operator-= (time_t expire)
	Adjust timer expiration.
Timer &	operator-= (timeout_t expire)
	Adjust timer expiration.
bool	operator< (const Timer &timer)
	Compare timers if earlier timeout than another timer.
bool	operator<= (const Timer &timer)
	Compare timers if earlier than or equal to another timer.
Timer &	operator= (timeout_t expire)
	Set timer expiration.
Timer &	operator= (time_t expire)
	Set timer expiration.
bool	operator== (const Timer &timer)
	Compare timers if same timeout.
bool	operator> (const Timer &timer)
	Compare timers if later timeout than another timer.
bool	operator>= (const Timer &timer)
	Compare timers if later than or equal to another timer.
void	set (void)
	Set (update) the timer with current time.
void	set (time_t expire)
	Set the timer to expire.
void	set (timeout_t expire)
	Set the timer to expire.
	Timer (time_t offset)
	Construct a triggered timer that expires at specified offset.
	Timer (const Timer &copy)
	Construct a timer from a copy of another timer.
	Timer (timeout_t offset)
	Construct a triggered timer that expires at specified offset.
	Timer ()
	Construct an untriggered timer set to the time of creation.
Static Public Member Functions
static void	sync (Timer &timer)
	Sleep current thread until the specified timer expires.
static tick_t	ticks (void)
	Get timer ticks since uuid epoch.
Static Public Attributes
static const timeout_t	inf
	A value to use for infinite time.
static const time_t	reset
	A value to use when resetting.
Friends
class	Conditional
class	Event
class	Semaphore

Detailed Description

Timer class to use when scheduling realtime events.

The timer generally uses millisecond values but has a microsecond accuracy. On platforms that support it, the timer uses posix realtime monotonic clock extensions, otherwise lower accuracy timer systems might be used.

Definition at line 49 of file timers.h.

Constructor & Destructor Documentation

Timer::Timer ( timeout_t offset )

Construct a triggered timer that expires at specified offset.

Parameters:

offset to expire in milliseconds.

Timer::Timer ( time_t offset )

Construct a triggered timer that expires at specified offset.

Parameters:

offset to expire in seconds.

Timer::Timer ( const Timer & copy )

Construct a timer from a copy of another timer.

Parameters:

copy	of timer to construct from.

Member Function Documentation

timeout_t Timer::get ( void ) const

Get remaining time until the timer expires.

Returns:: 0 if expired or milliseconds still waiting.

Reimplemented in TimerQueue::event.

bool Timer::isExpired ( void )

Check if timer expired.

Returns:: true if expired.

Reimplemented in TimerQueue::event.

bool Timer::isUpdated ( void )

Check if timer has been updated since last check.

Returns:: true if updated.

Timer::operator bool ( ) const

Check if timer expired for is() expression.

Returns:: true if timer expired.

bool Timer::operator! ( ) const

Check if timer has expired.

Returns:: true if timer still pending.

bool Timer::operator!= ( const Timer & timer )

Compare timers if not same timeout.

Parameters:

timer to compare with.

Returns:: true if not same.

timeout_t Timer::operator* ( ) const [inline]

Get remaining time until timer expires by reference.

Returns:: 0 if expired or milliseconds still waiting.

Definition at line 140 of file timers.h.

Timer& Timer::operator+= ( time_t expire )

Adjust timer expiration.

Parameters:

expire time to add in seconds.

Timer& Timer::operator+= ( timeout_t expire )

Adjust timer expiration.

Parameters:

expire time to add in milliseconds.

timeout_t Timer::operator- ( const Timer & timer )

Compute difference between two timers.

Parameters:

timer to use for difference.

Returns:: difference in milliseconds.

Timer& Timer::operator-= ( timeout_t expire )

Adjust timer expiration.

Parameters:

expire time to subtract in milliseconds.

Timer& Timer::operator-= ( time_t expire )

Adjust timer expiration.

Parameters:

expire time to subtract in seconds.

bool Timer::operator< ( const Timer & timer )

Compare timers if earlier timeout than another timer.

Parameters:

timer to compare with.

Returns:: true if earlier.

bool Timer::operator<= ( const Timer & timer )

Compare timers if earlier than or equal to another timer.

Parameters:

timer to compare with.

Returns:: true if earlier or same.

Timer& Timer::operator= ( time_t expire )

Set timer expiration.

Parameters:

expire timer in specified seconds.

Timer& Timer::operator= ( timeout_t expire )

Set timer expiration.

Parameters:

expire timer in milliseconds.

bool Timer::operator== ( const Timer & timer )

Compare timers if same timeout.

Parameters:

timer to compare with.

Returns:: true if same.

bool Timer::operator> ( const Timer & timer )

Compare timers if later timeout than another timer.

Parameters:

timer to compare with.

Returns:: true if later.

bool Timer::operator>= ( const Timer & timer )

Compare timers if later than or equal to another timer.

Parameters:

timer to compare with.

Returns:: true if later or same.

void Timer::set ( time_t expire )

Set the timer to expire.

Parameters:

expire time in seconds.

void Timer::set ( timeout_t expire )

Set the timer to expire.

Parameters:

expire time in milliseconds.

static void Timer::sync ( Timer & timer ) [static]

Sleep current thread until the specified timer expires.

Parameters:

timer to reference for sleep.

static tick_t Timer::ticks ( void ) [static]

Get timer ticks since uuid epoch.

Returns:: timer ticks in 100ns resolution.

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

ucommon/timers.h

Timer Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation