-
Notifications
You must be signed in to change notification settings - Fork 47
/
all.hpp
4167 lines (3759 loc) · 104 KB
/
all.hpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* TimerThreadTemplate
*/
/*!
* \file timertt/all.hpp
* \brief All project's stuff.
*/
#pragma once
#include <array>
#include <atomic>
#include <chrono>
#include <condition_variable>
#include <cstdint>
#include <cstdlib>
#include <ctime>
#include <functional>
#include <iostream>
#include <map>
#include <memory>
#include <mutex>
#include <sstream>
#include <stdexcept>
#include <string>
#include <thread>
#include <tuple>
#include <unordered_map>
#include <vector>
#if defined(_MSC_VER) && (_MSC_VER < 1900)
// Under VS++12 the alignment will always be 8 bytes.
#define TIMERTT_ALIGNAS_WORKAROUND(T) __declspec(align(8))
// VS++12 doesn't support noexcept keyword.
#define TIMERTT_NOEXCEPT
#define TIMERTT_HAS_NOEXCEPT 0
#else
#define TIMERTT_ALIGNAS_WORKAROUND(T) alignas(T)
#define TIMERTT_NOEXCEPT noexcept
#define TIMERTT_HAS_NOEXCEPT 1
#endif
/*!
* \brief The current version of timertt.
*
* Please note that this macro was added only in version 1.2.1.
* It means that it is better to check presense of TIMERTT_VERSION and
* only then try to check its value:
* \code
* #include <timertt/all.hpp>
*
* #if defined(TIMERTT_VERSION)
* #if TIMERTT_VERSION > 1002002
* #endif
* #endif
* \endcode
*
* The value of TIMERTT_VERSION has YXXXZZZ format in decimal. For
* example: 1002001 or 1003014. 'Y' means the major version number
* (e.g. 1 for 1.2.1), 'XXX' means minor version number
* (e.g. 002 for 1.2.1) and 'ZZZ' means patch number
* (e.g. 001 for 1.2.1). It means that version 1.2.1 will be
* represented as 1002001 and 1.3.14 will be represented as 1003014.
*
* \since
* v.1.2.1
*/
#define TIMERTT_VERSION 1002003u
/*!
* \brief Top-level project's namespace.
*/
namespace timertt
{
/*!
* \brief Container for thread safety flags.
*
* \since
* v.1.1.0
*/
struct thread_safety
{
/*!
* \brief Indicator for not-thread-safe implementation.
*
* \since
* v.1.1.0
*/
struct unsafe {};
/*!
* \brief Indicator for thread-safe implemetation.
*
* \since
* v.1.1.0
*/
struct safe {};
};
namespace details
{
//! Status of timer.
enum class timer_status : unsigned int
{
//! Timer is deactivated.
/*! It can be activated or destroyed safely. */
deactivated,
//! Timer is activated.
/*! It can be safely deactivated and destroyed. */
active,
//! Timer is in execution list and is waiting for execution.
/*!
* It cannot be deactivated and destroyed right now.
* Status of timer can only be changed to wait_for_deactivation.
* And actual deactivation will be performed later, after
* processing of execution list.
*/
wait_for_execution,
//! Timer must be deactivated after processing of execution list.
/*!
* The only possible switch for the timer is to deactivated status.
*/
wait_for_deactivation
};
} /* namespace details */
/*!
* \brief Container for thread-safety-specific type declarations.
*
* \note Will be specialized for every thread-safety case.
*
* \tparam Thread_Safety must be thread_safety::unsafe or thread_safety::safe.
*
* \since
* v.1.1.0
*/
template< typename Thread_Safety >
struct threading_traits {};
/*!
* \brief Specialization for not-thread-safe case.
*
* \since
* v.1.1.0
*/
template<>
struct threading_traits< thread_safety::unsafe >
{
//! Type for reference counters.
typedef unsigned int reference_counter_type;
//! Type for holding timer status inside a timer object.
typedef details::timer_status status_holder_type;
};
/*!
* \brief Specialization for thread-safe case.
*
* \since
* v.1.1.0
*/
template<>
struct threading_traits< thread_safety::safe >
{
//! Type for reference counters.
typedef std::atomic_uint reference_counter_type;
//! Type for holding timer status inside a timer object.
typedef std::atomic< details::timer_status > status_holder_type;
};
//
// timer_object
//
/*!
* \brief Base type for timer demands.
*
* \tparam Thread_Safety Thread-safety indicator. Must be thread_safety::unsafe
* or thread_safety::safe type.
*/
template< typename Thread_Safety >
struct timer_object
{
//! Reference counter for the demand.
typename threading_traits< Thread_Safety >::reference_counter_type m_references;
//! Deafault constructor.
inline timer_object()
{
m_references = 0;
}
inline virtual ~timer_object()
{}
//! Increment reference counter for the demand.
static inline void
increment_references( timer_object * t )
{
++(t->m_references);
}
//! Decrement reference counter for the demand and destroy
//! demand if there is no more references.
static inline void
decrement_references( timer_object * t )
{
if( 0 == --(t->m_references) )
delete t;
}
};
//
// scoped_timer_object_holder
//
/*!
* \brief A special wrapper to be used to hold an actual timer object which
* is not allocated dynamically.
*
* This class is a part of support for scoped timer objects. Every timer
* engine will define its own `scoped_timer_object` by using this
* template class. Something like:
* \code
* class some_engine
* {
* struct timer_type { ... };
* public :
* using scoped_timer_object = scoped_timer_object_holder<timer_type>;
* ...
* };
* \endcode
*
* \par Some implementation details.
* Version 1.2.0 doesn't change way of working with actual timer objects.
* They are still reference countable. It means that when a scoped timer object
* is passed to engine's `activate` method a reference count will be
* incremented. When this object is passed to `deactivate` method then
* reference counter will be decremented. If reference counter becomes zero
* then the timer object will be deallocated by calling `delete`.
* To prevent this scoped_timer_object_holder automatically incremented
* reference counter by 1 in the constructor. It means that the reference
* counter will not be zero (in normal scenarios).
*
* \note
* This type is not Copyable nor Moveable.
*
* \since
* v.1.2.0
*/
template< typename Actual_Object >
class scoped_timer_object_holder
{
Actual_Object m_object;
public :
scoped_timer_object_holder()
{
// Actual object must have yet another reference to prevent its deletion.
Actual_Object::increment_references( &m_object );
}
scoped_timer_object_holder( const scoped_timer_object_holder & ) = delete;
scoped_timer_object_holder( scoped_timer_object_holder && ) = delete;
Actual_Object *
ptr() { return &m_object; }
};
//
// timer_object_holder
//
/*!
* \brief An intrusive smart pointer to timer demand.
*
* \tparam Thread_Safety Thread-safety indicator. Must be thread_safety::unsafe
* or thread_safety::safe type.
*/
template< typename Thread_Safety >
class timer_object_holder
{
public :
//! Default constructor.
/*!
* Constructs a null pointer.
*/
inline timer_object_holder()
: m_timer( nullptr )
{}
//! Constructor for a raw pointer.
inline timer_object_holder( timer_object< Thread_Safety > * t )
: m_timer( t )
{
take_object();
}
//! Copy constructor.
inline timer_object_holder( const timer_object_holder & o )
: m_timer( o.m_timer )
{
take_object();
}
//! Move constructor.
inline timer_object_holder( timer_object_holder && o )
: m_timer( o.m_timer )
{
o.m_timer = nullptr;
}
//! Constructor for the case when timer object is a scoped timer.
template< typename Actual_Object >
inline timer_object_holder(
scoped_timer_object_holder<Actual_Object> & scoped )
: timer_object_holder( scoped.ptr() )
{}
//! Destructor.
inline ~timer_object_holder()
{
dismiss_object();
}
//! Copy operator.
inline timer_object_holder &
operator=( const timer_object_holder & o )
{
timer_object_holder t( o );
swap( t );
return *this;
}
//! Move operator.
inline timer_object_holder &
operator=( timer_object_holder && o )
{
timer_object_holder t( std::move( o ) );
swap( t );
return *this;
}
//! Swap values.
inline void
swap( timer_object_holder & o )
{
auto t = m_timer;
m_timer = o.m_timer;
o.m_timer = t;
}
/*!
* \brief Drop controlled object.
*/
inline void
reset()
{
dismiss_object();
}
//! Is this a null pointer?
/*!
i.e. whether get() != 0.
\retval true if *this manages an object.
\retval false otherwise.
*/
inline operator bool() const
{
return nullptr != m_timer;
}
/*!
* \name Access to object.
* \{
*/
inline timer_object< Thread_Safety > *
get() const
{
return m_timer;
}
template< class O >
O *
cast_to()
{
if( !m_timer )
throw std::runtime_error( "timer is nullptr" );
return static_cast< O * >(m_timer);
}
/*!
* \}
*/
private :
//! Timer controlled by a smart pointer.
timer_object< Thread_Safety > * m_timer;
//! Increment reference count to object if it's not null.
inline void
take_object()
{
if( m_timer )
timer_object< Thread_Safety >::increment_references( m_timer );
}
//! Decrement reference count to object and delete it if needed.
inline void
dismiss_object()
{
if( m_timer )
{
timer_object< Thread_Safety >::decrement_references( m_timer );
m_timer = nullptr;
}
}
};
//
// default_error_logger
//
/*!
* \brief Class of default error logger.
*
* This class uses std::cerr as the stream for logging errors.
*/
struct default_error_logger
{
//! Logs error message to std::cerr.
inline void
operator()(
//! The text of error message.
const std::string & what )
{
std::cerr << what << std::endl;
}
};
//
// default_actor_exception_handler
//
/*!
* \brief Class of default handler for exceptions thrown from timer actors.
*
* Calls std::abort() to terminate application execution.
*/
struct default_actor_exception_handler
{
//! Handles exception.
inline void
operator()(
//! An exception from timer actor.
const std::exception & )
{
std::abort();
}
};
//
// default_timer_action_type
//
/*!
* \brief Defaulf type of timer action.
*
* \since
* v.1.2.0
*/
typedef std::function< void() > default_timer_action_type;
//
// monotonic_clock
//
/*!
* \brief Type of clock used by all threads.
*/
typedef std::chrono::steady_clock monotonic_clock;
//
// timer_quantities
//
/*!
* \brief Information about quantities of various timer types.
*
* \since
* v.1.1.1
*/
struct timer_quantities
{
//! Quantity of single-shot timers.
std::size_t m_single_shot_count = { 0 };
//! Quantity of periodic timers.
std::size_t m_periodic_count = { 0 };
};
/*!
* \brief An internal namespace with implementation details.
*/
namespace details
{
// NOTE: invoke_noexcept_code_block was added because some compilers
// do not have support for noexcept (for example VC++2013). So it's impossible
// to write code like that:
//
// [&]() noexcept {
// some_code();
// }();
//
// Instead we have to write:
//
// invoke_noexcept_code_block([&] {
// some_code();
// });
//
#if TIMERTT_HAS_NOEXCEPT
template< typename Lambda >
void invoke_noexcept_code_block(Lambda && lambda) noexcept
{
lambda();
}
#else
template< typename Lambda >
void invoke_noexcept_code_block(Lambda && lambda)
{
try { lambda(); } catch(...) { std::abort(); }
}
#endif
//
// buffer_allocated_object
//
/*!
* \brief A special storage to be used for holding non-default constructible
* objects which are created by demand.
*
* \note
* In C++17 std::optional can be used instead of this class.
*
* \since
* v.1.2.0
*/
template<typename T>
class buffer_allocated_object
{
TIMERTT_ALIGNAS_WORKAROUND(T) std::array<char, sizeof(T)> buffer_;
bool allocated_{ false };
void destroy_if_allocated()
{
if(allocated_)
{
get()->~T();
allocated_ = false;
}
}
public :
using pointer = T*;
using element_type = T;
using reference = typename std::add_lvalue_reference<T>::type;
buffer_allocated_object() TIMERTT_NOEXCEPT = default;
buffer_allocated_object(const buffer_allocated_object &) = delete;
buffer_allocated_object(buffer_allocated_object &&) = delete;
~buffer_allocated_object()
{
destroy_if_allocated();
}
template<typename... Args>
void allocate(Args &&...args)
{
destroy_if_allocated();
new(buffer_.data()) T(std::forward<Args>(args)...);
allocated_ = true;
}
void destroy()
{
destroy_if_allocated();
}
operator bool() const TIMERTT_NOEXCEPT
{
return allocated_;
}
pointer get() const TIMERTT_NOEXCEPT
{
return reinterpret_cast<pointer>(const_cast<char *>(buffer_.data()));
}
pointer operator->() const TIMERTT_NOEXCEPT
{
return get();
}
reference operator*() const TIMERTT_NOEXCEPT
{
return *get();
}
};
//
// timer_action_holder
//
/*!
* \brief A special storage for holding timer actions.
*
* If a timer action is represented by std::function<void()> then
* a simple std::function can be used for holding this timer action.
* But if a timer action is represented by some user type then
* we must use a internal buffer and should construct timer action
* instance inplace only when it is necessary.
*
* \since
* v.1.2.0
*/
template< typename Action_Type >
class timer_action_holder
{
buffer_allocated_object<Action_Type> m_action;
public:
timer_action_holder() = default;
timer_action_holder( const timer_action_holder & ) = delete;
timer_action_holder( timer_action_holder && ) = delete;
void
assign( Action_Type && action )
{
m_action.allocate( std::move(action) );
}
void
exec() const
{
(*m_action)();
}
};
template<>
class timer_action_holder< default_timer_action_type >
{
default_timer_action_type m_action;
public :
timer_action_holder() = default;
timer_action_holder( const timer_action_holder & ) = delete;
timer_action_holder( timer_action_holder && ) = delete;
void
assign( default_timer_action_type && action )
{
m_action = std::move(action);
}
void
exec() const
{
m_action();
}
};
//
// timer_kind
//
/*!
* \brief Type of the timer (single-shot or periodic).
*
* \since
* v.1.1.1
*/
enum class timer_kind
{
//! Timer is a single-shot timer.
single_shot,
//! Timer is a periodic timer.
periodic
};
//
// engine_common
//
/*!
* \brief A common part for all timer engines.
*
* Will be used by concrete engines for storing instances of
* Error_Logger and Actor_Exception_Handler.
*
* Also defines type \a thread_safety to be used later.
*
* \tparam Thread_Safety Thread-safety indicator.
* Must be timertt::thread_safety::unsafe or timertt::thread_safety::safe.
*
* \tparam Timer_Action type of functor to perform an user-defined
* action when timer expires. This must be Moveable and MoveConstructible
* type.
*
* \tparam Error_Logger type of logger for errors detected during
* timer handling. Interface for error logger is defined
* by default_error_logger class.
*
* \tparam 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.
*
* \since
* v.1.1.0
*/
template<
typename Thread_Safety,
typename Timer_Action,
typename Error_Logger,
typename Actor_Exception_Handler >
class engine_common
{
public :
//! Indicator of thread-safety.
using thread_safety = Thread_Safety;
//! Alias for Timer_Action.
using timer_action = Timer_Action;
//! Initializing constructor.
engine_common(
Error_Logger error_logger,
Actor_Exception_Handler exception_handler )
: m_error_logger( error_logger )
, m_exception_handler( exception_handler )
{}
/*!
* \brief Get the quantities of timers of various types.
*
* \since
* v.1.1.1
*/
timer_quantities
get_timer_quantities() const
{
return this->m_timer_quantities;
}
protected :
//! Error logger.
Error_Logger m_error_logger;
//! Exception handler.
Actor_Exception_Handler m_exception_handler;
/*!
* \brief Quantities of timers of various types.
*
* \since
* v.1.1.1
*/
timer_quantities m_timer_quantities;
/*!
* \brief Helper method for increment the count of timers of
* the specific type.
*
* \since
* v.1.1.1
*/
void
inc_timer_count( timer_kind kind )
{
if( timer_kind::single_shot == kind )
++m_timer_quantities.m_single_shot_count;
else
++m_timer_quantities.m_periodic_count;
}
/*!
* \brief Helper method for decrement the count of timers of
* the specific type.
*
* \since
* v.1.1.1
*/
void
dec_timer_count( timer_kind kind )
{
if( timer_kind::single_shot == kind )
--m_timer_quantities.m_single_shot_count;
else
--m_timer_quantities.m_periodic_count;
}
/*!
* \brief Helper method for reseting quantities of timers to zero.
*
* \since
* v.1.1.1
*/
void
reset_timer_count()
{
m_timer_quantities = timer_quantities{};
}
};
//
// timer_wheel_engine_defaults
//
/*!
* \brief Container for static method with default values for
* timer_wheel engine.
*
* \since
* v.1.1.0
*/
struct timer_wheel_engine_defaults
{
//! Default wheel size.
inline static unsigned int
default_wheel_size() { return 1000; }
//! Default tick duration.
inline static monotonic_clock::duration
default_granularity() { return std::chrono::milliseconds( 10 ); }
};
//
// timer_wheel_engine
//
/*!
* \brief A engine for timer wheel mechanism.
*
* This class uses <a href="http://www.cs.columbia.edu/~nahum/w6998/papers/ton97-timing-wheels.pdf">timer_wheel</a>
* mechanism to work with timers.
* This mechanism is efficient for working with big amount of timers.
* But it requires that timer thread is working always, even in case
* when there is no timers. Another price for timer_wheel is the
* granularity of timer steps.
*
* Timer wheel data structure consists from one fixed size vector
* (the wheel) and several double-linked list (one list for every wheel
* slot).
*
* At the start of next time step thread switches to next wheel position
* and handles timers from this position list. After processing
* all elapsed single-shot timers will be removed and deactivated, and
* all elapsed periodic timers will be rescheduled for the new time steps.
*
* \note At the beginnig of time step thread detects elapsed timers, then
* unblocks object mutex and calls timer actors for those timers. It means
* that actors call call timer thread object. And there won't be frequent
* mutex locking/unlocking operations for building and processing
* list of elapsed timers. This allows to process millions of timer actor
* per second.
*
* \tparam Thread_Safety Thread-safety indicator.
* Must be timertt::thread_safety::unsafe or timertt::thread_safety::safe.
*
* \tparam Timer_Action type of functor to perform an user-defined
* action when timer expires. This must be Moveable and MoveConstructible
* type.
*
* \tparam Error_Logger type of logger for errors detected during
* timer thread execution. Interface for error logger is defined
* by default_error_logger class.
*
* \tparam 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.
*/
template<
typename Thread_Safety,
typename Timer_Action,
typename Error_Logger,
typename Actor_Exception_Handler >
class timer_wheel_engine
: public engine_common<
Thread_Safety, Timer_Action, Error_Logger, Actor_Exception_Handler >
{
//! An alias for base class.
using base_type = engine_common<
Thread_Safety, Timer_Action, Error_Logger, Actor_Exception_Handler >;
struct timer_type;
public :
//! Type with default parameters for this engine.
using defaults_type = timer_wheel_engine_defaults;
//! Alias for timer_action type.
using timer_action = typename base_type::timer_action;
//! Alias for scoped timer object.
using scoped_timer_object =
scoped_timer_object_holder< timer_type >;
//! Constructor with all parameters.
timer_wheel_engine(
//! Size of the wheel.
unsigned int wheel_size,
//! Size of time step for the timer_wheel.
monotonic_clock::duration granularity,
//! An error logger for timer thread.
Error_Logger error_logger,
//! An actor exception handler for timer thread.
Actor_Exception_Handler exception_handler )
: base_type( error_logger, exception_handler )
, m_wheel_size( wheel_size )
, m_granularity( granularity )
{
m_wheel.resize( wheel_size );
m_current_tick_border = monotonic_clock::now() + m_granularity;
}
//! Destructor.
~timer_wheel_engine()
{
clear_all();
}
//! Create timer to be activated later.
timer_object_holder< Thread_Safety >
allocate()
{
return timer_object_holder< Thread_Safety >( new timer_type() );
}
//! Activate timer and schedule it for execution.
/*!
* \return Value \a true is returned only when the first timer is added to
* the empty wheel.
*
* \throw std::exception If timer thread is not started.
* \throw std::exception If \a timer is already activated.
*
* \tparam Duration_1 actual type which represents time duration.
* \tparam Duration_2 actual type which represents time duration.
*/
template< class Duration_1, class Duration_2 >
bool
activate(
//! Timer to be activated.
timer_object_holder< Thread_Safety > timer,
//! Pause for timer execution.
Duration_1 pause,
//! Repetition period.
//! If <tt>Duration_2::zero() == period</tt> then timer will be
//! single-shot.
Duration_2 period,
//! Action for the timer.
timer_action action )
{
auto * wheel_timer = timer.template cast_to< timer_type >();
ensure_timer_deactivated( wheel_timer );
wheel_timer->m_action.assign( std::move(action) );
// Timer must be taken under control.
timer_object< Thread_Safety >::increment_references( wheel_timer );
// It is an active timer now.
wheel_timer->m_status = timer_status::active;
perform_insertion_info_wheel( wheel_timer, pause, period );
// If wheel was empty and this is the first timer added
// the value of timer_count must be exactly 1.
return 1 == this->m_timer_quantities.m_single_shot_count +
this->m_timer_quantities.m_periodic_count;
}
/*!
* \brief Perform an attempt to reschedule a timer.
*
* Before v.1.2.1 there was just one way to reschedule a timer:
* method deactivate() must be called first and then method
* activate() must be called for the same timer. This approach is
* not fast because in the case of thread-safe engines it requires
* two operations on a mutex.
*
* Since v.1.2.1 there is a reschedule() method which does deactivation
* of a timer (if it is active) and then new activation of this timer.
* All actions are performed by using just one operation on a mutex.
*
* \note
* This operation can fail if the timer to be rescheduled is in processing.
* Because of that it is recommended to use such operation for