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
Mail::Message::Body::Delayed(3pm) User Contributed Perl Documentation Mail::Message::Body::Delayed(3pm) NAME
Mail::Message::Body::Delayed - body of a Mail::Message but not read yet. INHERITANCE
Mail::Message::Body::Delayed realizes a Mail::Message::Body Mail::Message::Body::Delayed is a Mail::Reporter SYNOPSIS
See Mail::Message::Body DESCRIPTION
Message bodies of this type will be replaced by another type the moment you access the content. In this documentation you will find the description of how a message body gets delay loaded. OVERLOADED
overload: ""() (stringification) Returns the body as string --which will trigger completion-- unless called to produce a string for "Carp". The latter to avoid deep recursions. example: stringification of delayed body print $msg->body; # implicit by print my $body = $msg->body; my $x = "$body"; # explicit by interpolation overload: @{}() When a body object is used as being an array reference, the lines of the body are returned. This is the same as using the "lines" method. overload: bool() Always returns a true value, which is needed to have overloaded objects to be used as in "if($body)". Otherwise, "if(defined $body)" would be needed to avoid a runtime error. METHODS
Constructors Mail::Message::Body::Delayed->new(OPTIONS) -Option --Defined in --Default log Mail::Reporter 'WARNINGS' message <required> trace Mail::Reporter 'WARNINGS' log => LEVEL message => MESSAGE The MESSAGE object which contains this delayed body. trace => LEVEL The body $obj->message() About to the payload $obj->guessSize() $obj->isDelayed() $obj->isModified() $obj->isMultipart() $obj->modified() $obj->nrLines() Internals $obj->fileLocation([BEGIN, END]) $obj->load() Returns the loaded version of this body. $obj->moveLocation(DISTANCE) $obj->read(PARSER, HEAD, BODYTYPE) Error handling $obj->AUTOLOAD() See "Error handling" in Mail::Reporter $obj->addReport(OBJECT) See "Error handling" in Mail::Reporter $obj->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK]) Mail::Message::Body::Delayed->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK]) See "Error handling" in Mail::Reporter $obj->errors() See "Error handling" in Mail::Reporter $obj->log([LEVEL [,STRINGS]]) Mail::Message::Body::Delayed->log([LEVEL [,STRINGS]]) See "Error handling" in Mail::Reporter $obj->logPriority(LEVEL) Mail::Message::Body::Delayed->logPriority(LEVEL) See "Error handling" in Mail::Reporter $obj->logSettings() See "Error handling" in Mail::Reporter $obj->notImplemented() See "Error handling" in Mail::Reporter $obj->report([LEVEL]) See "Error handling" in Mail::Reporter $obj->reportAll([LEVEL]) See "Error handling" in Mail::Reporter $obj->trace([LEVEL]) See "Error handling" in Mail::Reporter $obj->warnings() See "Error handling" in Mail::Reporter Cleanup $obj->DESTROY() See "Cleanup" in Mail::Reporter $obj->inGlobalDestruction() See "Cleanup" in Mail::Reporter DIAGNOSTICS
Error: Package $package does not implement $method. Fatal error: the specific package (or one of its superclasses) does not implement this method where it should. This message means that some other related classes do implement this method however the class at hand does not. Probably you should investigate this and probably inform the author of the package. SEE ALSO
This module is part of Mail-Box distribution version 2.105, built on May 07, 2012. Website: http://perl.overmeer.net/mailbox/ LICENSE
Copyrights 2001-2012 by [Mark Overmeer]. For other contributors see ChangeLog. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See http://www.perl.com/perl/misc/Artistic.html perl v5.14.2 2012-05-07 Mail::Message::Body::Delayed(3pm)