NAME
IO::Async::Timer::Periodic
- event callback at regular intervals
SYNOPSIS
use IO::Async::Timer::Periodic;
use IO::Async::Loop;
my $loop = IO::Async::Loop->new();
my $timer = IO::Async::Timer::Periodic->new(
interval => 60,
on_tick => sub {
print "You've had a minute\n";
},
);
$timer->start;
$loop->add( $timer );
$loop->loop_forever;
DESCRIPTION
This subclass of IO::Async::Timer implements repeating events at regular clock intervals. The timing is not subject to how long it takes the callback to execute, but runs at regular intervals beginning at the time the timer was started, then adding each interval thereafter.
For a Timer
object that only runs a callback once, after a given delay, see instead IO::Async::Timer::Countdown.
This object may be used in one of two ways; as an instance with CODE references as callbacks, or as a base class with overridden methods.
- Subclassing
-
If a subclass is built, then it can override the following methods to handle events:
$self->on_tick()
PARAMETERS
The following named parameters may be passed to new
or configure
:
- on_tick => CODE
-
CODE reference to callback to invoke each interval. If not supplied, the subclass method will be called instead.
$on_tick->( $self )
- interval => NUM
-
The interval in seconds between invocations of the callback or method. Cannot be changed if the timer is running.
Once constructed, the timer object will need to be added to the Loop
before it will work. It will also need to be started by the start
method.
AUTHOR
Paul Evans <leonerd@leonerd.org.uk>