http::proxy::bodyfilter::complete(3pm) [debian man page]

HTTP::Proxy::BodyFilter::complete(3pm)			User Contributed Perl Documentation		    HTTP::Proxy::BodyFilter::complete(3pm)

NAME

       HTTP::Proxy::BodyFilter::complete - A filter that passes on a complete body or nothing

SYNOPSIS

	   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 => 'text/html',
	       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;

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

       It will store the chunks of data as they arrive, only to pass the entire message body after the whole message has been received by the
       proxy.

       Subsequent filters is the chain will receive the whole body as a big piece of data.

CAVEAT EMPTOR

       This consumes memory and time.

       Use with caution, otherwise your client will timeout, or your proxy will run out of memory.

       Also note that all filters after "complete" 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 $buffer parameter is "undef"). (See the documentation of
       HTTP::Proxy::BodyFilter for details about the $buffer parameter.)

METHOD

       This filter defines two methods, called automatically:

       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.

       will_modify()
	   This method returns a false value, thus indicating to the system that it will not modify data passing through.

AUTHOR

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

THANKS

       Thanks to Simon Cozens and Merijn H. Brandt, who needed this almost at the same time. ";-)"

COPYRIGHT

       Copyright 2004-2008, Philippe Bruhat.

LICENSE

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

perl v5.12.4							    2011-07-03				    HTTP::Proxy::BodyFilter::complete(3pm)

HTTP::Proxy::BodyFilter::simple(3pm)			User Contributed Perl Documentation		      HTTP::Proxy::BodyFilter::simple(3pm)

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.pm for more details about the "filter()" 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:

       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 "begin", "end" and
	   "filter", calls UNIVERSAL::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-2006, Philippe Bruhat.

LICENSE

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

perl v5.12.4							    2011-07-03				      HTTP::Proxy::BodyFilter::simple(3pm)