Mark Overmeer > IOMux > IOMux::Pipe::Read

Download:
IOMux-0.13.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.13   Source  

NAME ^

IOMux::Pipe::Read - read from an external command

INHERITANCE ^

 IOMux::Pipe::Read
   is a IOMux::Handler::Read
   is a IOMux::Handler

SYNOPSIS ^

  my $mux = IOMux::Select->new;  # or ::Poll

  use IOMux::Open '-|';
  my $pipe = $mux->open('-|', $command, @cmd_options);

  use IOMux::Pipe::Read;
  my $pipe = IOMux::Pipe::Read->new
    ( command => [$command, @cmd_options] );
  $mux->add($pipe);

  $pipe->getline(sub {print "$_[0]\n"});

DESCRIPTION ^

In an event driven program, reading is harder to use than writing: the read will very probably be stalled until data has arrived, so you will need a callback to handle the resulting data.

Extends "DESCRIPTION" in IOMux::Handler::Read.

METHODS ^

Extends "METHODS" in IOMux::Handler::Read.

Constructors

Extends "Constructors" in IOMux::Handler::Read.

IOMux::Pipe::Read->bare(OPTIONS)

Creates a pipe, but does not start a process (yet). Used by IOMux::IPC, which needs three pipes for one process. Returned is not only a new pipe object, but also a write handle to be connected to the other side.

All OPTIONS which are available to IOMux::Handler::Read::new() can be used here as well.

 -Option   --Default
  read_size  4096
read_size => INTEGER

example:

  my ($out, $out_rh)
      = IOMux::Pipe::Read->bare(name => 'stdout');
IOMux::Pipe::Read->new(OPTIONS)
 -Option   --Defined in          --Default
  command                          <required>
  fh         IOMux::Handler        <required>
  name       IOMux::Handler        '$cmd|'
  read_size  IOMux::Handler::Read  4096
command => COMMAND|ARRAY

The external command to be executed. Either the COMMAND needs to parameters, or you need to pass an ARRAY of the command name and all its parameters.

fh => FILEHANDLE
name => STRING
read_size => INTEGER
IOMux::Pipe::Read->open(MODE, (CMD, CMDOPTS)|(CMDARRAY, OPTIONS))

Open the pipe to read. MODE is always -|. When you need to pass additional OPTIONS to the implied new(), then you must use an ARRAY for command name and its optional parameters.

example:

  my $mux = IOMux::Poll->new;
  $mux->open('-|', 'who', '-H');  # no opts
  $mux->open('-|', ['who', '-H'], %opts);
  $mux->open('-|', 'who');        # no opts
  $mux->open('-|', ['who'], %opts);

Accessors

Extends "Accessors" in IOMux::Handler::Read.

$obj->childPid()

The process id of the child on the other side of the pipe.

$obj->fh()

Inherited, see "Accessors" in IOMux::Handler

$obj->fileno()

Inherited, see "Accessors" in IOMux::Handler

$obj->mode()

The bits of the open mode.

$obj->mux()

Inherited, see "Accessors" in IOMux::Handler

$obj->name()

Inherited, see "Accessors" in IOMux::Handler

$obj->readSize( [INTEGER] )

Inherited, see "Accessors" in IOMux::Handler::Read

$obj->usesSSL()

Inherited, see "Accessors" in IOMux::Handler

User interface

Extends "User interface" in IOMux::Handler::Read.

Multiplexer

Extends "Multiplexer" in IOMux::Handler::Read.

Helpers

Extends "Helpers" in IOMux::Handler::Read.

$obj->extractSocket(HASH)
IOMux::Pipe::Read->extractSocket(HASH)

Inherited, see "Helpers" in IOMux::Handler

$obj->fdset(STATE, READ, WRITE, ERROR)

Inherited, see "Helpers" in IOMux::Handler

$obj->show()

Inherited, see "Helpers" in IOMux::Handler

SEE ALSO ^

This module is part of IOMux distribution version 0.13, built on July 21, 2015. Website: http://perl.overmeer.net/ All modules in this suite: "Any::Daemon", "IOMux", and "IOMux::HTTP".

Please post questions or ideas to perl@overmeer.net

LICENSE ^

Copyrights 2011-2015 by [Mark Overmeer]. For other contributors see ChangeLog.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See http://www.perl.com/perl/misc/Artistic.html

syntax highlighting: