.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) .\" .\" 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" '' . ds C` . ds C' '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 >0, 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. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "POE::Filter::HTTPChunk 3pm" .TH POE::Filter::HTTPChunk 3pm "2022-11-19" "perl v5.36.0" "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 my \f(CW$TEXT\fR = qr/[^[:cntrl:]]/o; my \f(CW$qdtext\fR = qr/[^[:cntrl:]\e\*(L"]/o; #> my \f(CW$quoted_pair\fR = qr/\e\e[[:ascii:]]/o; my \f(CW$quoted_string\fR = qr/\e\*(L"(?:$qdtext|$quoted_pair)\e\*(R"/o; my \f(CW$separators\fR = \*(L"[^()<>@,;:\e\e\*(R"\e/\e[\e]\e?={} \et"; my \f(CW$notoken\fR = qr/(?:[[:cntrl:]$separators]/o; .PP my \f(CW$chunk_ext_name\fR = \f(CW$token\fR; my \f(CW$chunk_ext_val\fR = qr/(?:$token|$quoted_string)/o; .PP my \f(CW$chunk_extension\fR = qr/(?:;$chunk_ext_name(?:$chunk_ext_val)?)/o; .PP sub put { die \*(L"not implemented yet\*(R"; } .SH "NAME" POE::Filter::HTTPChunk \- Non\-blocking incremental HTTP chunk parser. .SH "VERSION" .IX Header "VERSION" version 0.949 .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 9 \& # Not a complete program. \& use POE::Filter::HTTPChunk; \& use POE::Wheel::ReadWrite; \& sub setup_io { \& $_[HEAP]\->{io_wheel} = POE::Wheel::ReadWrite\->new( \& Filter => POE::Filter::HTTPChunk\->new(), \& # See POE::Wheel::ReadWrite for other required parameters. \& ); \& } .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This filter parses \s-1HTTP\s0 chunks from a data stream. It's used by POE::Component::Client::HTTP to do the bulk of the low-level \s-1HTTP\s0 parsing. .SH "CONSTRUCTOR" .IX Header "CONSTRUCTOR" .SS "new" .IX Subsection "new" \&\f(CW\*(C`new\*(C'\fR takes no parameters and returns a shiny new POE::Filter::HTTPChunk object ready to use. .SH "METHODS" .IX Header "METHODS" POE::Filter::HTTPChunk supports the following methods. Most of them adhere to the standard POE::Filter \s-1API.\s0 The documentation for POE::Filter explains the \s-1API\s0 in more detail. .SS "get_one_start \s-1ARRAYREF\s0" .IX Subsection "get_one_start ARRAYREF" Accept an arrayref containing zero or more raw data chunks. They are added to the filter's input buffer. The filter will attempt to parse that data when \fBget_one()\fR is called. .PP .Vb 1 \& $filter_httpchunk\->get_one_start(\e@stream_data); .Ve .SS "get_one" .IX Subsection "get_one" Parse a single \s-1HTTP\s0 chunk from the filter's input buffer. Data is entered into the buffer by the \fBget_one_start()\fR method. Returns an arrayref containing zero or one parsed \s-1HTTP\s0 chunk. .PP .Vb 1 \& $ret_arrayref = $filter_httpchunk\->get_one(); .Ve .SS "get_pending" .IX Subsection "get_pending" Returns an arrayref of stream data currently pending parsing. It's used to seamlessly transfer unparsed data between an old and a new filter when a wheel's filter is changed. .PP .Vb 1 \& $pending_arrayref = $filter_httpchunk\->get_pending(); .Ve .SH "SEE ALSO" .IX Header "SEE ALSO" POE::Filter, \s-1POE\s0. .SH "BUGS" .IX Header "BUGS" None are known at this time. .SH "AUTHOR & COPYRIGHTS" .IX Header "AUTHOR & COPYRIGHTS" POE::Filter::HTTPChunk is... .IP "\(bu" 2 Copyright 2005\-2006 Martijn van Beers .IP "\(bu" 2 Copyright 2006 Rocco Caputo .PP All rights are reserved. POE::Filter::HTTPChunk is free software; you may redistribute it and/or modify it under the same terms as Perl itself. .SH "CONTACT" .IX Header "CONTACT" Rocco may be contacted by e\-mail via , and Martijn may be contacted by email via . .PP The preferred way to report bugs or requests is through \s-1RT\s0 though. See or mail .PP For questions, try the \s-1POE\s0 mailing list (poe@perl.org)