Skip to content

Commit

Permalink
Doxygen tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
cliffg-softwarelibre committed May 21, 2024
1 parent 2f7bc6d commit 110fac0
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions include/timer/periodic_timer.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@
*
* ## Overview
*
* The @c periodic_timer class template is an asynchronous periodic timer that wraps
* and simplifies Asio timers when periodic callbacks are needed. The periodicity can
* be based on either a simple duration or on timepoints based on a duration. When the
* timer is started, the application specifies whether each callback is invoked based
* on a duration (e.g. one second after the last callback), or on timepoints (e.g.
* a callback will be invoked each second according to the clock).
*
* The Asio library does not directly provide periodic timers. Instead, application
* code using Asio must chain together function object callbacks until satisfied.
*
Expand Down Expand Up @@ -29,6 +36,9 @@
* amount of processing is performed by the callback, "overflow" can occur, where the next
* timepoint callback is overrun by the current processing.
*
* An excellent article on this topic by Tony DaSilva can be [read here]
* (https://bulldozer00.blog/2013/12/27/periodic-processing-with-standard-c11-facilities/).
*
* An asynchronous timer is more resource-friendly regarding system resources than creating a
* thread that sleeps. In particular, creating hundreds or thousands of timers is very
* expensive in a "thread per timer" design.
Expand Down

0 comments on commit 110fac0

Please sign in to comment.