.\" 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::FilterStack 3pm"
.TH HTTP::Proxy::FilterStack 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::FilterStack \- A class to manage filter stacks
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This class is used internally by HTTP::Proxy to manage its
four filter stacks.
.PP
From the point of view of HTTP::Proxy::FilterStack, a filter is
actually a (\f(CW\*(C`matchsub\*(C'\fR, \f(CW\*(C`filterobj\*(C'\fR) pair. The match subroutine
(generated by HTTP::Proxy's \f(CW\*(C`push_filter()\*(C'\fR method) is run
against the current HTTP::Message object to find out which filters
must be kept in the stack when handling this message.
.PP
The filter stack maintains a set of buffers where the filters can
store data. This data is appended at the beginning of the next
chunk of data, until all the data has been sent.
.SH "METHODS"
.IX Header "METHODS"
The class provides the following methods:
.ie n .IP "new( $isbody )" 4
.el .IP "new( \f(CW$isbody\fR )" 4
.IX Item "new( $isbody )"
Create a new instance of HTTP::Proxy::FilterStack. If \f(CW$isbody\fR
is true, then the stack will manage body filters (subclasses of
HTTP::Proxy::BodyFilter).
.ie n .IP "select_filters( $message )" 4
.el .IP "select_filters( \f(CW$message\fR )" 4
.IX Item "select_filters( $message )"
\&\f(CW$message\fR is the current HTTP::Message handled by the proxy.
It is used (with the help of each filter's match subroutine)
to select the subset of filters that will be applied on the
given message.
.ie n .IP "filter( @args )" 4
.el .IP "filter( \f(CW@args\fR )" 4
.IX Item "filter( @args )"
This method calls all the currently selected filters in turn,
with the appropriate arguments.
.IP "\fBfilter_last()\fR" 4
.IX Item "filter_last()"
This method calls all the currently selected filters in turn,
to filter the data remaining in the buffers in a single pass.
.IP "\fBwill_modify()\fR" 4
.IX Item "will_modify()"
Return a boolean value indicating if the list of selected filters in
the stack will modify the body content. The value is computed from the
result of calling \f(CW\*(C`will_modify()\*(C'\fR on all selected filters.
.IP "\fBall()\fR" 4
.IX Item "all()"
Return a list of all filters in the stack.
.IP "\fBeod()\fR" 4
.IX Item "eod()"
Used for \s-1END OF DATA\s0 bookkeeping.
.IP "\fBpush()\fR" 4
.IX Item "push()"
Push the given \f(CW\*(C`[ match, filterobj ]\*(C'\fR pairs at the top of the stack.
.ie n .IP "insert( $idx, @pairs )" 4
.el .IP "insert( \f(CW$idx\fR, \f(CW@pairs\fR )" 4
.IX Item "insert( $idx, @pairs )"
Insert the given \f(CW\*(C`[ match, filterobj ]\*(C'\fR pairs at position \f(CW$idx\fR
in the stack.
.ie n .IP "remove( $idx )" 4
.el .IP "remove( \f(CW$idx\fR )" 4
.IX Item "remove( $idx )"
Remove the \f(CW\*(C`[ match, filterobj ]\*(C'\fR pair at position \f(CW$idx\fR in the stack.
.SH "AUTHOR"
.IX Header "AUTHOR"
Philippe \*(L"BooK\*(R" Bruhat, <book@cpan.org>.
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright 2002\-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.