`Timer` — Timer watcher¶

class Timer(after, repeat, loop, callback[, data=None, priority=0])¶

Parameters:

after (float) – configure the timer to trigger after after seconds.
repeat (float) – if repeat is 0.0, then it will automatically be stopped once the timeout is reached. If it is positive, then the timer will automatically be configured to trigger again every repeat seconds later, again and again, until stopped manually.
loop (Loop) – loop object responsible for this watcher (accessible through loop).
callback (callable) – see callback.
data (object) – any Python object you might want to attach to the watcher (stored in data).
priority (int) – see priority.

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.

set(after, repeat)¶

Parameters:	after (float) – configure the timer to trigger after after seconds. repeat (float) – if repeat is `0.0`, then it will automatically be stopped once the timeout is reached. If it is positive, then the timer will automatically be configured to trigger again every repeat seconds later, again and again, until stopped manually.

Reconfigures the watcher.

reset()¶

This will act as if the timer timed out, and restarts 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:

if the timer is pending, the pending status is always cleared.
if the timer is started but non-repeating, stop it (as if it timed out, without invoking it).
if the timer is repeating, make the repeat value the new timeout and start the timer, if necessary.

Timer — Timer watcher¶

`Timer` — Timer watcher¶