/ 
IO-Mux-0.11
River stage zero No dependents
/ IO::Mux::File::Read

NAME

IO::Mux::File::Read - write to file

INHERITANCE

IO::Mux::File::Read
  is a IO::Mux::Handler::Read
  is a IO::Mux::Handler

SYNOPSIS

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

use IO::Mux::Open '<';
my $file = $mux->open('<', $filename);

use IO::Mux::File::Read;
my $file = IO::Mux::File::Read->new(file => $filename);
$mux->add($file);

$file->getline(sub {print "\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.

METHODS

Constructors

IO::Mux::File::Read->new(OPTIONS)
-Option   --Defined in     --Default
 exclusive                   <false>
 fh         IO::Mux::Handler  <required>
 file                        <required>
 mode                        '<'
 modeflags                   <undef>
 name       IO::Mux::Handler  '<$file'
 read_size  IO::Mux::Handler::Read  32768
exclusive => BOOLEAN
fh => FILEHANDLE
file => FILENAME|HANDLE
mode => '<'

For now, the mode is always simply

modeflags => INTEGER

When defined, the exclusive option is not used, but your value is taken. Use constants defined by Fcntl. Do not forget to include O_NONBLOCK.

name => STRING
read_size => INTEGER
IO::Mux::File::Read->open(MODE, FILE, OPTIONS)

Accessors

$obj->fh See "Accessors" in IO::Mux::Handler
$obj->fileno See "Accessors" in IO::Mux::Handler
$obj->mode

The bits of the open mode.

$obj->mux See "Accessors" in IO::Mux::Handler
$obj->name See "Accessors" in IO::Mux::Handler
$obj->readSize([INTEGER]) See "Accessors" in IO::Mux::Handler::Read
$obj->usesSSL See "Accessors" in IO::Mux::Handler

User interface

Connection

$obj->close([CALLBACK]) See "Connection" in IO::Mux::Handler
$obj->timeout([TIMEOUT]) See "Connection" in IO::Mux::Handler

Reading

$obj->readline(CALLBACK) See "Reading" in IO::Mux::Handler::Read
$obj->slurp(CALLBACK) See "Reading" in IO::Mux::Handler::Read

Multiplexer

Connection

$obj->mux_init(MUX, [HANDLER]) See "Connection" in IO::Mux::Handler
$obj->mux_remove See "Connection" in IO::Mux::Handler
$obj->mux_timeout See "Connection" in IO::Mux::Handler

Reading

$obj->mux_eof(INPUT) See "Reading" in IO::Mux::Handler::Read
$obj->mux_except_flagged(FILENO) See "Reading" in IO::Mux::Handler
$obj->mux_input(BUFFER) See "Reading" in IO::Mux::Handler::Read
$obj->mux_read_flagged(FILENO) See "Reading" in IO::Mux::Handler

Writing

$obj->mux_write_flagged(FILENO) See "Writing" in IO::Mux::Handler

Service

Helpers

$obj->extractSocket(HASH)
IO::Mux::File::Read->extractSocket(HASH) See "Helpers" in IO::Mux::Handler
$obj->fdset(STATE, READ, WRITE, ERROR) See "Helpers" in IO::Mux::Handler
$obj->show See "Helpers" in IO::Mux::Handler

SEE ALSO

This module is part of IO-Mux distribution version 0.11, built on January 26, 2011. Website: http://perl.overmeer.net/ All modules in this suite: "Any::Daemon", "IO::Mux", and "IO::Mux::HTTP".

Please post questions or ideas to perl@overmeer.net

LICENSE

Copyrights 2011 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