Documentation for method
cue assembled from the following types:
method cue(, Instant :, :, :, : = 1; : --> Cancellation)
Schedules a callable (
&code) for execution and returns an instantiated
Cancellation object to cancel the scheduling of the code for execution (which is especially important if you specify the
:every ( time ) named parameter). The adverbs control when and how the code is run:
$atcan be an Instant before which the code won't be run. Alternatively
$inis the number of seconds (possibly fractional) to wait before running the code. If
$atis in the past or
$inis negative, the delay is treated as zero. Implementations may equate to zero very small values (e.g. lower than 0.001s) of
$inor result of
$everyis specified, it is interpreted as the number of seconds (possibly fractional) to wait before re-executing the code. Implementations may treat too-small values as lowest resolution they support, possibly warning in such situations; e.g. treating
$timestells the scheduler how many times to run the code.
&catchis called with the Exception as its sole argument if
&codewill never be run; if
&codewill only be run once. If any of the three are
&codewill be run immediately. If any of the three are
NaN, an X::Scheduler::CueInNaNSeconds exception will be thrown. This only applies to releases 2019.05 and later.
One should call the
cancel method on the returned
Cancellation object to cancel the (possibly repeated) cueing of the code.