.\" 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 "HTTP::Proxy::BodyFilter::complete 3pm"
.TH HTTP::Proxy::BodyFilter::complete 3pm "2022-12-04" "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
.SH "NAME"
HTTP::Proxy::BodyFilter::complete \- A filter that passes on a complete body or nothing
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\&    use HTTP::Proxy;
\&    use HTTP::Proxy::BodyFilter::simple;
\&    use HTTP::Proxy::BodyFilter::complete;
\&
\&    my $proxy = HTTP::Proxy\->new;
\&
\&    # pass the complete response body to our filter (in one pass)
\&    $proxy\->push_filter(
\&        mime => \*(Aqtext/html\*(Aq,
\&        response => HTTP::Proxy::BodyFilter::complete\->new,
\&        response => HTTP::Proxy::BodyFilter::simple\->new(
\&            sub {
\&                my ( $self, $dataref, $message, $protocol, $buffer ) = @_;
\&                # some complex processing that needs
\&                # the whole response body
\&            }
\&        );
\&    );
\&
\&    $proxy\->start;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The HTTP::Proxy::BodyFilter::complete filter will ensure that the next
filter in the filter chain will only receive complete message bodies
(either request or response).
.PP
It will store the chunks of data as they arrive, only to pass the \fBentire\fR
message body after the whole message has been received by the proxy.
.PP
Subsequent filters is the chain will receive the whole body as a big
piece of data.
.SH "CAVEAT EMPTOR"
.IX Header "CAVEAT EMPTOR"
This consumes memory and time.
.PP
Use with caution, otherwise your client will timeout, or your proxy will
run out of memory.
.PP
Also note that all filters after \f(CW\*(C`complete\*(C'\fR are still called when the
proxy receives data: they just receive empty data. They will receive
the complete data when the filter chain is called for the very last time
(the \f(CW$buffer\fR parameter is \f(CW\*(C`undef\*(C'\fR). (See the documentation of
HTTP::Proxy::BodyFilter for details about the \f(CW$buffer\fR parameter.)
.SH "METHOD"
.IX Header "METHOD"
This filter defines two methods, called automatically:
.IP "\fBfilter()\fR" 4
.IX Item "filter()"
Stores the incoming data in memory until the last moment and passes
empty data to the subsequent filters in the chain. They will receive
the full body during the last round of filter calls.
.IP "\fBwill_modify()\fR" 4
.IX Item "will_modify()"
This method returns a \fIfalse\fR value, thus indicating to the system
that it will not modify data passing through.
.SH "AUTHOR"
.IX Header "AUTHOR"
Philippe \*(L"BooK\*(R" Bruhat, <book@cpan.org>.
.SH "THANKS"
.IX Header "THANKS"
Thanks to Simon Cozens and Merijn H. Brandt, who needed this almost at
the same time. \f(CW\*(C`;\-)\*(C'\fR
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright 2004\-2015, Philippe Bruhat.
.SH "LICENSE"
.IX Header "LICENSE"
This module is free software; you can redistribute it or modify it under
the same terms as Perl itself.