.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" 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 turned on, 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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "HTTP::Proxy::BodyFilter::simple 3pm"
.TH HTTP::Proxy::BodyFilter::simple 3pm "2017-06-28" "perl v5.20.2" "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::simple \- A class for creating simple filters
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use HTTP::Proxy::BodyFilter::simple;
\&
\&    # a simple s/// filter
\&    my $filter = HTTP::Proxy::BodyFilter::simple\->new(
\&        sub { ${ $_[1] } =~ s/foo/bar/g; }
\&    );
\&    $proxy\->push_filter( response => $filter );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
HTTP::Proxy::BodyFilter::simple can create BodyFilter without going
through the hassle of creating a full-fledged class. Simply pass
a code reference to the \f(CW\*(C`filter()\*(C'\fR method of your filter to the constructor,
and you'll get the adequate filter.
.SS "Constructor calling convention"
.IX Subsection "Constructor calling convention"
The constructor can be called in several ways, which are shown in the
synopsis:
.IP "single code reference" 4
.IX Item "single code reference"
The code reference must conform to the standard \fIfilter()\fR signature:
.Sp
.Vb 4
\&    sub filter {
\&        my ( $self, $dataref, $message, $protocol, $buffer ) = @_;
\&        ...
\&    }
.Ve
.Sp
It is assumed to be the code for the \f(CW\*(C`filter()\*(C'\fR method.
See HTTP::Proxy::BodyFilter for more details about the \f(CW\*(C`filter()\*(C'\fR method.
.IP "name/coderef pairs" 4
.IX Item "name/coderef pairs"
The name is the name of the method (\f(CW\*(C`filter\*(C'\fR, \f(CW\*(C`begin\*(C'\fR, \f(CW\*(C`end\*(C'\fR)
and the coderef is the method itself.
.Sp
See HTTP::Proxy::BodyFilter for the methods signatures.
.SH "METHODS"
.IX Header "METHODS"
This filter \*(L"factory\*(R" defines the standard HTTP::Proxy::BodyFilter
methods, but those are only, erm, \*(L"proxies\*(R" to the actual \s-1CODE\s0 references
passed to the constructor. These \*(L"proxy\*(R" methods are:
.IP "\fIfilter()\fR" 4
.IX Item "filter()"
.PD 0
.IP "\fIbegin()\fR" 4
.IX Item "begin()"
.IP "\fIend()\fR" 4
.IX Item "end()"
.PD
.PP
Two other methods are actually HTTP::Proxy::BodyFilter::simple methods,
and are called automatically:
.IP "\fIinit()\fR" 4
.IX Item "init()"
Initalise the filter instance with the code references passed to the
constructor.
.IP "\fIcan()\fR" 4
.IX Item "can()"
Return the actual code reference that will be run, and not the \*(L"proxy\*(R"
methods. If called with any other name than \f(CW\*(C`begin\*(C'\fR, \f(CW\*(C`end\*(C'\fR and
\&\f(CW\*(C`filter\*(C'\fR, calls \f(CW\*(C`UNIVERSAL::can()\*(C'\fR instead.
.PP
There is also a method that returns a boolean value:
.IP "\fIwill_modify()\fR" 4
.IX Item "will_modify()"
The \f(CW\*(C`will_modify()\*(C'\fR method returns a scalar value (boolean) indicating
if the filter may modify the body data. The default method returns a
true value, so you only need to set this value when you are \fIabsolutely
certain\fR that the filter will not modify data (or at least not modify
its final length).
.Sp
Here's a simple example:
.Sp
.Vb 4
\&    $filter = HTTP::Proxy::BodyFilter::simple\->new(
\&        filter => sub { ${ $_[1] } =~ s/foo/bar/g; },
\&        will_modify => 0,    # "foo" is the same length as "bar"
\&    );
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
HTTP::Proxy, HTTP::Proxy::BodyFilter.
.SH "AUTHOR"
.IX Header "AUTHOR"
Philippe \*(L"BooK\*(R" Bruhat, <book@cpan.org>.
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright 2003\-2013, 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.