NAME
IOMux::Handler::Read - any mux reader
INHERITANCE
IOMux::Handler::Read
is a IOMux::Handler
IOMux::Handler::Read is extended by
IOMux::Bundle
IOMux::File::Read
IOMux::Net::TCP
IOMux::Pipe::Read
SYNOPSIS
# only use extensions
DESCRIPTION
This base-class defines the interface which every reader offers.
Extends "DESCRIPTION" in IOMux::Handler.
METHODS
Extends "METHODS" in IOMux::Handler.
Constructors
Extends "Constructors" in IOMux::Handler.
- IOMux::Handler::Read->new(OPTIONS)
-
-Option --Defined in --Default fh IOMux::Handler <required> name IOMux::Handler <stringified handle> read_size 32768
- IOMux::Handler::Read->open(MODE, WHAT, OPTIONS)
-
Inherited, see "Constructors" in IOMux::Handler
Accessors
Extends "Accessors" in IOMux::Handler.
- $obj->fh()
-
Inherited, see "Accessors" in IOMux::Handler
- $obj->fileno()
-
Inherited, see "Accessors" in IOMux::Handler
- $obj->mux()
-
Inherited, see "Accessors" in IOMux::Handler
- $obj->name()
-
Inherited, see "Accessors" in IOMux::Handler
- $obj->readSize( [INTEGER] )
-
The number of bytes requested at each read.
- $obj->usesSSL()
-
Inherited, see "Accessors" in IOMux::Handler
User interface
Extends "User interface" in IOMux::Handler.
Connection
Extends "Connection" in IOMux::Handler.
- $obj->close( [CALLBACK] )
-
Inherited, see "Connection" in IOMux::Handler
- $obj->timeout( [TIMEOUT] )
-
Inherited, see "Connection" in IOMux::Handler
Reading
- $obj->readline(CALLBACK)
-
Read a single line (bytes upto a LF or CRLF). After the whole line has arrived, the CALLBACK will be invoked with the received line as parameter. that line is terminated by a LF (\n), even when the file contains CRLF or CR endings.
At end of file, the last fragment will be returned.
- $obj->slurp(CALLBACK)
-
Read all remaining data from a resource. After everything has been read, it will be returned as SCALAR (string reference)
example:
my $pwd = $mux->open('<', '/etc/passwd'); my $data = $pwd->slurp; my $size = length $$data;
Multiplexer
Extends "Multiplexer" in IOMux::Handler.
Connection
Extends "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_timeout()
-
Inherited, see "Connection" in IOMux::Handler
Reading
Extends "Reading" in IOMux::Handler.
- $obj->mux_eof(INPUT)
-
This is called when an end-of-file condition is present on the handle. Like mux_input(), it is also passed a reference to the input buffer. You should consume the entire buffer or else it will just be lost.
- $obj->mux_except_flagged(FILENO)
-
Inherited, see "Reading" in IOMux::Handler
- $obj->mux_input(BUFFER)
-
Called when new input has arrived on the input. It is passed a reference to the input BUFFER. It must remove any input that it you have consumed from the BUFFER, and leave any partially received data in there.
example:
sub mux_input { my ($self, $inbuf) = @_; # Process each whole line in the input, leaving partial # lines in the input buffer for more. while($$inbuf =~ s/^(.*?)\r?\n// ) { $self->process_command($1); } }
- $obj->mux_read_flagged(FILENO)
-
Inherited, see "Reading" in IOMux::Handler
Writing
Extends "Writing" in IOMux::Handler.
- $obj->mux_write_flagged(FILENO)
-
Inherited, see "Writing" in IOMux::Handler
Service
Extends "Service" in IOMux::Handler.
Helpers
Extends "Helpers" in IOMux::Handler.
- $obj->extractSocket(HASH)
- IOMux::Handler::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