local-lib5/man/man3/HTTP::Body.3pm

   1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sh \" Subsection heading
   6 .br
   7 .if t .Sp
   8 .ne 5
   9 .PP
  10 \fB\\$1\fR
  11 .PP
  12 ..
  13 .de Sp \" Vertical space (when we can't use .PP)
  14 .if t .sp .5v
  15 .if n .sp
  16 ..
  17 .de Vb \" Begin verbatim text
  18 .ft CW
  19 .nf
  20 .ne \\$1
  21 ..
  22 .de Ve \" End verbatim text
  23 .ft R
  24 .fi
  25 ..
  26 .\" Set up some character translations and predefined strings.  \*(-- will
  27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  28 .\" double quote, and \*(R" will give a right double quote.  | will give a
  29 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
  30 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
  31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
  32 .tr \(*W-|\(bv\*(Tr
  33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  34 .ie n \{\
  35 .    ds -- \(*W-
  36 .    ds PI pi
  37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  39 .    ds L" ""
  40 .    ds R" ""
  41 .    ds C` ""
  42 .    ds C' ""
  43 'br\}
  44 .el\{\
  45 .    ds -- \|\(em\|
  46 .    ds PI \(*p
  47 .    ds L" ``
  48 .    ds R" ''
  49 'br\}
  50 .\"
  51 .\" If the F register is turned on, we'll generate index entries on stderr for
  52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  54 .\" output yourself in some meaningful fashion.
  55 .if \nF \{\
  56 .    de IX
  57 .    tm Index:\\$1\t\\n%\t"\\$2"
  58 ..
  59 .    nr % 0
  60 .    rr F
  61 .\}
  62 .\"
  63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
  64 .\" way too many mistakes in technical documents.
  65 .hy 0
  66 .if n .na
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "HTTP::Body 3"
 132 .TH HTTP::Body 3 "2008-12-01" "perl v5.8.7" "User Contributed Perl Documentation"
 133 .SH "NAME"
 134 HTTP::Body \- HTTP Body Parser
 135 .SH "SYNOPSIS"
 136 .IX Header "SYNOPSIS"
 137 .Vb 1
 138 \&    use HTTP::Body;
 139 .Ve
 140 .PP
 141 .Vb 2
 142 \&    sub handler : method {
 143 \&        my ( $class, $r ) = @_;
 144 .Ve
 145 .PP
 146 .Vb 2
 147 \&        my $content_type   = $r\->headers_in\->get('Content\-Type');
 148 \&        my $content_length = $r\->headers_in\->get('Content\-Length');
 149 .Ve
 150 .PP
 151 .Vb 2
 152 \&        my $body   = HTTP::Body\->new( $content_type, $content_length );
 153 \&        my $length = $content_length;
 154 .Ve
 155 .PP
 156 .Vb 1
 157 \&        while ( $length ) {
 158 .Ve
 159 .PP
 160 .Vb 1
 161 \&            $r\->read( my $buffer, ( $length < 8192 ) ? $length : 8192 );
 162 .Ve
 163 .PP
 164 .Vb 1
 165 \&            $length \-= length($buffer);
 166 .Ve
 167 .PP
 168 .Vb 2
 169 \&            $body\->add($buffer);
 170 \&        }
 171 .Ve
 172 .PP
 173 .Vb 4
 174 \&        my $uploads = $body\->upload; # hashref
 175 \&        my $params  = $body\->param;  # hashref
 176 \&        my $body    = $body\->body;   # IO::Handle
 177 \&    }
 178 .Ve
 179 .SH "DESCRIPTION"
 180 .IX Header "DESCRIPTION"
 181 HTTP::Body parses chunks of \s-1HTTP\s0 \s-1POST\s0 data and supports
 182 application/octet\-stream, application/x\-www\-form\-urlencoded, and
 183 multipart/form\-data.
 184 .PP
 185 Chunked bodies are supported by not passing a length value to \fInew()\fR.
 186 .PP
 187 It is currently used by Catalyst to parse \s-1POST\s0 bodies.
 188 .SH "NOTES"
 189 .IX Header "NOTES"
 190 When parsing multipart bodies, temporary files are created to store any
 191 uploaded files.  You must delete these temporary files yourself after
 192 processing them.
 193 .SH "METHODS"
 194 .IX Header "METHODS"
 195 .IP "new" 4
 196 .IX Item "new"
 197 Constructor. Takes content type and content length as parameters,
 198 returns a HTTP::Body object.
 199 .IP "add" 4
 200 .IX Item "add"
 201 Add string to internal buffer. Will call spin unless done. returns
 202 length before adding self.
 203 .IP "body" 4
 204 .IX Item "body"
 205 accessor for the body.
 206 .IP "chunked" 4
 207 .IX Item "chunked"
 208 Returns 1 if the request is chunked.
 209 .IP "content_length" 4
 210 .IX Item "content_length"
 211 Returns the content-length for the body data if known.
 212 Returns \-1 if the request is chunked.
 213 .IP "content_type" 4
 214 .IX Item "content_type"
 215 Returns the content-type of the body data.
 216 .IP "init" 4
 217 .IX Item "init"
 218 return self.
 219 .IP "length" 4
 220 .IX Item "length"
 221 Returns the total length of data we expect to read if known.
 222 In the case of a chunked request, returns the amount of data
 223 read so far.
 224 .IP "trailing_headers" 4
 225 .IX Item "trailing_headers"
 226 If a chunked request body had trailing headers, trailing_headers will
 227 return an HTTP::Headers object populated with those headers.
 228 .IP "spin" 4
 229 .IX Item "spin"
 230 Abstract method to spin the io handle.
 231 .IP "state" 4
 232 .IX Item "state"
 233 Returns the current state of the parser.
 234 .IP "param" 4
 235 .IX Item "param"
 236 Get/set body parameters.
 237 .IP "upload" 4
 238 .IX Item "upload"
 239 Get/set file uploads.
 240 .IP "tmpdir" 4
 241 .IX Item "tmpdir"
 242 Specify a different path for temporary files.  Defaults to the system temporary path.
 243 .SH "AUTHOR"
 244 .IX Header "AUTHOR"
 245 Christian Hansen, \f(CW\*(C`ch@ngmedia.com\*(C'\fR
 246 .PP
 247 Sebastian Riedel, \f(CW\*(C`sri@cpan.org\*(C'\fR
 248 .PP
 249 Andy Grundman, \f(CW\*(C`andy@hybridized.org\*(C'\fR
 250 .SH "LICENSE"
 251 .IX Header "LICENSE"
 252 This library is free software. You can redistribute it and/or modify
 253 it under the same terms as perl itself.