Parameters: |
|
---|
Timer watchers are simple relative timers that generate an event after a given time, and optionally repeating in regular intervals after that.
The timers are based on real time, that is, if you register an event that times out after an hour and you reset your system clock to January last year, it will still time out after (roughly) one hour. “Roughly” because detecting time jumps is hard, and some inaccuracies are unavoidable.
The callback is guaranteed to be invoked only after its timeout has passed (not at, so on systems with very low-resolution clocks this might introduce a small delay). If multiple timers become ready during the same loop iteration then the ones with earlier time-out values are invoked before ones of the same priority with later time-out values (but this is no longer true when a callback calls Loop.start() recursively).
The timer itself will do a best-effort at avoiding drift, that is, if you configure a timer to trigger every 10 seconds, then it will normally trigger at exactly 10 second intervals. If, however, your program cannot keep up with the timer (because it takes longer than those 10 seconds to do stuff) the timer will not fire more than once per event loop iteration.
Parameters: |
|
---|
Configures the watcher.
This will act as if the timer timed out and restart it again if it is repeating. It basically works like calling stop(), updating the timeout to the repeat value and calling start(). The exact semantics are:
See also
Be smart about timeouts, for a usage example.
The current repeat value. Will be used each time the watcher times out or reset() is called, and determines the next timeout (if any), which is also when any modifications are taken into account.
Read only
The remaining time until a timer fires. If the timer is active, then this time is relative to the current event loop time, otherwise it’s the timeout value currently configured.
That is, after instanciating a Timer with an after value of 5.0 and a repeat value of 7.0, remaining is 5.0. When the timer is started and one second passes, remaining will be 4.0. When the timer expires and is restarted, it will be roughly 7.0 (likely slightly less as callback invocation takes some time, too), and so on.