table of contents
other versions
- wheezy 5.14.2-21+deb7u3
- jessie 5.20.2-3+deb8u6
- testing 5.24.1-3
- unstable 5.24.1-3
- experimental 5.26.0-1
other sections
HTTP::Tiny(3perl) | Perl Programmers Reference Guide | HTTP::Tiny(3perl) |
NAME¶
HTTP::Tiny - A small, simple, correct HTTP/1.1 clientVERSION¶
version 0.012SYNOPSIS¶
use HTTP::Tiny; my $response = HTTP::Tiny->new->get('http://example.com/'); die "Failed!\n" unless $response->{success}; print "$response->{status} $response->{reason}\n"; while (my ($k, $v) = each %{$response->{headers}}) { for (ref $v eq 'ARRAY' ? @$v : $v) { print "$k: $_\n"; } } print $response->{content} if length $response->{content};
DESCRIPTION¶
This is a very simple HTTP/1.1 client, designed primarily for doing simple GET requests without the overhead of a large framework like LWP::UserAgent. It is more correct and more complete than HTTP::Lite. It supports proxies (currently only non-authenticating ones) and redirection. It also correctly resumes after EINTR.METHODS¶
new¶
$http = HTTP::Tiny->new( %attributes );This constructor returns a new HTTP::Tiny object. Valid attributes include:
- •
- agent
- •
- default_headers
- •
- max_redirect
- •
- max_size
- •
- proxy
- •
- timeout
get¶
$response = $http->get($url); $response = $http->get($url, \%options);Executes a "GET" request for the given URL. The URL must have unsafe characters escaped and international domain names encoded. Internally, it just calls "request()" with 'GET' as the method. See "request()" for valid options and a description of the response.
mirror¶
$response = $http->mirror($url, $file, \%options) if ( $response->{success} ) { print "$file is up to date\n"; }Executes a "GET" request for the URL and saves the response body to the file name provided. The URL must have unsafe characters escaped and international domain names encoded. If the file already exists, the request will includes an "If-Modified-Since" header with the modification timestamp of the file. You may specificy a different "If-Modified-Since" header yourself in the "$options->{headers}" hash. The "success" field of the response will be true if the status code is 2XX or 304 (unmodified). If the file was modified and the server response includes a properly formatted "Last-Modified" header, the file modification time will be updated accordingly.
request¶
$response = $http->request($method, $url); $response = $http->request($method, $url, \%options);Executes an HTTP request of the given method type ('GET', 'HEAD', 'POST', 'PUT', etc.) on the given URL. The URL must have unsafe characters escaped and international domain names encoded. A hashref of options may be appended to modify the request. Valid options are:
- •
- headers
- •
- content
- •
- trailer_callback
- •
- data_callback
- •
- success
- •
- status
- •
- reason
- •
- content
- •
- headers
LIMITATIONS¶
HTTP::Tiny is conditionally compliant with the HTTP/1.1 specification <http://www.w3.org/Protocols/rfc2616/rfc2616.html>. It attempts to meet all "MUST" requirements of the specification, but does not implement all "SHOULD" requirements. Some particular limitations of note include:- •
- HTTP::Tiny focuses on correct transport. Users are responsible for ensuring that user-defined headers and content are compliant with the HTTP/1.1 specification.
- •
- Users must ensure that URLs are properly escaped for unsafe characters and that international domain names are properly encoded to ASCII. See URI::Escape, URI::_punycode and Net::IDN::Encode.
- •
- Redirection is very strict against the specification. Redirection is only automatic for response codes 301, 302 and 307 if the request method is 'GET' or 'HEAD'. Response code 303 is always converted into a 'GET' redirection, as mandated by the specification. There is no automatic support for status 305 ("Use proxy") redirections.
- •
- Persistant connections are not supported. The "Connection" header will always be set to "close".
- •
- Direct "https" connections are supported only if IO::Socket::SSL is installed. There is no support for "https" connections via proxy. Any SSL certificate that matches the host is accepted -- SSL certificates are not verified against certificate authorities.
- •
- Cookies are not directly supported. Users that set a "Cookie" header should also set "max_redirect" to zero to ensure cookies are not inappropriately re-transmitted.
- •
- Proxy environment variables are not supported.
- •
- There is no provision for delaying a request body using an "Expect" header. Unexpected "1XX" responses are silently ignored as per the specification.
- •
- Only 'chunked' "Transfer-Encoding" is supported.
- •
- There is no support for a Request-URI of '*' for the 'OPTIONS' request.
SEE ALSO¶
- •
- LWP::UserAgent
SUPPORT¶
Bugs / Feature Requests¶
Please report any bugs or feature requests by email to "bug-http-tiny at rt.cpan.org", or through the web interface at http://rt.cpan.org/Public/Dist/Display.html?Name=HTTP-Tiny <http://rt.cpan.org/Public/Dist/Display.html?Name=HTTP-Tiny>. You will be automatically notified of any progress on the request by the system.Source Code¶
This is open source software. The code repository is available for public review and contribution under the terms of the license. http://github.com/dagolden/p5-http-tiny/tree <http://github.com/dagolden/p5-http-tiny/tree>git clone git://github.com/dagolden/p5-http-tiny.git
AUTHORS¶
- •
- Christian Hansen <chansen@cpan.org>
- •
- David Golden <dagolden@cpan.org>
COPYRIGHT AND LICENSE¶
This software is copyright (c) 2011 by Christian Hansen. This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.2011-09-26 | perl v5.14.2 |