geopm::SleepWaiter Class Reference

Class to support a periodic wait loop based on clock_nanosleep() using CLOCK_REALTIME. More...

#include <Waiter.hpp>

Inheritance diagram for geopm::SleepWaiter:

Collaboration diagram for geopm::SleepWaiter:

Public Member Functions
	SleepWaiter (double period)
virtual	~SleepWaiter ()=default
void	reset (void) override
	Reset the timer for next wait.
void	reset (double period) override
	Reset the timer for next wait and set period.
void	wait (void) override
	Wait until the period has elapsed since last call to reset() or wait()
double	period (void) const override
	Get the period for the waiter.
Public Member Functions inherited from geopm::Waiter
	Waiter ()=default
virtual	~Waiter ()=default

Additional Inherited Members
Static Public Member Functions inherited from geopm::Waiter
static std::unique_ptr< Waiter >	make_unique (double period)
	Create a Waiter with "sleep" strategy.
static std::unique_ptr< Waiter >	make_unique (double period, std::string strategy)
	Create a Waiter.

Detailed Description

Class to support a periodic wait loop based on clock_nanosleep() using CLOCK_REALTIME.

Constructor & Destructor Documentation

SleepWaiter()

geopm::SleepWaiter::SleepWaiter

(

double

period

)

~SleepWaiter()

virtual geopm::SleepWaiter::~SleepWaiter ( )

virtualdefault

Member Function Documentation

period()

double geopm::SleepWaiter::period ( void  ) const

overridevirtual

Get the period for the waiter.

Returns

The duration of the wait

Implements geopm::Waiter.

reset() [1/2]

void geopm::SleepWaiter::reset ( double  period )

overridevirtual

Reset the timer for next wait and set period.

Parameters

[in]

period

Duration in seconds to wait

Implements geopm::Waiter.

reset() [2/2]

void geopm::SleepWaiter::reset ( void  )

overridevirtual

Reset the timer for next wait.

Implements geopm::Waiter.

wait()

void geopm::SleepWaiter::wait ( void  )

overridevirtual

Wait until the period has elapsed since last call to reset() or wait()

Implements geopm::Waiter.

---

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

• Waiter.hpp
• Waiter.cpp