Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

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

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

NAME

       HTTP::Proxy::Engine - Generic child process manager engine for HTTP::Proxy

SYNOPSIS

	   use HTTP::Proxy;

	   # use the default engine for your system
	   my $proxy = HTTP::Proxy->new();

	   # choose one
	   my $proxy = HTTP::Proxy->new( engine => 'Old' );

DESCRIPTION

       The HTTP::Proxy::Engine class is a front-end to actual proxy engine classes.

       The role of an engine is to implement the main fork+serve loop with all the required bookkeeping. This is also a good way to test various
       implementation and/or try out new algorithms without too much difficulties.

METHODS

       new()
	   Create a new engine. The parameter "engine" is used to decide which kind of engine will be created. Other parameters are passed to the
	   underlying engine.

	   This method also implement the subclasses constructor (they obviously do not need the "engine" parameter).

CREATING YOUR OWN ENGINE

       It is possible to create one's own engine, by creating a simple subclass of HTTP::Proxy::Engine with the following methods:

       start()
	   This method should handle any initialisation required when the engine starts.

       run()
	   This method is the main loop of the master process.	It defines how child processes are forked, checked and killed.

	   The engine MUST have a run() method, and it will be called again and again until the proxy exits.

	   $self->proxy->daemon returns the listening socket that can accept() connections. The child must call $self->proxy->serve_connections()
	   on the returned socket to handle actual TCP connections.

       stop()
	   This optional method should handle any cleanup procedures when the engine stops (typically when the main proxy process is killed).

       A subclass may also define a %defaults hash (with "our") that contains the default values for the fields used internaly.

METHODS PROVIDED TO SUBCLASSES

       HTTP::Proxy::Engine provides the following methods to its subclasses:

       proxy()
	   Return the HTTP::Proxy object that runs the engine.

       max_clients()
	   Get or set the maximum number of TCP clients, that is to say the maximum number of forked child process.

	   Some engines may understand a value of 0 as do not fork at all.  This is what HTTP::Proxy::Engine::Legacy does.

       make_accessors( @names )
	   Create accessors named after @names in the subclass package.  All accessors are read/write. This is a utility method.

	   This is a class method.

AUTHOR

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

COPYRIGHT

       Copyright 2005, 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::Engine(3pm)

Check Out this Related Man Page

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

NAME

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

SYNOPSIS

	   use HTTP::Proxy::HeaderFilter::simple;

	   # a simple User-Agent filter
	   my $filter = HTTP::Proxy::HeaderFilter::simple->new(
	       sub { $_[1]->header( User_Agent => 'foobar/1.0' ); }
	   );
	   $proxy->push_filter( request => $filter );

DESCRIPTION

       HTTP::Proxy::HeaderFilter::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 is called with a single code reference.	The code reference must conform to the standard filter() signature for header
       filters:

	   sub filter { my ( $self, $headers, $message) = @_; ... }

       This code reference is used for the filter() method.

METHODS

       This filter "factory" defines the standard HTTP::Proxy::HeaderFilter 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::HeaderFilter::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" and
	   "filter", it calls UNIVERSAL::can() instead.

SEE ALSO

       HTTP::Proxy, HTTP::Proxy::HeaderFilter.

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.

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