The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

HTTP::Response - Class encapsulating HTTP Responses

SYNOPSIS

 require HTTP::Response;

DESCRIPTION

HTTP::Response is a class encapsulating HTTP style responses, consisting of a response line, a MIME header, and usually content. Note that the LWP library also uses this HTTP style responses for non-HTTP protocols.

Instances of this class are usually created by calling 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(). 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 might not be the same request that was passed to the $ua->request() method, because there might have been redirects and authorization retries.

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="...">
  2.  A "Base:" header in the response
  3.  The URL used to request this response

$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.

error_as_HTML()

Return string with a complete HTML document indicating what error occurred