so_5::timers_details::actual_timer_t< Timer > Class Template Reference

An actual implementation of timer interface. More...

Inheritance diagram for so_5::timers_details::actual_timer_t< Timer >:

Public Types
using	timer_holder_t = timertt::timer_object_holder< typename Timer::thread_safety >
	The actual type of timer holder for timertt. More...

Public Member Functions
	actual_timer_t (Timer *thread)
	Initialized constructor. More...
virtual	~actual_timer_t () SO_5_NOEXCEPT override
timer_holder_t &	timer_holder () SO_5_NOEXCEPT
virtual bool	is_active () const SO_5_NOEXCEPT override
	Is this timer event is active? More...
virtual void	release () SO_5_NOEXCEPT override
	Release the timer event. More...
Public Member Functions inherited from so_5::timer_t
virtual	~timer_t () SO_5_NOEXCEPT=default

Private Attributes
Timer *	m_thread
	Timer thread for the timer. More...
timer_holder_t	m_timer
	Underlying timer object reference. More...

Detailed Description

template<class Timer>
class so_5::timers_details::actual_timer_t< Timer >

An actual implementation of timer interface.

Since

v.5.5.0

Note

Since v.5.5.19 this template can be used with timer_thread and with timer_manager.

Template Parameters

Timer

A type of timertt-based thread/manager which implements timers.

Member Typedef Documentation

timer_holder_t

template<class Timer >

using so_5::timers_details::actual_timer_t< Timer >::timer_holder_t = timertt::timer_object_holder< typename Timer::thread_safety >

The actual type of timer holder for timertt.

Constructor & Destructor Documentation

actual_timer_t()

template<class Timer >

so_5::timers_details::actual_timer_t< Timer >::actual_timer_t ( Timer *  thread )

inline

Initialized constructor.

~actual_timer_t()

template<class Timer >

virtual so_5::timers_details::actual_timer_t< Timer >::~actual_timer_t ( )

inlineoverridevirtual

Member Function Documentation

is_active()

template<class Timer >

virtual bool so_5::timers_details::actual_timer_t< Timer >::is_active ( ) const

inlineoverridevirtual

Is this timer event is active?

Implements so_5::timer_t.

release()

template<class Timer >

virtual void so_5::timers_details::actual_timer_t< Timer >::release ( )

inlineoverridevirtual

Release the timer event.

Implements so_5::timer_t.

timer_holder()

template<class Timer >

timer_holder_t& so_5::timers_details::actual_timer_t< Timer >::timer_holder ( )

inline

Member Data Documentation

m_thread

template<class Timer >

Timer* so_5::timers_details::actual_timer_t< Timer >::m_thread

private

Timer thread for the timer.

nullptr means that timer is deactivated.

m_timer

template<class Timer >

timer_holder_t so_5::timers_details::actual_timer_t< Timer >::m_timer

private

Underlying timer object reference.

---

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

• timers.cpp