http::message(3) [redhat man page]

HTTP::Message(3)					User Contributed Perl Documentation					  HTTP::Message(3)

NAME

       HTTP::Message - Class encapsulating HTTP messages

SYNOPSIS

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

DESCRIPTION

       An "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.

       The following methods are available:

       $mess = HTTP::Message->new
	   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 current content buffer.

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

	     ${$res->content_ref} =~ s/foo/bar/g;

       $mess->headers;
	   Return the embedded HTTP::Headers object.

       $mess->headers_as_string([$endl])
	   Call the as_string() method for the headers in the message.	This will be the same as:

	    $mess->headers->as_string

	   but it will make your program a whole character shorter :-)

       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->push_header($field => $val);
	 $mess->init_header($field => $val);
	 $mess->remove_header($field);
	 $mess->scan(&doit);

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

COPYRIGHT

       Copyright 1995-2001 Gisle Aas.

       This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

libwww-perl-5.65						    2001-11-15							  HTTP::Message(3)

HTTP::Request(3)					User Contributed Perl Documentation					  HTTP::Request(3)

NAME

       HTTP::Request - HTTP style request message

SYNOPSIS

	require HTTP::Request;
	$request = HTTP::Request->new(GET => 'http://www.example.com/');

       and usually used like this:

	$ua = LWP::UserAgent->new;
	$response = $ua->request($request);

DESCRIPTION

       "HTTP::Request" is a class encapsulating HTTP style requests, consisting of a request line, some headers, and a content body. Note that the
       LWP library uses HTTP style requests even for non-HTTP protocols.  Instances of this class are usually passed to the request() method of an
       "LWP::UserAgent" object.

       "HTTP::Request" is a subclass of "HTTP::Message" and therefore inherits its methods.  The following additional methods are available:

       $r = HTTP::Request->new( $method, $uri )
       $r = HTTP::Request->new( $method, $uri, $header )
       $r = HTTP::Request->new( $method, $uri, $header, $content )
	   Constructs a new "HTTP::Request" object describing a request on the object $uri using method $method.  The $method argument must be a
	   string.  The $uri argument can be either a string, or a reference to a "URI" object.  The optional $header argument should be a
	   reference to an "HTTP::Headers" object or a plain array reference of key/value pairs.  The optional $content argument should be a
	   string of bytes.

       $r = HTTP::Request->parse( $str )
	   This constructs a new request object by parsing the given string.

       $r->method
       $r->method( $val )
	   This is used to get/set the method attribute.  The method should be a short string like "GET", "HEAD", "PUT" or "POST".

       $r->uri
       $r->uri( $val )
	   This is used to get/set the uri attribute.  The $val can be a reference to a URI object or a plain string.  If a string is given, then
	   it should be parseable as an absolute URI.

       $r->header( $field )
       $r->header( $field => $value )
	   This is used to get/set header values and it is inherited from "HTTP::Headers" via "HTTP::Message".	See HTTP::Headers for details and
	   other similar methods that can be used to access the headers.

       $r->accept_decodable
	   This will set the "Accept-Encoding" header to the list of encodings that decoded_content() can decode.

       $r->content
       $r->content( $bytes )
	   This is used to get/set the content and it is inherited from the "HTTP::Message" base class.  See HTTP::Message for details and other
	   methods that can be used to access the content.

	   Note that the content should be a string of bytes.  Strings in perl can contain characters outside the range of a byte.  The "Encode"
	   module can be used to turn such strings into a string of bytes.

       $r->as_string
       $r->as_string( $eol )
	   Method returning a textual representation of the request.

SEE ALSO

       HTTP::Headers, HTTP::Message, HTTP::Request::Common, HTTP::Response

COPYRIGHT

       Copyright 1995-2004 Gisle Aas.

       This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

perl v5.18.2							    2012-02-15							  HTTP::Request(3)