mecca ~master (2021-09-12T14:37:04Z)

Reactor.registerRecurringTimer

mecca reactor Reactor

registers a timer that will repeatedly trigger at set intervals.

You do not control precisely when the callback is invoked, only how often. The invocations are going to be evenly spaced out (best effort), but the first invocation might be almost immediately after the call or a whole interval after.

You can use the firstRun argument to control when the first invocation is going to be (but the same rule will still apply to the second one).

  1. TimerHandle registerRecurringTimer(Duration interval, void delegate() dg)
  2. TimerHandle registerRecurringTimer(Duration interval, Parameters!F params)
  3. TimerHandle registerRecurringTimer(Duration interval, void delegate() dg, Timeout firstRun)
  4. TimerHandle registerRecurringTimer(Duration interval, Parameters!F params, Timeout firstRun)
    struct Reactor
    nothrow @safe @nogc
    TimerHandle
    registerRecurringTimer
    (
    alias F
    )
    (
    Duration interval
    ,
    Parameters!F params
    ,
    Timeout firstRun
    )

Parameters

interval Duration

the frequency with which the callback will be called.

F

an alias to the function to be called

params Parameters!F

the arguments to pass to F on each invocation

firstRun Timeout

if supplied, directly sets when is the first time the timer shall run. The value does not have any special constraints.

Meta

Source

See Implementation

mecca reactor Reactor aliasesfunctionsmanifest constantspostblitspropertiesstructs

Page generated by adrdox