so_5::timer_id_t Class Reference

An indentificator for the timer. More...

#include <timers.hpp>

Public Member Functions
	timer_id_t () noexcept=default
	Default constructor. More...
	timer_id_t (so_5::intrusive_ptr_t< timer_t > &&timer) noexcept
	Initializing constructor. More...
void	swap (timer_id_t &o) noexcept
	Swapping. More...
bool	is_active () const noexcept
	Is this timer event is active? More...
void	release () noexcept
	Release the timer event. More...

Private Attributes
so_5::intrusive_ptr_t< timer_t >	m_timer
	Actual timer. More...

Detailed Description

An indentificator for the timer.

Since

v.5.5.0

Examples:

so_5/chstate/main.cpp, so_5/chstate_msg_tracing/main.cpp, so_5/hello_periodic/main.cpp, so_5/intercom_statechart/main.cpp, so_5/machine_control/main.cpp, so_5/mchain_handler_formats/main.cpp, and so_5/stop_guard/main.cpp.

Constructor & Destructor Documentation

timer_id_t() [1/2]

so_5::timer_id_t::timer_id_t ( )

defaultnoexcept

Default constructor.

timer_id_t() [2/2]

so_5::timer_id_t::timer_id_t ( so_5::intrusive_ptr_t< timer_t > &&  timer )

inlinenoexcept

Initializing constructor.

Member Function Documentation

is_active()

bool so_5::timer_id_t::is_active ( ) const

inlinenoexcept

Is this timer event is active?

release()

void so_5::timer_id_t::release ( )

inlinenoexcept

Release the timer event.

swap()

void so_5::timer_id_t::swap ( timer_id_t &  o )

inlinenoexcept

Swapping.

Member Data Documentation

m_timer

so_5::intrusive_ptr_t< timer_t > so_5::timer_id_t::m_timer

private

Actual timer.

---

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

• timers.hpp