Manual Pages for UNIX Darwin command on man Net::HTTP

Net::HTTP(3) User Contributed Perl Documentation Net::HTTP(3)

NAME

Net::HTTP - Low-level HTTP connection (client)

SYNOPSIS

use Net::HTTP;

my $s = Net::HTTP->new(Host => "www.perl.com") || die $@;

$s->writerequest(GET => "/", 'User-Agent' => "Mozilla/5.0");

my($code, $mess, %h) = $s->readresponseheaders;

while (1) {

my $buf;

my $n = $s->readentitybody($buf, 1024);

die "read failed: $!" unless defined $n;

last unless $n;

print $buf;

}

DESCRIPTION

The "Net::HTTP" class is a low-level HTTP client. An instance of the

"Net::HTTP" class represents a connection to an HTTP server. The HTTP

protocol is described in RFC 2616. The "Net::HTTP" class support

"HTTP/1.0" and "HTTP/1.1".

"Net::HTTP" is a sub-class of "IO::Socket::INET". You can mix the

methods described below with reading and writing from the socket directly. This is not necessary a good idea, unless you know what you are doing. The following methods are provided (in addition to those of "IO::Socket::INET"):

$s = Net::HTTP->new( %options )

The "Net::HTTP" constructor method takes the same options as

"IO::Socket::INET"'s as well as these: Host: Initial host attribute value KeepAlive: Initial keepalive attribute value SendTE: Initial sendte attributevalue HTTPVersion: Initial httpversion attribute value PeerHTTPVersion: Initial peerhttpversion attribute value MaxLineLength: Initial maxlinelength attribute value MaxHeaderLines: Initial maxheaderlines attribute value The "Host" option is also the default for "IO::Socket::INET"'s "PeerAddr". The "PeerPort" defaults to 80 if not provided. The "Listen" option provided by "IO::Socket::INET"'s constructor method is not allowed. If unable to connect to the given HTTP server then the constructor

returns "undef" and $@ contains the reason. After a successful

connect, a "Net:HTTP" object is returned.

$s->host

Get/set the default value of the "Host" header to send. The $host

must not be set to an empty string (or "undef") for HTTP/1.1.

$s->keepalive

Get/set the keep-alive value. If this value is TRUE then the

request will be sent with headers indicating that the server should try to keep the connection open so that multiple requests can be sent. The actual headers set will depend on the value of the "httpversion" and "peerhttpversion" attributes.

$s->sendte

Get/set the a value indicating if the request will be sent with a "TE" header to indicate the transfer encodings that the server can choose to use. If the "Compress::Zlib" module is installed then this will announce that this client accept both the deflate and gzip encodings.

$s->httpversion

Get/set the HTTP version number that this client should announce. This value can only be set to "1.0" or "1.1". The default is "1.1".

$s->peerhttpversion

Get/set the protocol version number of our peer. This value will initially be "1.0", but will be updated by a successful readresponseheaders() method call.

$s->maxlinelength

Get/set a limit on the length of response line and response header lines. The default is 4096. A value of 0 means no limit.

$s->maxheaderlength

Get/set a limit on the number of headers lines that a response can have. The default is 128. A value of 0 means no limit.

$s->formatrequest($method, $uri, %headers, [$content])

Format a request message and return it as a string. If the headers do not include a "Host" header, then a header is inserted with the value of the "host" attribute. Headers like "Connection" and

"Keep-Alive" might also be added depending on the status of the

"keepalive" attribute.

If $content is given (and it is non-empty), then a "Content-Length"

header is automatically added unless it was already present.

$s->writerequest($method, $uri, %headers, [$content])

Format and send a request message. Arguments are the same as for formatrequest(). Returns true if successful.

$s->formatchunk( $data )

Returns the string to be written for the given chunk of data.

$s->writechunk($data)

Will write a new chunk of request entity body data. This method

should only be used if the "Transfer-Encoding" header with a value

of "chunked" was sent in the request. Note, writing zero-length

data is a no-op. Use the writechunkeof() method to signal end of

entity body data. Returns true if successful.

$s->formatchunkeof( %trailers )

Returns the string to be written for signaling EOF when a

"Transfer-Encoding" of "chunked" is used.

$s->writechunkeof( %trailers )

Will write eof marker for chunked data and optional trailers. Note that trailers should not really be used unless is was signaled with a "Trailer" header. Returns true if successful.

($code, $mess, %headers) = $s->readresponseheaders( %opts )

Read response headers from server and return it. The $code is the

3 digit HTTP status code (see HTTP::Status) and $mess is the

textual message that came with it. Headers are then returned as key/value pairs. Since key letter casing is not normalized and the same key can even occur multiple times, assigning these values

directly to a hash is not wise. Only the $code is returned if this

method is called in scalar context. As a side effect this method updates the 'peerhttpversion' attribute. Options might be passed in as key/value pairs. There are currently only two options supported; "laxed" and "junkout". The "laxed" option will make readresponseheaders() more forgiving towards servers that have not learned how to speak HTTP properly. The "laxed" option is a boolean flag, and is enabled by passing in a TRUE value. The "junkout" option can be used to capture bad header lines when "laxed" is enabled. The value should be an array reference. Bad header lines will be pushed onto the array. The "laxed" option must be specified in order to communicate with

pre-HTTP/1.0 servers that don't describe the response outcome or

the data they send back with a header block. For these servers peerhttpversion is set to "0.9" and this method returns (200, "Assumed OK"). The method will raise an exception (die) if the server does not speak proper HTTP or if the "maxlinelength" or "maxheaderlength" limits are reached. If the "laxed" option is turned on and "maxlinelength" and "maxheaderlength" checks are turned off, then no exception will be raised and this method will always return a response code.

$n = $s->readentitybody($buf, $size);

Reads chunks of the entity body content. Basically the same interface as for read() and sysread(), but the buffer offset argument is not supported yet. This method should only be called after a successful readresponseheaders() call.

The return value will be "undef" on read errors, 0 on EOF, -1 if no

data could be returned this time, otherwise the number of bytes

assigned to $buf. The $buf set to "" when the return value is -1.

This method will raise exceptions (die) if the server does not speak proper HTTP. This can only happen when reading chunked data.

%headers = $s->gettrailers

After readentitybody() has returned 0 to indicate end of the entity body, you might call this method to pick up any trailers.

$s->rbuf

Get/set the read buffer content. The readresponseheaders() and readentitybody() methods use an internal buffer which they will look for data before they actually sysread more from the socket itself. If they read too much, the remaining data will be left in this buffer.

$s->rbuflength

Returns the number of bytes in the read buffer. This should always be the same as:

length($s->rbuf)

but might be more efficient. SSUUBBCCLLAASSSSIINNGG The readresponseheaders() and readentitybody() will invoke the sysread() method when they need more data. Subclasses might want to override this method to control how reading takes place. The object itself is a glob. Subclasses should avoid using hash key names prefixed with "http" and "io".

LWP, IO::Socket::INET, Net::HTTP::NB

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.