timertt::timer_heap_manager_template< Thread_Safety, Timer_Action, Error_Logger, Actor_Exception_Handler > Class Template Reference

A timer heap manager template. More...

#include <all.hpp>

Inheritance diagram for timertt::timer_heap_manager_template< Thread_Safety, Timer_Action, Error_Logger, Actor_Exception_Handler >:

Public Member Functions
	timer_heap_manager_template ()
	Default constructor.
	timer_heap_manager_template (std::size_t initial_heap_capacity)
	Constructor to specify initial capacity of heap-array.
	timer_heap_manager_template (std::size_t initial_heap_capacity, Error_Logger error_logger, Actor_Exception_Handler exception_handler)
	Constructor with all parameters.
Public Member Functions inherited from timertt::details::manager_impl_template< details::timer_heap_engine< Thread_Safety, default_timer_action_type, default_error_logger, default_actor_exception_handler > >
	manager_impl_template (Args &&... args)
	Constructor with all parameters.
void	reset ()
	Reset all timers and return manager to the initial state.
void	process_expired_timers ()
	Perform processing of expired timers.
std::tuple< bool, monotonic_clock::time_point >	nearest_time_point ()
	Get the time for next process_expired_timers invocation.
monotonic_clock::duration	timeout_before_nearest_timer (Duration default_timeout)
	Get the sleeping time before the earlist timer expiration.
Public Member Functions inherited from timertt::details::basic_methods_impl_mixin< details::timer_heap_engine< Thread_Safety, default_timer_action_type, default_error_logger, default_actor_exception_handler >, consumer_type::manager >
	basic_methods_impl_mixin (Args &&... args)
	Constructor with all parameters.
timer_holder	allocate ()
	Allocate of new timer object.
void	activate (timer_holder timer, Duration_1 pause, timer_action action)
	Activate timer and schedule it for execution.
void	activate (scoped_timer_object &timer, Duration_1 pause, timer_action action)
	Activate a scoped timer and schedule it for execution.
void	activate (Duration_1 pause, timer_action action)
	Activate timer and schedule it for execution.
void	activate (timer_holder timer, Duration_1 pause, Duration_2 period, timer_action action)
	Activate timer and schedule it for execution.
void	activate (scoped_timer_object &timer, Duration_1 pause, Duration_2 period, timer_action action)
	Activate a scoped timer and schedule it for execution.
void	activate (Duration_1 pause, Duration_2 period, timer_action action)
	Activate timer and schedule it for execution.
void	reschedule (timer_holder timer, Duration_1 pause, timer_action action)
	Perform an attempt to reschedule a timer.
void	reschedule (timer_holder timer, Duration_1 pause, Duration_2 period, timer_action action)
	Perform an attempt to reschedule a timer.
void	deactivate (timer_holder timer)
	Deactivate timer and remove it from the list.
void	deactivate (scoped_timer_object &timer)
	Deactivate timer and remove it from the list.
timer_quantities	get_timer_quantities ()
	Count of timers of various types.
bool	empty ()
	Check for emptiness.

Private Types
using	base_type
	Shorthand for base type.

Additional Inherited Members
Public Types inherited from timertt::details::basic_methods_impl_mixin< details::timer_heap_engine< Thread_Safety, default_timer_action_type, default_error_logger, default_actor_exception_handler >, consumer_type::manager >
using	thread_safety
	A typedef for thread safety type from Engine.
using	timer_action
	An alias for timer_action type.
using	scoped_timer_object
	An alias for scoped timer objects.
using	timer_holder
	Shorthand for timer objects' smart pointer.
Static Public Member Functions inherited from timertt::details::timer_heap_engine_defaults
static std::size_t	default_initial_heap_capacity ()
	Default initial capacity of heap-array.
