Net::FastCGI::IO - Provides functions to read and write FastCGI messages.
# FCGI_Header @values = read_header($fh); $header = read_header($fh); $result = write_header($fh, $type, $request_id, $content_length, $padding_length); # FCGI_Record @values = read_record($fh); $record = read_record($fh); $result = write_record($fh, $type, $request_id); $result = write_record($fh, $type, $request_id, $content); # FCGI_Record Stream $result = write_stream($fh, $type, $request_id, $content); $result = write_stream($fh, $type, $request_id, $content, $terminate); # I/O ready $result = can_read($fh, $timeout); $result = can_write($fh, $timeout);
Provides unbuffered blocking I/O functions to read and write FastCGI messages.
Attempts to read a FCGI_Header from file handle $fh.
FCGI_Header
$fh
Usage
($type, $request_id, $content_length, $padding_length) = read_header($fh); $header = read_header($fh); say $header->{type}; say $header->{request_id}; say $header->{content_length}; say $header->{padding_length};
Arguments
The file handle to read from. Must be a file handle with a file descriptor. File handle mode should be set to binary.
Returns
Upon successful completion, the return value of "parse_header" in Net::FastCGI::Protocol. Otherwise, a false value (undef in scalar context and an empty list in list context).
undef
If read_header reaches end-of-file before reading any octets, it returns a false value. If unsuccessful, read_header returns a false value and $! contains the error from the sysread call. If read_header encounters end-of-file after some but not all of the needed octets, the function returns a false value and sets $! to EPIPE.
read_header
$!
sysread
EPIPE
Implementation
The implementation calls sysread in a loop, restarting if sysread returns undef with $! set to EINTR. If sysread does not provide all the requested octets, read_header continues to call sysread until either all the octets have been read, reaches end-of-file or an error occurs.
EINTR
Attempts to read a FCGI_Record from file handle $fh.
FCGI_Record
($type, $request_id, $content) = read_record($fh); $record = read_record($fh); say $record->{type}; say $record->{request_id};
Upon successful completion, the return value of "parse_record" in Net::FastCGI::Protocol. Otherwise, a false value (undef in scalar context and an empty list in list context).
If read_record reaches end-of-file before reading any octets, it returns a false value. If unsuccessful, read_record returns a false value and $! contains the error from the sysread call. If read_record encounters end-of-file after some but not all of the needed octets, the function returns a false value and sets $! to EPIPE.
read_record
The implementation calls sysread in a loop, restarting if sysread returns undef with $! set to EINTR. If sysread does not provide all the requested octets, read_record continues to call sysread until either all the octets have been read, reaches end-of-file or an error occurs.
Attempts to write a FCGI_Header to file handle $fh.
$result = write_header($fh, $type, $request_id, $content_length, $padding_length);
The file handle to write to. Must be a file handle with a file descriptor. File handle mode should be set to binary.
$type
An unsigned 8-bit integer.
$request_id
An unsigned 16-bit integer.
$content_length
$padding_length
$result
Upon successful completion, the number of octets actually written. Otherwise, undef and $! contains the error from the syswrite call.
syswrite
The implementation calls syswrite in a loop, restarting if syswrite returns undef with $! set to EINTR. If syswrite does not output all the requested octets, write_header continues to call syswrite until all the octets have been written or an error occurs.
write_header
Attempts to write a FCGI_Record to file handle $fh.
$result = write_record($fh, $type, $request_id); $result = write_record($fh, $type, $request_id, $content);
$content
A string of octets containing the content, cannot exceed 65535 octets in length.
The implementation calls syswrite in a loop, restarting if syswrite returns undef with $! set to EINTR. If syswrite does not output all the requested octets, write_record continues to call syswrite until all the octets have been written or an error occurs.
write_record
Attempts to write a FCGI_Record stream to file handle $fh.
$result = write_stream($fh, $type, $request_id, $content); $result = write_stream($fh, $type, $request_id, $content, $terminate);
A string of octets containing the stream content.
$terminate
A boolean indicating whether or not the stream should be terminated. Defaults to false.
The implementation calls syswrite in a loop, restarting if syswrite returns undef with $! set to EINTR. If syswrite does not output all the requested octets, write_stream continues to call syswrite until all the octets have been written or an error occurs.
write_stream
Determines wheter or not the given file handle $fh is ready for reading within the given timeout $timeout.
$timeout
$result = can_read($fh, $timeout);
The file handle to test for readiness. Must be a file handle with a file descriptor.
Maximum interval to wait. Can be set to either a non-negative numeric value or undef for infinite wait.
Upon successful completion, 0 or 1. Otherwise, undef and $! contains the select error.
0
1
select
The implementation calls select in a loop, restarting if select returns -1 with $! set to EINTR and $timeout has not elapsed.
-1
Determines wheter or not the given file handle $fh is ready for writing within the given timeout $timeout.
$result = can_write($fh, $timeout);
None by default. All functions can be exported using the :all tag or individually.
:all
Subroutine called with wrong number of arguments.
http://www.fastcgi.com/devkit/doc/fcgi-spec.html
http://tools.ietf.org/html/rfc3875
Christian Hansen chansen@cpan.org
chansen@cpan.org
Copyright 2008-2010 by Christian Hansen.
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
To install Net::FastCGI, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Net::FastCGI
CPAN shell
perl -MCPAN -e shell install Net::FastCGI
For more information on module installation, please visit the detailed CPAN module installation guide.