File tree Expand file tree Collapse file tree 1 file changed +21
-3
lines changed Expand file tree Collapse file tree 1 file changed +21
-3
lines changed Original file line number Diff line number Diff line change @@ -47,13 +47,31 @@ class TimerEvent : private NonCopyable<TimerEvent> {
47
47
// The handler called to service the timer event of the derived class
48
48
virtual void handler () = 0;
49
49
50
- // insert relative timestamp in to linked list
50
+ /* * Set relative timestamp of the internal event.
51
+ * @param timestamp event's us timestamp
52
+ *
53
+ * @warning
54
+ * Do not insert more than one timestamp.
55
+ * The same @a event object is used for every @a insert/insert_absolute call.
56
+ *
57
+ * @warning
58
+ * Ticker's present timestamp is used for reference. For timestamps
59
+ * from the past the event is scheduled after ticker's overflow.
60
+ * For reference @see convert_timestamp
61
+ */
51
62
void insert (timestamp_t timestamp);
52
63
53
- // insert absolute timestamp into linked list
64
+ /* * Set absolute timestamp of the internal event.
65
+ * @param timestamp event's us timestamp
66
+ *
67
+ * @warning
68
+ * Do not insert more than one timestamp.
69
+ * The same @a event object is used for every @a insert/insert_absolute call.
70
+ */
54
71
void insert_absolute (us_timestamp_t timestamp);
55
72
56
- // remove from linked list, if in it
73
+ /* * Remove timestamp.
74
+ */
57
75
void remove ();
58
76
59
77
ticker_event_t event;
You can’t perform that action at this time.
0 commit comments