lib::HTTP::Message
Section: User Contributed Perl Documentation
(3)
Updated: perl 5.004, patch 55
Index
Return to Main Contents
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 the HTTP::Headers manpage 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.
Index
- NAME
-
- SYNOPSIS
-
- DESCRIPTION
-
- METHODS
-
- $mess = new HTTP::Message;
-
- $mess->clone()
-
- $mess->protocol([$proto])
-
- $mess->content([$content])
-
- $mess->add_content($data)
-
- $mess->content_ref
-
- HEADER METHODS
-
- $mess->headers_as_string([$endl])
-
This document was created by
man2html,
using the manual pages.
Time: 23:58:16 GMT, February 15, 2023