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.
	timer_id_t (so_5::intrusive_ptr_t< timer_t > &&timer) noexcept
	Initializing constructor.
bool	is_active () const noexcept
	Is this timer event is active?
void	release () noexcept
	Release the timer event.

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

Friends
void	swap (timer_id_t &a, timer_id_t &b) noexcept
	Swapping.

Detailed Description

An indentificator for the timer.

Since

v.5.5.0

Examples

so_5/agent_name/main.cpp, so_5/bind_transformer/main.cpp, so_5/child_soenv/main.cpp, 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.

Definition at line 72 of file timers.hpp.

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.

Definition at line 78 of file timers.hpp.

Member Function Documentation

is_active()

bool so_5::timer_id_t::is_active ( ) const

inlinenoexcept

Is this timer event is active?

Definition at line 92 of file timers.hpp.

release()

void so_5::timer_id_t::release ( )

inlinenoexcept

Release the timer event.

Examples

so_5/intercom_statechart/main.cpp.

Definition at line 99 of file timers.hpp.

Friends And Related Symbol Documentation

swap

void swap ( timer_id_t & a, timer_id_t & b )

friend

Swapping.

Definition at line 85 of file timers.hpp.

Member Data Documentation

m_timer

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

private

Actual timer.

Definition at line 107 of file timers.hpp.

---

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

• timers.hpp