Protected Attributes inherited from timertt::details::basic_methods_impl_mixin< details::timer_heap_engine< Thread_Safety, default_timer_action_type, default_error_logger, default_actor_exception_handler >, consumer_type::manager >
details::timer_heap_engine< Thread_Safety, default_timer_action_type, default_error_logger, default_actor_exception_handler >	m_engine
	Actual timer engine instance.

Detailed Description

template<typename Thread_Safety, typename Timer_Action = default_timer_action_type, typename Error_Logger = default_error_logger, typename Actor_Exception_Handler = default_actor_exception_handler>
class timertt::timer_heap_manager_template< Thread_Safety, Timer_Action, Error_Logger, Actor_Exception_Handler >

A timer heap manager template.

Note

Please see description of details::timer_heap_engine for the details about this timer mechanism.

Template Parameters

Thread_Safety	Thread-safety indicator. Must be timertt::thread_safety::unsafe or timertt::thread_safety::safe.
Timer_Action	type of functor to perform an user-defined action when timer expires. This must be Moveable and MoveConstructible type.
Error_Logger	type of logger for errors detected during timer handling. Interface for error logger is defined by default_error_logger class.
Actor_Exception_Handler	type of handler for dealing with exceptions thrown from timer actors. Interface for exception handler is defined by default_actor_exception_handler.

Definition at line 4110 of file 3rd_party/timertt/all.hpp.

Member Typedef Documentation

base_type

template<typename Thread_Safety , typename Timer_Action = default_timer_action_type, typename Error_Logger = default_error_logger, typename Actor_Exception_Handler = default_actor_exception_handler>

using timertt::timer_heap_manager_template< Thread_Safety, Timer_Action, Error_Logger, Actor_Exception_Handler >::base_type

private

Initial value:

 
    details::manager_impl_template<
        details::timer_heap_engine<
            Thread_Safety,
            Timer_Action,
            Error_Logger,
            Actor_Exception_Handler > >

Shorthand for base type.

Definition at line 4120 of file 3rd_party/timertt/all.hpp.

Constructor & Destructor Documentation

timer_heap_manager_template() [1/3]

template<typename Thread_Safety , typename Timer_Action = default_timer_action_type, typename Error_Logger = default_error_logger, typename Actor_Exception_Handler = default_actor_exception_handler>

timertt::timer_heap_manager_template< Thread_Safety, Timer_Action, Error_Logger, Actor_Exception_Handler >::timer_heap_manager_template ( )

inline

Default constructor.

Value default_initial_heap_capacity() is used as initial heap array size.

Definition at line 4134 of file 3rd_party/timertt/all.hpp.

timer_heap_manager_template() [2/3]

template<typename Thread_Safety , typename Timer_Action = default_timer_action_type, typename Error_Logger = default_error_logger, typename Actor_Exception_Handler = default_actor_exception_handler>

timertt::timer_heap_manager_template< Thread_Safety, Timer_Action, Error_Logger, Actor_Exception_Handler >::timer_heap_manager_template ( std::size_t initial_heap_capacity )

inline

Constructor to specify initial capacity of heap-array.

Parameters

initial_heap_capacity

An initial size for heap array.

Definition at line 4142 of file 3rd_party/timertt/all.hpp.

timer_heap_manager_template() [3/3]

template<typename Thread_Safety , typename Timer_Action = default_timer_action_type, typename Error_Logger = default_error_logger, typename Actor_Exception_Handler = default_actor_exception_handler>

timertt::timer_heap_manager_template< Thread_Safety, Timer_Action, Error_Logger, Actor_Exception_Handler >::timer_heap_manager_template ( std::size_t initial_heap_capacity, Error_Logger error_logger, Actor_Exception_Handler exception_handler )

inline

Constructor with all parameters.

Parameters

initial_heap_capacity	An initial size for heap array.
error_logger	An error logger for timer thread.
exception_handler	An actor exception handler for timer thread.

Definition at line 4152 of file 3rd_party/timertt/all.hpp.

---

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

• 3rd_party/timertt/all.hpp