http::body(3pm) [debian man page]
HTTP::Body(3pm) User Contributed Perl Documentation HTTP::Body(3pm) NAME
HTTP::Body - HTTP Body Parser SYNOPSIS
use HTTP::Body; sub handler : method { my ( $class, $r ) = @_; my $content_type = $r->headers_in->get('Content-Type'); my $content_length = $r->headers_in->get('Content-Length'); my $body = HTTP::Body->new( $content_type, $content_length ); my $length = $content_length; while ( $length ) { $r->read( my $buffer, ( $length < 8192 ) ? $length : 8192 ); $length -= length($buffer); $body->add($buffer); } my $uploads = $body->upload; # hashref my $params = $body->param; # hashref my $param_order = $body->param_order # arrayref my $body = $body->body; # IO::Handle } DESCRIPTION
HTTP::Body parses chunks of HTTP POST data and supports application/octet-stream, application/x-www-form-urlencoded, and multipart/form-data. Chunked bodies are supported by not passing a length value to new(). It is currently used by Catalyst to parse POST bodies. NOTES
When parsing multipart bodies, temporary files are created to store any uploaded files. You must delete these temporary files yourself after processing them, or set $body->cleanup(1) to automatically delete them at DESTROY-time. METHODS
new Constructor. Takes content type and content length as parameters, returns a HTTP::Body object. add Add string to internal buffer. Will call spin unless done. returns length before adding self. body accessor for the body. chunked Returns 1 if the request is chunked. cleanup Set to 1 to enable automatic deletion of temporary files at DESTROY-time. content_length Returns the content-length for the body data if known. Returns -1 if the request is chunked. content_type Returns the content-type of the body data. init return self. length Returns the total length of data we expect to read if known. In the case of a chunked request, returns the amount of data read so far. trailing_headers If a chunked request body had trailing headers, trailing_headers will return an HTTP::Headers object populated with those headers. spin Abstract method to spin the io handle. state Returns the current state of the parser. param Get/set body parameters. upload Get/set file uploads. tmpdir Specify a different path for temporary files. Defaults to the system temporary path. param_order Returns the array ref of the param keys in the order how they appeared on the body SUPPORT
Since its original creation this module has been taken over by the Catalyst development team. If you want to contribute patches, these will be your primary contact points: IRC: Join #catalyst-dev on irc.perl.org. Mailing Lists: http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev AUTHOR
Christian Hansen, "chansen@cpan.org" Sebastian Riedel, "sri@cpan.org" Andy Grundman, "andy@hybridized.org" CONTRIBUTORS
Simon Elliott "cpan@papercreatures.com" Kent Fredric <kentnl@cpan.org> Christian Walde Torsten Raudssus <torsten@raudssus.de> LICENSE
This library is free software. You can redistribute it and/or modify it under the same terms as perl itself. perl v5.14.2 2010-10-26 HTTP::Body(3pm)
Check Out this Related Man Page
Plack::Response(3pm) User Contributed Perl Documentation Plack::Response(3pm) NAME
Plack::Response - Portable HTTP Response object for PSGI response SYNOPSIS
use Plack::Response; sub psgi_handler { my $env = shift; my $res = Plack::Response->new(200); $res->content_type('text/html'); $res->body("Hello World"); return $res->finalize; } DESCRIPTION
Plack::Response allows you a way to create PSGI response array ref through a simple API. METHODS
new $res = Plack::Response->new; $res = Plack::Response->new($status); $res = Plack::Response->new($status, $headers); $res = Plack::Response->new($status, $headers, $body); Creates a new Plack::Response object. status $res->status(200); $status = $res->status; Sets and gets HTTP status code. "code" is an alias. headers $headers = $res->headers; $res->headers([ 'Content-Type' => 'text/html' ]); $res->headers({ 'Content-Type' => 'text/html' }); $res->headers( HTTP::Headers->new ); Sets and gets HTTP headers of the response. Setter can take either an array ref, a hash ref or HTTP::Headers object containing a list of headers. body $res->body($body_str); $res->body([ "Hello", "World" ]); $res->body($io); Gets and sets HTTP response body. Setter can take either a string, an array ref, or an IO::Handle-like object. "content" is an alias. Note that this method doesn't automatically set Content-Length for the response. You have to set it manually if you want, with the "content_length" method (see below). header $res->header('X-Foo' => 'bar'); my $val = $res->header('X-Foo'); Shortcut for "$res->headers->header". content_type, content_length, content_encoding $res->content_type('text/plain'); $res->content_length(123); $res->content_encoding('gzip'); Shortcut for the equivalent get/set methods in "$res->headers". redirect $res->redirect($url); $res->redirect($url, 301); Sets redirect URL with an optional status code, which defaults to 302. Note that this method doesn't normalize the given URI string. Users of this module have to be responsible about properly encoding URI paths and parameters. location Gets and sets "Location" header. Note that this method doesn't normalize the given URI string in the setter. See above in "redirect" for details. cookies $res->cookies->{foo} = 123; $res->cookies->{foo} = { value => '123' }; Returns a hash reference containing cookies to be set in the response. The keys of the hash are the cookies' names, and their corresponding values are a plain string (for "value" with everything else defaults) or a hash reference that can contain keys such as "value", "domain", "expires", "path", "httponly", "secure". "expires" can take a string or an integer (as an epoch time) and does not convert string formats such as "+3M". $res->cookies->{foo} = { value => 'test', path => "/", domain => '.example.com', expires => time + 24 * 60 * 60, }; finalize $res->finalize; Returns the status code, headers, and body of this response as a PSGI response array reference. AUTHOR
Tokuhiro Matsuno Tatsuhiko Miyagawa SEE ALSO
Plack::Request perl v5.14.2 2012-06-21 Plack::Response(3pm)