join::BasicTimer< ClockPolicy, ProactorType > Class Template Reference

base timer class. More...

#include <timer.hpp>

Inheritance diagram for join::BasicTimer< ClockPolicy, ProactorType >:

Collaboration diagram for join::BasicTimer< ClockPolicy, ProactorType >:

Public Types
enum class	State { Idle , Armed , Invoking , Closed }
	timer state. More...

Public Member Functions
	BasicTimer (ProactorType &proactor=ProactorThread::proactor())
	create instance.
	BasicTimer (const BasicTimer &other)=delete
	copy constructor.
BasicTimer &	operator= (const BasicTimer &other)=delete
	copy assignment operator.
	BasicTimer (BasicTimer &&other)=delete
	move constructor.
BasicTimer &	operator= (BasicTimer &&other)=delete
	move assignment operator.
	~BasicTimer () noexcept
	destroy instance.
template<class Rep , class Period , typename Func , typename... Args>
void	setOneShot (std::chrono::duration< Rep, Period > duration, Func &&callback, Args &&... args)
	arm the timer as a one-shot timer.
template<class Clock , class Duration , typename Func , typename... Args>
void	setOneShot (std::chrono::time_point< Clock, Duration > timePoint, Func &&callback, Args &&... args)
	arm the timer as a one-shot timer with absolute time.
template<class Rep , class Period , typename Func , typename... Args>
void	setInterval (std::chrono::duration< Rep, Period > duration, Func &&callback, Args &&... args)
	arm the timer as a periodic timer.
void	cancel () noexcept
	cancel the timer.
bool	active () const noexcept
	check if timer is running.
std::chrono::nanoseconds	remaining () const noexcept
	get the remaining time until expiration.
std::chrono::nanoseconds	interval () const noexcept
	get the interval of the running periodic timer.
bool	oneShot () const noexcept
	check if timer is a one-shot timer.

Static Public Member Functions
static constexpr int	type () noexcept
	get the timer type.

Additional Inherited Members
Protected Member Functions inherited from join::CompletionHandler
	CompletionHandler ()=default
	create instance.
	CompletionHandler (const CompletionHandler &other)=default
	copy constructor.
CompletionHandler &	operator= (const CompletionHandler &other)=default
	copy assignment operator.
	CompletionHandler (CompletionHandler &&other)=default
	move constructor.
CompletionHandler &	operator= (CompletionHandler &&other)=default
	move assignment operator.
virtual	~CompletionHandler ()=default
	destroy instance.

Detailed Description

template<class ClockPolicy, class ProactorType>
class join::BasicTimer< ClockPolicy, ProactorType >

base timer class.

Member Enumeration Documentation

State

template<class ClockPolicy , class ProactorType >

enum class join::BasicTimer::State

strong

timer state.

Enumerator
Idle	no callback armed.
Armed	a callback is armed.
Invoking	the callback is being invoked.
Closed	the timerfd read operation is no longer in flight.

Constructor & Destructor Documentation

BasicTimer() [1/3]

template<class ClockPolicy , class ProactorType >

join::BasicTimer< ClockPolicy, ProactorType >::BasicTimer ( ProactorType & proactor = ProactorThread::proactor () )

inlineexplicit

create instance.

Parameters

proactor

completion dispatcher.

BasicTimer() [2/3]

template<class ClockPolicy , class ProactorType >

join::BasicTimer< ClockPolicy, ProactorType >::BasicTimer ( const BasicTimer< ClockPolicy, ProactorType > & other )

delete

copy constructor.

Parameters

other

other object to copy.

BasicTimer() [3/3]

template<class ClockPolicy , class ProactorType >

join::BasicTimer< ClockPolicy, ProactorType >::BasicTimer ( BasicTimer< ClockPolicy, ProactorType > && other )

delete

move constructor.

Parameters

other

other object to move.

~BasicTimer()

template<class ClockPolicy , class ProactorType >

join::BasicTimer< ClockPolicy, ProactorType >::~BasicTimer ( )

inlinenoexcept

destroy instance.

Member Function Documentation

active()

template<class ClockPolicy , class ProactorType >

bool join::BasicTimer< ClockPolicy, ProactorType >::active ( ) const

inlinenoexcept

check if timer is running.

Returns

true if timer is active.

cancel()

template<class ClockPolicy , class ProactorType >

void join::BasicTimer< ClockPolicy, ProactorType >::cancel ( )

inlinenoexcept

cancel the timer.

interval()

template<class ClockPolicy , class ProactorType >

std::chrono::nanoseconds join::BasicTimer< ClockPolicy, ProactorType >::interval ( ) const

inlinenoexcept

get the interval of the running periodic timer.

Returns

interval duration in nanoseconds, zero if one-shot or inactive.

oneShot()

template<class ClockPolicy , class ProactorType >

bool join::BasicTimer< ClockPolicy, ProactorType >::oneShot ( ) const

inlinenoexcept

check if timer is a one-shot timer.

Returns

true if timer is a one-shot timer.

operator=() [1/2]

template<class ClockPolicy , class ProactorType >

BasicTimer & join::BasicTimer< ClockPolicy, ProactorType >::operator= ( BasicTimer< ClockPolicy, ProactorType > && other )

delete

move assignment operator.

Parameters

other

other object to assign.

Returns

assigned object.

operator=() [2/2]

template<class ClockPolicy , class ProactorType >

BasicTimer & join::BasicTimer< ClockPolicy, ProactorType >::operator= ( const BasicTimer< ClockPolicy, ProactorType > & other )

delete

copy assignment operator.

Parameters

other

other object to assign.

Returns

assigned object.

remaining()

template<class ClockPolicy , class ProactorType >

std::chrono::nanoseconds join::BasicTimer< ClockPolicy, ProactorType >::remaining ( ) const

inlinenoexcept

get the remaining time until expiration.

Returns

remaining duration.

setInterval()

template<class ClockPolicy , class ProactorType >

template<class Rep , class Period , typename Func , typename... Args>

void join::BasicTimer< ClockPolicy, ProactorType >::setInterval ( std::chrono::duration< Rep, Period > duration, Func && callback, Args &&... args )

inline

arm the timer as a periodic timer.

Parameters

duration	interval duration between timer expirations.
callback	function to call on each timer expiration.
args	callback arguments.

setOneShot() [1/2]

template<class ClockPolicy , class ProactorType >

template<class Rep , class Period , typename Func , typename... Args>

void join::BasicTimer< ClockPolicy, ProactorType >::setOneShot ( std::chrono::duration< Rep, Period > duration, Func && callback, Args &&... args )

inline

arm the timer as a one-shot timer.

Parameters

duration	timeout duration before timer expires.
callback	function to call when timer expires.
args	callback arguments.

setOneShot() [2/2]

template<class ClockPolicy , class ProactorType >

template<class Clock , class Duration , typename Func , typename... Args>

void join::BasicTimer< ClockPolicy, ProactorType >::setOneShot ( std::chrono::time_point< Clock, Duration > timePoint, Func && callback, Args &&... args )

inline

arm the timer as a one-shot timer with absolute time.

Parameters

timePoint	absolute time when timer should expire.
callback	function to call when timer expires.
args	callback arguments.

type()

template<class ClockPolicy , class ProactorType >

static constexpr int join::BasicTimer< ClockPolicy, ProactorType >::type ( )

inlinestaticconstexprnoexcept

get the timer type.

Returns

the timer type.

---

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

• core/include/join/clock.hpp
• core/include/join/timer.hpp