summaryrefslogtreecommitdiff
path: root/lib/IO/Async/Timer/Periodic.pm
diff options
context:
space:
mode:
authorJonathan Yu <jawnsy@cpan.org>2010-12-24 20:34:21 +0000
committerJonathan Yu <jawnsy@cpan.org>2010-12-24 20:34:21 +0000
commitd588f2ad46114e686019bfb5faeb7000181dc81f (patch)
tree9b496da335ea1e3d137146b1cf7d010bc22b6e45 /lib/IO/Async/Timer/Periodic.pm
parentec149ce0681e662ea7a07d7d410745dd7b2d0247 (diff)
[svn-upgrade] new version libio-async-perl (0.33)
Diffstat (limited to 'lib/IO/Async/Timer/Periodic.pm')
-rw-r--r--lib/IO/Async/Timer/Periodic.pm22
1 files changed, 8 insertions, 14 deletions
diff --git a/lib/IO/Async/Timer/Periodic.pm b/lib/IO/Async/Timer/Periodic.pm
index a318d9e..c9b0a80 100644
--- a/lib/IO/Async/Timer/Periodic.pm
+++ b/lib/IO/Async/Timer/Periodic.pm
@@ -9,7 +9,7 @@ use strict;
use warnings;
use base qw( IO::Async::Timer );
-our $VERSION = '0.31';
+our $VERSION = '0.33';
use Carp;
use Scalar::Util qw( weaken );
@@ -50,19 +50,16 @@ started, then adding each interval thereafter.
For a C<Timer> object that only runs a callback once, after a given delay, see
instead L<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.
-
-=over 4
+=cut
-=item Subclassing
+=head1 EVENTS
-If a subclass is built, then it can override the following methods to handle
-events:
+The following events are invoked, either using subclass methods or CODE
+references in parameters:
- $self->on_tick()
+=head2 on_tick
-=back
+Invoked on each interval of the timer.
=cut
@@ -74,10 +71,7 @@ The following named parameters may be passed to C<new> or C<configure>:
=item on_tick => CODE
-CODE reference to callback to invoke each interval. If not supplied, the
-subclass method will be called instead.
-
- $on_tick->( $self )
+CODE reference for the C<on_tick> event.
=item interval => NUM