Codex

LWP::Simple

Section: User Contributed Perl Documentation (3pm)

Updated: 2014-04-23

Index?action=index Return to Main Contents


NAME

LWP::Simple - simple procedural interface to LWP

SYNOPSIS

perl -MLWP::Simple -e 'getprint "http://www.sn.no"'

use LWP::Simple; $content = get("http://www.sn.no/"); die "Couldn't get it!" unless defined $content;

if (mirror("http://www.sn.no/", "foo") == RC_NOT_MODIFIED) { ... }

if (is_success(getprint("http://www.sn.no/"))) { ... }

@]

DESCRIPTION

This module is meant for people who want a simplified view of the libwww-perl library. It should also be suitable for one-liners. If you need more control or access to the header fields in the requests sent and responses received, then you should use the full object-oriented interface provided by the module.

The following functions are provided (and exported) by this module:

get($url)
The get() function will fetch the document identified by the given URL and return it. It returns if it fails. The argument can be either a string or a reference to a URI object.

You will not be able to examine the response code or response headers (like 'Content-Type') when you are accessing the web using this function. If you need that information you should use the full OO interface (see LWP::UserAgent).

:

head($url)
Get document headers. Returns the following 5 values if successful: ($content_type, , , , )

Returns an empty list if it fails. In scalar context returns TRUE if successful.

:

getprint($url)
Get and print a document identified by a URL. The document is printed to the selected default filehandle for output (normally STDOUT) as data is received from the network. If the request fails, then the status code and message are printed on STDERR. The return value is the HTTP response code.:
getstore($url, $file)
Gets a document identified by a URL and stores it in the file. The return value is the HTTP response code.:
mirror($url, $file)
Get and store a document identified by a URL, using If-modified-since, and checking the Content-Length. Returns the HTTP response code.:

This module also exports the HTTP::Status constants and procedures. You can use them when you check the response code from getprint(), getstore() or mirror(). The constants are:

The HTTP::Status classification functions are:

is_success($rc)
True if response code indicated a successful request.:
is_error($rc)
True if response code indicated that an error occurred.:
The module will also export the LWP::UserAgent object as if you ask for it explicitly.
The user agent created by this module will identify itself as ``LWP::Simple/#.##'' and will initialize its proxy defaults from the environment (by calling ->env_proxy).

CAVEAT

Note that if you are using both LWP::Simple and the very popular CGI.pm module, you may be importing a function from each module, producing a warning like ``Prototype mismatch: sub main::head ($) vs none''. Get around this problem by just not importing LWP::Simple's function, like so:
Then if you do need LWP::Simple's function, you can just call it as .

SEE ALSO

LWP, lwpcook, LWP::UserAgent, HTTP::Status, lwp-request, lwp-mirror


Index

NAME

SYNOPSIS

DESCRIPTION

CAVEAT

SEE ALSO