Damian Conway > IO-Busy-0.0.3 > IO::Busy

Download:
IO-Busy-0.0.3.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.0.3   Source  

NAME ^

IO::Busy - Intercept terminal input while something else is happening

VERSION ^

This document describes IO::Busy version 0.0.3

SYNOPSIS ^

    use IO::Busy;

    my $fh = busy {
        non_interactive_stuff();
    };

DESCRIPTION ^

This module exports a single subroutine, named busy. That subroutine takes a single argument, which must be a block of code. busy forks off a separate process that intercepts and stores any input, then executes the block (in the original process).

If the user types anything during the execution of the block, that input does not appear on the STDIN of the original process. Instead the busy block informs the user that their input is not being received, and stores the input in a separate filehandle. That filehandle is then returned by the busy call, at the end of the block's execution, at which time STDIN is reconnected to the process.

INTERFACE ^

$FH = busy {...}

The busy subroutine expects a code block as its only argument. It executes the block, intercepting any input during that execution. It returns a filehandle opened for reading, from which the intercepted input can be re-read if desired.

DIAGNOSTICS ^

That input was ignored. %s

You typed something whilst the busy block was executing. The busy did its job and ignored the input, warning you of the fact.

CONFIGURATION AND ENVIRONMENT ^

IO::Busy requires no configuration files or environment variables.

DEPENDENCIES ^

Requires the Perl6::Export::Attrs module.

INCOMPATIBILITIES ^

Will not work on systems that cannot fork correctly.

BUGS AND LIMITATIONS ^

No bugs have been reported.

Please report any bugs or feature requests to bug-io-busy@rt.cpan.org, or through the web interface at http://rt.cpan.org.

AUTHOR ^

Damian Conway <DCONWAY@cpan.org>

LICENCE AND COPYRIGHT ^

Copyright (c) 2005, Damian Conway <DCONWAY@cpan.org>. All rights reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl 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.

syntax highlighting: