Rocco Caputo > Reflex > Reflex::Timeout

Download:
Reflex-0.099.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  0
View/Report Bugs
Module Version: 0.099   Source  

NAME ^

Reflex::Timeout - A stand-alone single-shot delayed callback

VERSION ^

This document describes version 0.099, released on April 21, 2013.

SYNOPSIS ^

        #!/usr/bin/env perl

        use warnings;
        use strict;

        use Reflex::Timeout;

        my $to = Reflex::Timeout->new(
                delay   => 1,
                on_done => \&handle_timeout,
        );

        Reflex->run_all();
        exit;

        sub handle_timeout {
                print "got timeout\n";
                $to->reset();
        }

DESCRIPTION ^

Reflex::Timeout invokes a callback after a specified amount of time has elapsed. Timeouts may be stopped, restarted, or reset so they must again wait the full delay period. Resetting is especially useful, for example whenever input arrives.

Public Attributes

delay

Implemented and documented by "delay" in Reflex::Role::Timeout.

Public Callbacks

on_done

Implemented and documented by "cb_timeout" in Reflex::Role::Timeout.

Public Methods

reset

Implemented and documented by "method_reset" in Reflex::Role::Timeout.

start

Implemented and documented by "method_start" in Reflex::Role::Timeout.

stop

Implemented and documented by "method_stop" in Reflex::Role::Timeout.

EXAMPLES ^

TODO - 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) 2013 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.

syntax highlighting: