Ralf S. Engelschall > lcwa > HTTP::Message

Download:
lcwa-1.0.0.tar.gz

Dependencies

Annotate this POD

Related Modules

LWP::UserAgent
HTTP::Request
HTTP::Response
WWW::Mechanize
HTTP::Headers
HTTP::Proxy
Data::Dumper
HTTP::Cookies
LWP::Simple
HTTP::Daemon
more...
By perlmonks.org

CPAN RT

New  3
Open  0
View/Report Bugs
Source  

NAME ^

HTTP::Message - Class encapsulating HTTP messages

SYNOPSIS ^

 package HTTP::Request;  # or HTTP::Response
 require HTTP::Message;
 @ISA=qw(HTTP::Message);

DESCRIPTION ^

A HTTP::Message object contains some headers and a content (body). The class is abstract, i.e. it only used as a base class for HTTP::Request and HTTP::Response and should never instantiated as itself.

METHODS ^

$mess = new HTTP::Message;

This is the object constructor. It should only be called internally by this library. External code should construct HTTP::Request or HTTP::Response objects.

$mess->clone()

Returns a copy of the object.

$mess->protocol([$proto])

Sets the HTTP protocol used for the message. The protocol() is a string like "HTTP/1.0" or "HTTP/1.1".

$mess->content([$content])

The content() method sets the content if an argument is given. If no argument is given the content is not touched. In either case the previous content is returned.

$mess->add_content($data)

The add_content() methods appends more data to the end of the previous content.

$mess->content_ref

The content_ref() method will return a reference to content string. It can be more efficient to access the content this way if the content is huge, and it can be used for direct manipulation of the content, for instance:

  ${$res->content_ref} =~ s/\bfoo\b/bar/g;

HEADER METHODS ^

All unknown HTTP::Message methods are delegated to the HTTP::Headers object that is part of every message. This allows convenient access to these methods. Refer to HTTP::Headers for details of these methods:

  $mess->header($field => $val);
  $mess->scan(&doit);
  $mess->push_header($field => $val);
  $mess->remove_header($field);

  $mess->date;
  $mess->expires;
  $mess->if_modified_since;
  $mess->last_modified;
  $mess->content_type;
  $mess->content_encoding;
  $mess->content_length;
  $mess->title;
  $mess->user_agent;
  $mess->server;
  $mess->from;
  $mess->referer;
  $mess->www_authenticate;
  $mess->authorization;
  $mess->authorization_basic;

$mess->headers_as_string([$endl])

Call the HTTP::Headers->as_string() method for the headers in the message.

syntax highlighting: