cosmos::TimerFD< CLOCK >::TimerSpec Struct Reference

Combined start time and repeat interval for a TimerFD setting. More...

#include <TimerFD.hxx>

Inheritance diagram for cosmos::TimerFD< CLOCK >::TimerSpec:

Public Member Functions
	TimerSpec ()
	Creates all zero time specs.
TimeSpec< CLOCK > &	initial ()
	The initial tick time (relative or absolute) for the timer.
TimeSpec< CLOCK > &	interval ()
	Timer tick repeat interval (relative) if any.
void	makeEqualInterval ()
	Sets the interval to the same value as the initial time.
void	resetInterval ()
	Sets the interval to zero, thus creating a single-tick timer.

Detailed Description

template<ClockType CLOCK>
struct cosmos::TimerFD< CLOCK >::TimerSpec

Combined start time and repeat interval for a TimerFD setting.

Definition at line 64 of file TimerFD.hxx.

Constructor & Destructor Documentation

TimerSpec()

template<ClockType CLOCK>

cosmos::TimerFD< CLOCK >::TimerSpec::TimerSpec ( )

inline

Creates all zero time specs.

Definition at line 68 of file TimerFD.hxx.

                            {
                        initial().reset();
                        interval().reset();
                }

Member Function Documentation

initial()

template<ClockType CLOCK>

TimeSpec< CLOCK > & cosmos::TimerFD< CLOCK >::TimerSpec::initial ( )

inline

The initial tick time (relative or absolute) for the timer.

By default this specifies the relative tick time measured relative to the current clock value. If StartFlag::ABSTIME is specified then this is an absolute clock timestamp when the timer is to tick.

If this is all zero then the timer will be disarmed, no matter what value the interval() has.

Definition at line 83 of file TimerFD.hxx.

                                           {
                        // this is a bit hacky but allows us to return the C++
                        // interface for the raw timespec value
                        return *reinterpret_cast<TimeSpec<CLOCK>*>(&(this->it_value));
                }

interval()

template<ClockType CLOCK>

TimeSpec< CLOCK > & cosmos::TimerFD< CLOCK >::TimerSpec::interval ( )

inline

Timer tick repeat interval (relative) if any.

This is a relative time value that controls if and how quickly the timer will tick again after the initial tick occurred. If set to all zeroes then the timer will tick only once.

Definition at line 96 of file TimerFD.hxx.

                                            {
                        return *reinterpret_cast<TimeSpec<CLOCK>*>(&(this->it_interval));
                }

makeEqualInterval()

template<ClockType CLOCK>

void cosmos::TimerFD< CLOCK >::TimerSpec::makeEqualInterval ( )

inline

Sets the interval to the same value as the initial time.

This only works if relative time is used for the initial TimeSpec. The interval TimeSpec will be set to the same value, causing the timer to tick in equal time spans relative to the current clock value.

Definition at line 107 of file TimerFD.hxx.

                                         {
                        interval() = initial();
                }

resetInterval()

template<ClockType CLOCK>

void cosmos::TimerFD< CLOCK >::TimerSpec::resetInterval ( )

inline

Sets the interval to zero, thus creating a single-tick timer.

Definition at line 112 of file TimerFD.hxx.

                                     {
                        interval().reset();
                }

---

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

• include/time/TimerFD.hxx