Edit File: HTTP::Request.3pm
.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.13) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .el \{\ . de IX .. .\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "HTTP::Request 3" .TH HTTP::Request 3 "2012-02-15" "perl v5.10.1" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" HTTP::Request \- HTTP style request message .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 2 \& require HTTP::Request; \& $request = HTTP::Request\->new(GET => \*(Aqhttp://www.example.com/\*(Aq); .Ve .PP and usually used like this: .PP .Vb 2 \& $ua = LWP::UserAgent\->new; \& $response = $ua\->request($request); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\f(CW\*(C`HTTP::Request\*(C'\fR is a class encapsulating \s-1HTTP\s0 style requests, consisting of a request line, some headers, and a content body. Note that the \s-1LWP\s0 library uses \s-1HTTP\s0 style requests even for non-HTTP protocols. Instances of this class are usually passed to the \&\fIrequest()\fR method of an \f(CW\*(C`LWP::UserAgent\*(C'\fR object. .PP \&\f(CW\*(C`HTTP::Request\*(C'\fR is a subclass of \f(CW\*(C`HTTP::Message\*(C'\fR and therefore inherits its methods. The following additional methods are available: .ie n .IP "$r = HTTP::Request\->new( $method, $uri )" 4 .el .IP "\f(CW$r\fR = HTTP::Request\->new( \f(CW$method\fR, \f(CW$uri\fR )" 4 .IX Item "$r = HTTP::Request->new( $method, $uri )" .PD 0 .ie n .IP "$r = HTTP::Request\->new( $method, $uri, $header )" 4 .el .IP "\f(CW$r\fR = HTTP::Request\->new( \f(CW$method\fR, \f(CW$uri\fR, \f(CW$header\fR )" 4 .IX Item "$r = HTTP::Request->new( $method, $uri, $header )" .ie n .IP "$r = HTTP::Request\->new( $method, $uri, $header, $content )" 4 .el .IP "\f(CW$r\fR = HTTP::Request\->new( \f(CW$method\fR, \f(CW$uri\fR, \f(CW$header\fR, \f(CW$content\fR )" 4 .IX Item "$r = HTTP::Request->new( $method, $uri, $header, $content )" .PD Constructs a new \f(CW\*(C`HTTP::Request\*(C'\fR object describing a request on the object \f(CW$uri\fR using method \f(CW$method\fR. The \f(CW$method\fR argument must be a string. The \f(CW$uri\fR argument can be either a string, or a reference to a \&\f(CW\*(C`URI\*(C'\fR object. The optional \f(CW$header\fR argument should be a reference to an \f(CW\*(C`HTTP::Headers\*(C'\fR object or a plain array reference of key/value pairs. The optional \f(CW$content\fR argument should be a string of bytes. .ie n .IP "$r = HTTP::Request\->parse( $str )" 4 .el .IP "\f(CW$r\fR = HTTP::Request\->parse( \f(CW$str\fR )" 4 .IX Item "$r = HTTP::Request->parse( $str )" This constructs a new request object by parsing the given string. .ie n .IP "$r\->method" 4 .el .IP "\f(CW$r\fR\->method" 4 .IX Item "$r->method" .PD 0 .ie n .IP "$r\->method( $val )" 4 .el .IP "\f(CW$r\fR\->method( \f(CW$val\fR )" 4 .IX Item "$r->method( $val )" .PD This is used to get/set the method attribute. The method should be a short string like \*(L"\s-1GET\s0\*(R", \*(L"\s-1HEAD\s0\*(R", \*(L"\s-1PUT\s0\*(R" or \*(L"\s-1POST\s0\*(R". .ie n .IP "$r\->uri" 4 .el .IP "\f(CW$r\fR\->uri" 4 .IX Item "$r->uri" .PD 0 .ie n .IP "$r\->uri( $val )" 4 .el .IP "\f(CW$r\fR\->uri( \f(CW$val\fR )" 4 .IX Item "$r->uri( $val )" .PD This is used to get/set the uri attribute. The \f(CW$val\fR can be a reference to a \s-1URI\s0 object or a plain string. If a string is given, then it should be parseable as an absolute \s-1URI\s0. .ie n .IP "$r\->header( $field )" 4 .el .IP "\f(CW$r\fR\->header( \f(CW$field\fR )" 4 .IX Item "$r->header( $field )" .PD 0 .ie n .IP "$r\->header( $field => $value )" 4 .el .IP "\f(CW$r\fR\->header( \f(CW$field\fR => \f(CW$value\fR )" 4 .IX Item "$r->header( $field => $value )" .PD This is used to get/set header values and it is inherited from \&\f(CW\*(C`HTTP::Headers\*(C'\fR via \f(CW\*(C`HTTP::Message\*(C'\fR. See HTTP::Headers for details and other similar methods that can be used to access the headers. .ie n .IP "$r\->accept_decodable" 4 .el .IP "\f(CW$r\fR\->accept_decodable" 4 .IX Item "$r->accept_decodable" This will set the \f(CW\*(C`Accept\-Encoding\*(C'\fR header to the list of encodings that \fIdecoded_content()\fR can decode. .ie n .IP "$r\->content" 4 .el .IP "\f(CW$r\fR\->content" 4 .IX Item "$r->content" .PD 0 .ie n .IP "$r\->content( $bytes )" 4 .el .IP "\f(CW$r\fR\->content( \f(CW$bytes\fR )" 4 .IX Item "$r->content( $bytes )" .PD This is used to get/set the content and it is inherited from the \&\f(CW\*(C`HTTP::Message\*(C'\fR base class. See HTTP::Message for details and other methods that can be used to access the content. .Sp Note that the content should be a string of bytes. Strings in perl can contain characters outside the range of a byte. The \f(CW\*(C`Encode\*(C'\fR module can be used to turn such strings into a string of bytes. .ie n .IP "$r\->as_string" 4 .el .IP "\f(CW$r\fR\->as_string" 4 .IX Item "$r->as_string" .PD 0 .ie n .IP "$r\->as_string( $eol )" 4 .el .IP "\f(CW$r\fR\->as_string( \f(CW$eol\fR )" 4 .IX Item "$r->as_string( $eol )" .PD Method returning a textual representation of the request. .SH "SEE ALSO" .IX Header "SEE ALSO" HTTP::Headers, HTTP::Message, HTTP::Request::Common, HTTP::Response .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright 1995\-2004 Gisle Aas. .PP This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
Back to File Manager