A timer heap thread template. More...
#include <all.hpp>
Inheritance diagram for timertt::timer_heap_thread_template< Timer_Action, Error_Logger, Actor_Exception_Handler >:
Public Member Functions | |
| timer_heap_thread_template () | |
| Default constructor. More... | |
| timer_heap_thread_template (std::size_t initial_heap_capacity) | |
| Constructor to specify initial capacity of heap-array. More... | |
| timer_heap_thread_template (std::size_t initial_heap_capacity, Error_Logger error_logger, Actor_Exception_Handler exception_handler) | |
| Constructor with all parameters. More... | |
 Public Member Functions inherited from timertt::details::thread_impl_template< details::timer_heap_engine< ::timertt::thread_safety::safe, Timer_Action, Error_Logger, Actor_Exception_Handler > > | |
| thread_impl_template (Args &&... args) | |
| Constructor with all parameters. More... | |
| ~thread_impl_template () | |
| Destructor. More... | |
| void | start () |
| Start timer thread. More... | |
| void | shutdown () |
| Initiate shutdown for the timer thread without waiting for completion. More... | |
| void | join () |
| Wait for completion of timer thread. More... | |
| void | shutdown_and_join () |
| Initiate shutdown and wait for completion. More... | |
| Public Member Functions inherited from timertt::details::basic_methods_impl_mixin< details::timer_heap_engine< ::timertt::thread_safety::safe, Timer_Action, Error_Logger, Actor_Exception_Handler >, consumer_type::thread > | |
| basic_methods_impl_mixin (Args &&... args) | |
| Constructor with all parameters. More... | |
| timer_holder | allocate () |
| Allocate of new timer object. More... | |
| void | activate (timer_holder timer, Duration_1 pause, timer_action action) |
| Activate timer and schedule it for execution. More... | |
| void | activate (scoped_timer_object &timer, Duration_1 pause, timer_action action) |
| Activate a scoped timer and schedule it for execution. More... | |
| void | activate (Duration_1 pause, timer_action action) |
| Activate timer and schedule it for execution. More... | |
| void | activate (timer_holder timer, Duration_1 pause, Duration_2 period, timer_action action) |
| Activate timer and schedule it for execution. More... | |
| void | activate (scoped_timer_object &timer, Duration_1 pause, Duration_2 period, timer_action action) |
| Activate a scoped timer and schedule it for execution. More... | |
| void | activate (Duration_1 pause, Duration_2 period, timer_action action) |
| Activate timer and schedule it for execution. More... | |
| void | reschedule (timer_holder timer, Duration_1 pause, timer_action action) |
| Perform an attempt to reschedule a timer. More... | |
| void | reschedule (timer_holder timer, Duration_1 pause, Duration_2 period, timer_action action) |
| Perform an attempt to reschedule a timer. More... | |
| void | deactivate (timer_holder timer) |
| Deactivate timer and remove it from the list. More... | |
| void | deactivate (scoped_timer_object &timer) |
| Deactivate timer and remove it from the list. More... | |
| timer_quantities | get_timer_quantities () |
| Count of timers of various types. More... | |
| bool | empty () |
| Check for emptiness. More... | |
Private Types | |
| using | base_type = details::thread_impl_template< details::timer_heap_engine< ::timertt::thread_safety::safe, Timer_Action, Error_Logger, Actor_Exception_Handler > > |
| Shorthand for base type. More... | |
Detailed Description
template<typename Timer_Action, typename Error_Logger, typename Actor_Exception_Handler>
class timertt::timer_heap_thread_template< Timer_Action, Error_Logger, Actor_Exception_Handler >
A timer heap thread template.
- Note
- Please see description of details::timer_heap_engine for the details about this timer mechanism.
- Template Parameters
-
Error_Logger type of logger for errors detected during timer thread execution. Interface for error logger is defined by default_error_logger class. Timer_Action type of functor to perform an user-defined action when timer expires. This must be Moveable and MoveConstructible type. 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.
Member Typedef Documentation
◆ base_type
template<typename Timer_Action , typename Error_Logger , typename Actor_Exception_Handler >
|
private |
Shorthand for base type.
Constructor & Destructor Documentation
◆ timer_heap_thread_template() [1/3]
template<typename Timer_Action , typename Error_Logger , typename Actor_Exception_Handler >
|
inline |
Default constructor.
Value default_initial_heap_capacity() is used as initial heap array size.
◆ timer_heap_thread_template() [2/3]
template<typename Timer_Action , typename Error_Logger , typename Actor_Exception_Handler >
|
inline |
Constructor to specify initial capacity of heap-array.
- Parameters
-
initial_heap_capacity An initial size for heap array.
◆ timer_heap_thread_template() [3/3]
template<typename Timer_Action , typename Error_Logger , typename Actor_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.
The documentation for this class was generated from the following file:
