NAME

Reflex::POE::Wheel::Run - Represent POE::Wheel::Run as a Reflex class.

VERSION

This document describes version 0.100, released on April 02, 2017.

SYNOPSIS

Unfortunately there isn't a concise, completely executable example for the synopsis at this time. Please see eg-07-wheel-run.pl and eg-08-watched-trait.pl in the distribution's eg directory for longer but fully executable ones.

        watches child => (
                isa => 'Reflex::POE::Wheel::Run|Undef',
        );

        sub BUILD {
                my $self = shift;
                $self->child(
                        Reflex::POE::Wheel::Run->new(
                                Program => "$^X -wle 'print qq[pid(\$\$) moo(\$_)] for 1..10; exit'",
                        )
                );
        }

        sub on_child_stdout {
                my ($self, $event) = @_;
                print "stdout: ", $event->output(), "\n";
        }

        sub on_child_close {
                my ($self, $event) = @_;
                print "child closed all output\n";
        }

        sub on_child_signal {
                my ($self, $event) = @_;
                print "child ", $event->pid(), " exited: ", $event->exit(), "\n";
                $self->child(undef);
        }

DESCRIPTION

Reflex::POE::Wheel::Run represents an enhanced POE::Wheel::Run object. It will manage a child process, and it will also wait for (and report on) the corresponding SIGCHLD.

This module delegates to POE::Wheel::Run for most of its implementation. Please refer to that module for implementation details.

Public Methods

This class adds public methods specific to POE::Wheel::Run's operation. However, common methods like put() are both implemented and documented in the base Reflex::POE::Wheel class.

kill

kill() passes its arguments to POE::Wheel::Run's kill() method.

Public Events

Objects of this class emit all of POE::Wheel::Run's events, albeit renamed into Reflex-friendly forms. Generally these forms are determined by removing the "Event" suffix and lowercasing what remains. POE::Wheel::Run's StdinEvent becomes "stdin", and so on.

stdin

See POE::Wheel::Run's StdinEvent. Within Reflex, this event comes with only one parameter: "wheel_id". This is the POE::Wheel::Run object's ID.

stdout

See POE::Wheel::Run's StdoutEvent. Reflex includes two parameters: "wheel_id" and "output". The latter parameter contains data the child process wrote to its STDOUT handle.

stderr

See POE::Wheel::Run's StderrEvent. Reflex includes two parameters: "wheel_id" and "output". The latter parameter contains data the child process wrote to its STDERR handle.

error

See POE::Wheel::Run's ErrorEvent. Reflex maps the wheel's parameters to: "operation", "errnum", "errstr", "wheel_id" and "handle_name", respectively.

closed

See POE::Wheel::Run's CloseEvent. Reflex includes only one parameter for this event: "wheel_id".

CAVEATS

This class could further be improved so that it doesn't report SIGCHLD until all the child's output has been received and processed. This would resolve a long-standing nondeterminism in the timing of on_child_close() vs. on_child_signal().

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 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.