NAME

IOMux::Bundle - logical group of connections

INHERITANCE

 IOMux::Bundle
   is a IOMux::Handler::Read
   is a IOMux::Handler

 IOMux::Bundle
   is a IOMux::Handler::Write
   is a IOMux::Handler

 IOMux::Bundle is extended by
   IOMux::IPC

SYNOPSIS

  my $syscall = IOMux::Bundle::Parallel->new(...);
  $mux->add($syscall);

DESCRIPTION

A bundle is a set of file handles, so a convenience wrapper around a set of different connections with a single purpose.

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

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

METHODS

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

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

Constructors

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

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

IOMux::Bundle->new(OPTIONS)

The stdin, stdout and stderr objects are from the perspective of the other side.

 -Option    --Defined in           --Default
  fh          IOMux::Handler         <required>
  name        IOMux::Handler         <stringified handle>
  read_size   IOMux::Handler::Read   32768
  stderr                             <undef>
  stdin                              <required>
  stdout                             <required>
  write_size  IOMux::Handler::Write  4096

fh => FILEHANDLE

name => STRING

read_size => INTEGER

stderr => IOMux::Handler::Read object

stdin => IOMux::Handler::Write object

stdout => IOMux::Handler::Read object

write_size => INTEGER

IOMux::Bundle->open(MODE, WHAT, OPTIONS)

Inherited, see "Constructors" in IOMux::Handler

IOMux::Bundle->open(MODE, WHAT, OPTIONS)

Inherited, see "Constructors" in IOMux::Handler

Accessors

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

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

$obj->connections()

$obj->fh()

Inherited, see "Accessors" in IOMux::Handler

$obj->fh()

Inherited, see "Accessors" in IOMux::Handler

$obj->fileno()

Inherited, see "Accessors" in IOMux::Handler

$obj->fileno()

Inherited, see "Accessors" in IOMux::Handler

$obj->mux()

Inherited, see "Accessors" in IOMux::Handler

$obj->mux()

Inherited, see "Accessors" in IOMux::Handler

$obj->name()

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->stderr()

$obj->stdin()

$obj->stdout()

$obj->usesSSL()

Inherited, see "Accessors" in IOMux::Handler

$obj->usesSSL()

Inherited, see "Accessors" in IOMux::Handler

$obj->writeSize( [INTEGER] )

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

User interface

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

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

Multiplexer

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

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

Connection

Extends "Connection" in IOMux::Handler::Write.

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

$obj->mux_init( MUX, [HANDLER] )

Inherited, see "Connection" in IOMux::Handler

$obj->mux_init( MUX, [HANDLER] )

Inherited, see "Connection" in IOMux::Handler

$obj->mux_remove()

Inherited, see "Connection" in IOMux::Handler

$obj->mux_remove()

Inherited, see "Connection" in IOMux::Handler

$obj->mux_timeout()

Inherited, see "Connection" in IOMux::Handler

$obj->mux_timeout()

Inherited, see "Connection" in IOMux::Handler

Reading

Extends "Reading" in IOMux::Handler::Write.

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

$obj->mux_eof(INPUT)

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

$obj->mux_except_flagged(FILENO)

Inherited, see "Reading" in IOMux::Handler

$obj->mux_except_flagged(FILENO)

Inherited, see "Reading" in IOMux::Handler

$obj->mux_input(BUFFER)

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

$obj->mux_read_flagged(FILENO)

Inherited, see "Reading" in IOMux::Handler

$obj->mux_read_flagged(FILENO)

Inherited, see "Reading" in IOMux::Handler

Writing

Extends "Writing" in IOMux::Handler::Write.

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

$obj->mux_outbuffer_empty()

Inherited, see "Writing" in IOMux::Handler::Write

$obj->mux_output_waiting()

Inherited, see "Writing" in IOMux::Handler::Write

$obj->mux_write_flagged(FILENO)

Inherited, see "Writing" in IOMux::Handler

$obj->mux_write_flagged(FILENO)

Inherited, see "Writing" in IOMux::Handler

Service

Extends "Service" in IOMux::Handler::Write.

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

Errors

$obj->mux_error(BUFFER)

Called when new input has arrived on the error channel. It is passed a reference to the error BUFFER. It must remove any input that it you have consumed from the BUFFER, and leave any partially received data in there for more text to arrive.

example:

  # actually, this is the default behavior
  sub mux_error
  {   my ($self, $errbuf) = @_;
      print STDERR $$errbuf;
      $$errbuf = '';
  } 

Helpers

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

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

$obj->extractSocket(HASH)

IOMux::Bundle->extractSocket(HASH)

Inherited, see "Helpers" in IOMux::Handler

$obj->extractSocket(HASH)

IOMux::Bundle->extractSocket(HASH)

Inherited, see "Helpers" in IOMux::Handler

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

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

$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

cpanm IOMux

perl -MCPAN -e shell
install IOMux