NAME
Reflex::Interval - A stand-alone multi-shot periodic callback
VERSION
This document describes version 0.100, released on April 02, 2017.
SYNOPSIS
As with all Reflex objects, Reflex::Interval may be used in many different ways.
Inherit it and override its on_tick() callback, with or without using Moose.
package App;
use Reflex::Interval;
use base qw(Reflex::Interval);
sub on_tick {
print "tick at ", scalar(localtime), "...\n";
shift()->repeat();
}Run it as a promise that generates periodic events. All other Reflex objects will also be running while <$pt-next()>> is blocked.
my $pt = Reflex::Interval->new(
interval => 1 + rand(),
auto_repeat => 1,
);
while (my $event = $pt->next()) {
eg_say("promise timer returned an event ($event->{name})");
}Plain old callbacks:
my $ct = Reflex::Interval->new(
interval => 1,
auto_repeat => 1,
on_tick => sub { print "coderef callback triggered\n" },
);
Reflex->run_all();And so on. See Reflex, Reflex::Base and Reflex::Role::Reactive for details.
DESCRIPTION
Reflex::Interval invokes a callback after a specified interval of time has passed, and then after every subsequent interval of time. Interval timers may be stopped and started. Their timers may be automatically or manually repeated.
Public Attributes
interval
Implemented and documented by "interval" in Reflex::Role::Interval.
auto_repeat
Implemented and documented by "auto_repeat" in Reflex::Role::Interval.
auto_start
Implemented and documented by "auto_start" in Reflex::Role::Interval.
Public Callbacks
on_tick
Implemented and documented by "cb_tick" in Reflex::Role::Interval.
Public Methods
repeat
Implemented and documented by "method_repeat" in Reflex::Role::Interval.
start
Implemented and documented by "method_start" in Reflex::Role::Interval.
stop
Implemented and documented by "method_stop" in Reflex::Role::Interval.
EXAMPLES
TODO - Many. Link to them.
SEE ALSO
Please see those modules/websites for more information related to this module.
BUGS AND LIMITATIONS
You can make new bug reports, and view existing ones, through the web interface at http://rt.cpan.org/Public/Dist/Display.html?Name=Reflex.
AUTHOR
Rocco Caputo <rcaputo@cpan.org>
COPYRIGHT AND LICENSE
This software is copyright (c) 2017 by Rocco Caputo.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
AVAILABILITY
The latest version of this module is available from the Comprehensive Perl Archive Network (CPAN). Visit http://www.perl.com/CPAN/ to find a CPAN site near you, or see https://metacpan.org/module/Reflex/.
DISCLAIMER OF WARRANTY
BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.