man HTTP::Proxy::BodyFilter::simple () - A class for creating simple filters

NAME

HTTP::Proxy::BodyFilter::simple - A class for creating simple filters

SYNOPSIS

    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 );

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 CWfilter() method of your filter to the constructor, and you'll get the adequate filter.

Constructor calling convention

The constructor can be called in several ways, which are shown in the synopsis:

single code reference
The code reference must conform to the standard filter() signature: 
    sub filter {
        my ( $self, $dataref, $message, $protocol, $buffer ) = @_;
        ...
    }
It is assumed to be the code for the CWfilter() method. See HTTP::Proxy::BodyFilter.pm for more details about the CWfilter() method.
name/coderef pairs
The name is the name of the method (CWfilter, CWbegin, CWend) and the coderef is the method itself. See HTTP::Proxy::BodyFilter for the methods signatures.

METHODS

This filter factory defines the standard HTTP::Proxy::BodyFilter methods, but those are only, erm, proxies to the actual CODE references passed to the constructor. These proxy methods are:

filter()
begin()
end()

Two other methods are actually HTTP::Proxy::BodyFilter::simple methods, and are called automatically:

init()
Initalise the filter instance with the code references passed to the constructor.
can()
Return the actual code reference that will be run, and not the proxy methods. If called with any other name than CWbegin, CWend and CWfilter, calls UNIVERSAL::can() instead.

SEE ALSO

HTTP::Proxy, HTTP::Proxy::BodyFilter.

AUTHOR

Philippe BooK Bruhat, <book@cpan.org>.

COPYRIGHT

Copyright 2003-2005, Philippe Bruhat.

LICENSE

This module is free software; you can redistribute it or modify it under the same terms as Perl itself.