NAME

Mojo::IOLoop::ReadWriteFork - Fork a process and read/write from it

VERSION

0.16

DESCRIPTION

This class enable you to fork children which you can write data to and emit events when the child prints to STDERR or STDOUT.

Patches that enable the "read" event to see the difference between STDERR and STDOUT are more than welcome.

SYNOPSIS

Standalone

  my $fork = Mojo::IOLoop::ReadWriteFork->new;
  my $cat_result = '';

  $fork->on(error => sub {
    my($fork, $error) = @_;
    warn $error;
  });
  $fork->on(close => sub {
    my($fork, $exit_value, $signal) = @_;
    warn "got close event";
    Mojo::IOLoop->stop;
  });
  $fork->on(read => sub {
    my($fork, $buffer) = @_; # $buffer = both STDERR and STDOUT
    $cat_result .= $buffer;
  });

  $fork->start(
    program => 'bash',
    program_args => [ -c => 'echo $YIKES foo bar baz' ],
    conduit => 'pty',
  );

In a Mojolicios::Controller

See https://github.com/jhthorsen/mojo-ioloop-readwritefork/tree/master/example/tail.pl.

EVENTS

close

  $self->emit(close => sub { my($self, $exit_value, $signal) = @_; });

Emitted when the child process exit.

error

  $self->emit(error => sub { my($self, $str) = @_; });

Emitted when when the there is an issue with creating, writing or reading from the child process.

read

  $self->emit(read => sub { my($self, $chunk) = @_; });

Emitted when the child has written a chunk of data to STDOUT or STDERR.

ATTRIBUTES

ioloop

  $ioloop = $self->ioloop;
  $self = $self->ioloop(Mojo::IOLoop->singleton);

Holds a Mojo::IOLoop object.

pid

  $int = $self->pid;

Holds the child process ID.

reactor

DEPRECATED.

METHODS

close

  $self = $self->close("stdin");

Close STDIN stream to the child process immediately.

run

  $self = $self->run($program, @program_args);

Simpler version of "start".

start

  $self->start(
    program => sub { my @program_args = @_; ... },
    program_args => [ @data ],
  );

  $self->start(
    program => $str,
    program_args => [@str],
    conduit => $str, # pipe or pty
    raw => $bool,
    clone_winsize_from => \*STDIN,
  );

Used to fork and exec a child process.

raw and clone_winsize_from|IO::Pty only makes sense if conduit is "pty".

write

  $self = $self->write($chunk);
  $self = $self->write($chunk, $cb);

Used to write data to the child process STDIN. An optional callback will be called once STDIN is drained.

Example:

  $self->write("some data\n", sub {
    my ($self) = @_;
    $self->close;
  });

kill

  $bool = $self->kill;
  $bool = $self->kill(15); # default

Used to signal the child.

AUTHOR

Jan Henning Thorsen - jhthorsen@cpan.org