-
-
16 Jun 2015 00:49:14 UTC
- Distribution: HTTP-Proxy
- Module version: 0.304
- Source (raw)
- Browse (raw)
- Changes
- How to Contribute
- Repository
- Issues (23)
- Testers (684 / 1532 / 0)
- Kwalitee
Bus factor: 1- 81.22% Coverage
- License: perl_5
- Activity
24 month- Tools
- Download (82.42KB)
- MetaCPAN Explorer
- Permissions
- Subscribe to distribution
- Permalinks
- This version
- Latest version
and 30 contributors- e477
-
Vincenzo Buttazzo
-
Slaven Rezic
-
Tom Hukins
-
Salve J. Nilsen
-
Masahiro Nagano
-
Ashley Pond V
-
Angelos Karageorgiou
-
Gregor Herrmann
- Maurice Aubrey
-
Marek Rouchal
- Jimbo
- Roland Stigge
-
Gunnar Wolf
-
Matsuno Tokuhiro
-
Ken Williams
-
Max Maischein
- Mark Tilford
-
Chris Dolan
-
Randal L. Schwartz
-
Simon Cozens
- Christian Laursen
-
Emmanuel Di Prétoro
-
Mathieu Arnold
-
Paul Makepeace
- Martin Zdila
-
Jim Cromie
-
Stéphane Payrard
-
David Landgren
-
Éric Cholet
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
filter()
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
filter()
method. See HTTP::Proxy::BodyFilter for more details about thefilter()
method. - name/coderef pairs
-
The name is the name of the method (
filter
,begin
,end
) 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:
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
begin
,end
andfilter
, callsUNIVERSAL::can()
instead.
There is also a method that returns a boolean value:
- will_modify()
-
The
will_modify()
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 absolutely certain that the filter will not modify data (or at least not modify its final length).Here's a simple example:
$filter = HTTP::Proxy::BodyFilter::simple->new( filter => sub { ${ $_[1] } =~ s/foo/bar/g; }, will_modify => 0, # "foo" is the same length as "bar" );
SEE ALSO
HTTP::Proxy, HTTP::Proxy::BodyFilter.
AUTHOR
Philippe "BooK" Bruhat, <book@cpan.org>.
COPYRIGHT
Copyright 2003-2015, Philippe Bruhat.
LICENSE
This module is free software; you can redistribute it or modify it under the same terms as Perl itself.
Module Install Instructions
To install HTTP::Proxy, copy and paste the appropriate command in to your terminal.
cpanm HTTP::Proxy
perl -MCPAN -e shell install HTTP::Proxy
For more information on module installation, please visit the detailed CPAN module installation guide.