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

#include <timers.h>

Inheritance diagram for ucommon::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. More...

	operator bool () const
	Check if timer expired for is() expression. More...

bool	operator! () const
	Check if timer has expired. More...

bool	operator!= (const Timer &timer) const
	Compare timers if not same timeout. More...

timeout_t	operator* () const
	Get remaining time until timer expires by reference. More...

Timer &	operator+= (time_t expire)
	Adjust timer expiration. More...

Timer &	operator+= (timeout_t expire)
	Adjust timer expiration. More...

timeout_t	operator- (const Timer &timer)
	Compute difference between two timers. More...

Timer &	operator-= (time_t expire)
	Adjust timer expiration. More...

Timer &	operator-= (timeout_t expire)
	Adjust timer expiration. More...

bool	operator< (const Timer &timer) const
	Compare timers if earlier timeout than another timer. More...

bool	operator<= (const Timer &timer) const
	Compare timers if earlier than or equal to another timer. More...

Timer &	operator= (time_t expire)
	Set timer expiration. More...

Timer &	operator= (timeout_t expire)
	Set timer expiration. More...

bool	operator== (const Timer &timer) const
	Compare timers if same timeout. More...

bool	operator> (const Timer &timer) const
	Compare timers if later timeout than another timer. More...

bool	operator>= (const Timer &timer) const
	Compare timers if later than or equal to another timer. More...

void	set (timeout_t expire)
	Set the timer to expire. More...

void	set (time_t expire)
	Set the timer to expire. More...

void	set (void)
	Set (update) the timer with current time.

	Timer ()
	Construct an untriggered timer set to the time of creation.

	Timer (timeout_t offset)
	Construct a triggered timer that expires at specified offset. More...

	Timer (time_t offset)
	Construct a triggered timer that expires at specified offset. More...

	Timer (const Timer &copy)
	Construct a timer from a copy of another timer. More...

Static Public Member Functions
static void	sync (Timer &timer)
	Sleep current thread until the specified timer expires. More...

static tick_t	ticks (void)
	Get timer ticks since uuid epoch. More...

Static Public Attributes
static const timeout_t	inf = ((timeout_t)(-1))

static const time_t	reset = ((time_t)(0))

Protected Member Functions
bool	is_active (void) const
	Check if timer active. More...

bool	update (void)
	Check if timer has been updated since last check. More...

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 50 of file timers.h.

Constructor & Destructor Documentation

◆ Timer() [1/3]

ucommon::Timer::Timer ( timeout_t offset )

Construct a triggered timer that expires at specified offset.

Parameters

offset to expire in milliseconds.

◆ Timer() [2/3]

ucommon::Timer::Timer ( time_t offset )

Construct a triggered timer that expires at specified offset.

Parameters

offset to expire in seconds.

◆ Timer() [3/3]

ucommon::Timer::Timer ( const Timer & copy )

Construct a timer from a copy of another timer.

Parameters

copy	of timer to construct from.

Member Function Documentation

◆ get()

timeout_t ucommon::Timer::get ( void ) const

Get remaining time until the timer expires.

Returns: 0 if expired or milliseconds still waiting.

◆ is_active()

bool ucommon::Timer::is_active ( void ) const

protected

Check if timer active.

Returns: true if active.

◆ operator bool()

ucommon::Timer::operator bool ( ) const

Check if timer expired for is() expression.

Returns: true if timer expired.

◆ operator!()

bool ucommon::Timer::operator! ( ) const

Check if timer has expired.

Returns: true if timer still pending.

◆ operator!=()

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

Compare timers if not same timeout.

Parameters

timer to compare with.

Returns: true if not same.

◆ operator*()

timeout_t ucommon::Timer::operator* ( ) const

inline

Get remaining time until timer expires by reference.

Returns: 0 if expired or milliseconds still waiting.

Definition at line 144 of file timers.h.

◆ operator+=() [1/2]

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

Adjust timer expiration.

Parameters

expire time to add in seconds.

◆ operator+=() [2/2]

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

Adjust timer expiration.

Parameters

expire time to add in milliseconds.

◆ operator-()

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

Compute difference between two timers.

Parameters

timer to use for difference.

Returns: difference in milliseconds.

◆ operator-=() [1/2]

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

Adjust timer expiration.

Parameters

expire time to subtract in seconds.

◆ operator-=() [2/2]

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

Adjust timer expiration.

Parameters

expire time to subtract in milliseconds.

◆ operator<()

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

Compare timers if earlier timeout than another timer.

Parameters

timer to compare with.

Returns: true if earlier.

◆ operator<=()

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

Compare timers if earlier than or equal to another timer.

Parameters

timer to compare with.

Returns: true if earlier or same.

◆ operator=() [1/2]

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

Set timer expiration.

Parameters

expire timer in specified seconds.

◆ operator=() [2/2]

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

Set timer expiration.

Parameters

expire timer in milliseconds.

◆ operator==()

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

Compare timers if same timeout.

Parameters

timer to compare with.

Returns: true if same.

◆ operator>()

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

Compare timers if later timeout than another timer.

Parameters

timer to compare with.

Returns: true if later.

◆ operator>=()

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

Compare timers if later than or equal to another timer.

Parameters

timer to compare with.

Returns: true if later or same.

◆ set() [1/2]

void ucommon::Timer::set ( timeout_t expire )

Set the timer to expire.

Parameters

expire time in milliseconds.

◆ set() [2/2]

void ucommon::Timer::set ( time_t expire )

Set the timer to expire.

Parameters

expire time in seconds.

◆ sync()

static void ucommon::Timer::sync ( Timer & timer )

static

Sleep current thread until the specified timer expires.

Parameters

timer to reference for sleep.

◆ ticks()

static tick_t ucommon::Timer::ticks ( void )

static

Get timer ticks since uuid epoch.

Returns: timer ticks in 100ns resolution.

◆ update()

bool ucommon::Timer::update ( void )

protected

Check if timer has been updated since last check.

This also sets updated false.

Returns: true if was updated.

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

ucommon/timers.h

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Timer() [1/3]

◆ Timer() [2/3]

◆ Timer() [3/3]

Member Function Documentation

◆ get()

◆ is_active()

◆ operator bool()

◆ operator!()

◆ operator!=()

◆ operator*()

◆ operator+=() [1/2]

◆ operator+=() [2/2]

◆ operator-()

◆ operator-=() [1/2]

◆ operator-=() [2/2]

◆ operator<()

◆ operator<=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ operator>()

◆ operator>=()

◆ set() [1/2]

◆ set() [2/2]

◆ sync()

◆ ticks()

◆ update()