NAME
ONE::Timer - Timer/timeout events for MooseX::Event
VERSION
version v0.2.0
SYNOPSIS
use ONE qw( Timer=sleep:sleep_until );
# After five seconds, say Hi
ONE::Timer->after( 5, sub { say "Hi!" } );
sleep 3; # Sleep for 3 seconds without blocking events from firing
# Two seconds from now, say At!
ONE::Timer->at( time()+2, sub { say "At!" } );
# Every 5 seconds, starting 5 seconds from now, say Ping
ONE::Timer->every( 5, sub { say "Ping" } );
sleep_until time()+10; # Sleep until 10 seconds from now
my $timer = ONE::Timer->new( delay=>5, interval=>25 );
$timer->on( timeout => sub { say "Timer tick" } );
$timer->start(); # Will say "Timer tick" in 5 secs and then ever 25 secs after that
# ... later
$timer->cancel(); # Will stop saying "Timer tick"DESCRIPTION
Trigger events at a specific time or after a specific delay.
EVENTS
timeout
This event takes no arguments. It's emitted when the event time completes.
ATTRIBUTES
our Num|CodeRef $.delay is ro = 0;
The number of seconds to delay before triggering this event. By default, triggers immediately.
our Num $.interval is ro = 0;
The number of seconds to delay
CLASS METHODS
our method after( Rat $seconds, CodeRef $on_timeout ) returns ONE::Timer
Asynchronously, after $seconds, calls $on_timeout. If you store the return value, it acts as a guard-- if it's destroyed then the timer is canceled.
our method at( Rat $epochtime, CodeRef $on_timeout ) returns ONE::Timer
Asychronously waits until $epochtime and then calls $on_timeout. If you store the return value, it acts as a guard-- if it's destoryed then the timer is canceled.
our method every( Rat $seconds, CodeRef $on_timeout ) returns ONE::Timer
Asychronously, after $seconds and every $seconds there after, calls $on-Timeout. If you store the return value it acts as a guard-- if it's destroyed then the timer is canceled.
our method new( :$delay, :$interval? ) returns ONE::Timer
Creates a new timer object that will emit it's "timeout" event after $delay seconds and every $interval seconds there after. Delay can be a code ref, in which case it's return value is the number of seconds to delay.
METHODS
our method start( $is_obj_guard = False )
Starts the timer object running. If $is_obj_guard is true, then destroying the object will cancel the timer.
our method cancel()
Cancels a running timer. You can start the timer again by calling the start method. For after and every timers, it begins waiting all over again. At timers will still emit at the time you specified (or immediately if that time has passed).
HELPERS
our sub sleep( Rat $secs ) is export
Sleep for $secs while allowing events to emit (and Coroutine threads to run)
our sub sleep_until( Rat $epochtime ) is export
Sleep until $epochtime while allowing events to emit (and Coroutine threads to run)
SEE ALSO
Please see those modules/websites for more information related to this module.
AUTHOR
Rebecca Turner <becca@referencethis.com>
COPYRIGHT AND LICENSE
This software is copyright (c) 2011 by Rebecca Turner.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
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.