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)

Check Out this Related Man Page

HTTP::Proxy::FilterStack(3pm)				User Contributed Perl Documentation			     HTTP::Proxy::FilterStack(3pm)

NAME

       HTTP::Proxy::FilterStack - A class to manage filter stacks

DESCRIPTION

       This class is used internally by "HTTP::Proxy" to manage its four filter stacks.

       From the point of view of "HTTP::Proxy::FilterStack", a filter is actually a ("matchsub", "filterobj") pair. The match subroutine
       (generated by "HTTP::Proxy"'s "push_filter()" method) is run against the current "HTTP::Message" object to find out which filters must be
       kept in the stack when handling this message.

       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.

METHODS

       The class provides the following methods:

       new( $isbody )
	   Create a new instance of "HTTP::Proxy::FilterStack". If $isbody is true, then the stack will manage body filters (subclasses of
	   "HTTP::Proxy::BodyFilter").

       select_filters( $message )
	   $message is the current "HTTP::Message" handled by the proxy.  It is used (with the help of each filter's match subroutine)

       filter( @args )
	   This method calls all the currently selected filters in turn, with the appropriate arguments.

       filter_last()
	   This method calls all the currently selected filters in turn, to filter the data remaining in the buffers in a single pass.

       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 "will_modify()" on all selected filters.

       all()
	   Return a list of all filters in the stack.

       eod()
	   Used for END OF DATA bookkeeping.

       push()
	   Push the given "[ match, filterobj ]" pairs at the top of the stack.

       insert( $idx, @pairs )
	   Insert the given "[ match, filterobj ]" pairs at position $idx in the stack.

       remove( $idx )
	   Remove the "[ match, filterobj ]" pair at position $idx in the stack.

AUTHOR

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

COPYRIGHT

       Copyright 2002-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::FilterStack(3pm)

Linux and UNIX Man Pages

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

Check Out this Related Man Page