NAME

HTTP::Response - Class encapsulating HTTP Responses

SYNOPSIS

 require HTTP::Response;

DESCRIPTION

The HTTP::Response class encapsulate HTTP style responses. A response consist of a response line, some headers, and a (potential empty) content. Note that the LWP library will use HTTP style responses also for non-HTTP protocol schemes.

Instances of this class are usually created and returned by the request() method of an LWP::UserAgent object:

 ...
 $response = $ua->request($request)
 if ($response->is_success) {
     print $response->content;
 } else {
     print $response->error_as_HTML;
 }

METHODS

HTTP::Response is a subclass of HTTP::Message and therefore inherits its methods. The inherited methods are header(), push_header(), remove_header(), headers_as_string(), and content(). The header convenience methods are also available. See HTTP::Message for details.

$r = new HTTP::Response ($rc [, $msg])

Constructs a new HTTP::Response object describing a response with response code $rc and optional message $msg

$r->code([$code])

$r->message([$message])

$r->request([$request])

$r->previous([$previousResponse])

These methods provide public access to the member variables. The first two containing respectively the response code and the message of the response.

The request attribute is a reference the request that gave this response. It does not have to be the same request as passed to the $ua->request() method, because there might have been redirects and authorization retries in between.

The previous attribute is used to link together chains of responses. You get chains of responses if the first response is redirect or unauthorized.

$r->base

Returns the base URL for this response. The base URL can come from 3 sources:

1. Embedded in the document content, for instance <BASE HREF="..."> in HTML documents.

2. A "Base:" header in the response

3. The URL used to request this response

A base URL embedded in the document will initialize the "Base:" header in the response object, which means that only the last 2 sources are checked by this method.

$r->as_string()

Method returning a textual representation of the request. Mainly useful for debugging purposes. It takes no arguments.

$r->is_info

$r->is_success

$r->is_redirect

$r->is_error

These methods indicate if the response was informational, sucessful, a redirection, or an error.

$r->error_as_HTML()

Return a string containing a complete HTML document indicating what error occurred. This method should only be called when $r->is_error is TRUE.

cpanm LWP

perl -MCPAN -e shell
install LWP