Apache2::RequestIO - Perl API for Apache request record IO
use Apache2::RequestIO ();
$rc = $r->discard_request_body();
$r->puts("foo", "bar"); # same as print, but no flushing
$r->printf("%s $d", "foo", 5);
$r->write("foobartarcar", 3, 5);
Apache2::RequestIO provides the API to perform IO on the Apache request object.
Apache2::RequestIO provides the following functions and/or methods:
In HTTP/1.1, any method can have a body. However, most GET handlers wouldn't know what to do with a request body if they received one. This helper routine tests for and reads any message body in the request, simply discarding whatever it receives. We need to do this because failing to read the request body would cause it to be interpreted as the next request on a persistent connection.
$rc = $r->discard_request_body();
The current request
APR::Const status constant if request is malformed, Apache2::Const::OK otherwise.
APR::Const status constant
Since we return an error status if the request is malformed, this routine should be called at the beginning of a no-body handler, e.g.,
use Apache2::Const -compile => qw(OK);
$rc = $r->discard_request_body;
return $rc if $rc != Apache2::Const::OK;
Send data to the client.
$cnt = $r->print(@msg);
Data to send
How many bytes were sent (or buffered). If zero bytes were sent, print will return 0E0, or "zero but true," which will still evaluate to 0 in a numerical context.
The data is flushed only if STDOUT stream's $| is true. Otherwise it's buffered up to the size of the buffer, flushing only excessive data.
Format and send data to the client (same as printf).
$cnt = $r->printf($format, @args);
Format string, as in the Perl core printf function.
Arguments to be formatted, as in the Perl core printf function.
How many bytes were sent (or buffered)
Send data to the client
$cnt = $r->puts(@msg);
puts() is similar to print(), but it won't attempt to flush data, no matter what the value of STDOUT stream's $| is. Therefore assuming that STDOUT stream's $| is true, this method should be a tiny bit faster than print(), especially if small strings are printed.
Read data from the client.
$cnt = $r->read($buffer, $len);
$cnt = $r->read($buffer, $len, $offset);
The buffer to populate with the read data
How many bytes to attempt to read
If a non-zero $offset is specified, the read data will be placed at that offset in the $buffer.
META: negative offset and \0 padding are not supported at the moment
How many characters were actually read
This method shares a lot of similarities with the Perl core read() function. The main difference in the error handling, which is done via APR::Error exceptions
Flush any buffered data to the client.
Unless STDOUT stream's $| is false, data sent via $r->print() is buffered. This method flushes that data to the client.
Send a file or a part of it
$rc = $r->sendfile($filename);
$rc = $r->sendfile($filename, $offset);
$rc = $r->sendfile($filename, $offset, $len);
The full path to the file (using / on all systems)
Offset into the file to start sending.
No offset is used if $offset is not specified.
How many bytes to send.
If not specified the whole file is sent (or a part of it, if $offset if specified)
On success, APR::Const::SUCCESS is returned.
In case of a failure -- a failure code is returned, in which case normally it should be returned to the caller.
Exceptions are thrown only when this function is called in the VOID context. So if you don't want to handle the errors, just don't ask for a return value and the function will handle all the errors on its own.
Send partial string to the client
$cnt = $r->write($buffer);
$cnt = $r->write($buffer, $len);
$cnt = $r->write($buffer, $len, $offset);
The string with data
How many bytes to send. If not specified, or -1 is specified, all the data in $buffer (or starting from $offset) will be sent.
Offset into the $buffer string.
Assuming that we have a string:
$string = "123456789";
$r->write($string, 3, 5);
$r->write($string, -1, 5);
The TIE interface implementation. This interface is used for HTTP request handlers, when running under SetHandler perl-script and Perl doesn't have perlio enabled.
See the perltie manpage for more information.
See the binmode Perl entry in the perlfunc manpage
See the close Perl entry in the perlfunc manpage
See the fileno Perl entry in the perlfunc manpage
See the getc Perl entry in the perlfunc manpage
See the open Perl entry in the perlfunc manpage
See the print Perl entry in the perlfunc manpage
See the printf Perl entry in the perlfunc manpage
See the read Perl entry in the perlfunc manpage
See the tie Perl entry in the perlfunc manpage
See the untie Perl entry in the perlfunc manpage
See the write Perl entry in the perlfunc manpage
The following methods are deprecated, Apache plans to remove those in the future, therefore avoid using them.
This method is deprecated since the C implementation is buggy and we don't want you to use it at all. Instead use the plain $r->read().
This method is deprecated since $r->get_client_block is deprecated.
mod_perl 2.0 documentation.
mod_perl 2.0 and its core modules are copyrighted under The Apache Software License, Version 2.0.
The mod_perl development team and numerous contributors.
To install mod_perl2, copy and paste the appropriate command in to your terminal.
perl -MCPAN -e shell
For more information on module installation, please visit the detailed CPAN module installation guide.