mod_perl logo
perl icon







previous page: OS-specific Infopage up: mod_perl 2.0 Documentationnext page: Developer's guide


mod_perl APIs











Practical mod_perl

Practical mod_perl

By Stas Bekman, Eric Cholet
The mod_perl Developer's Cookbook

The mod_perl Developer's Cookbook

By Geoffrey Young, Paul Lindner, Randy Kobes
mod_perl Pocket Reference

mod_perl Pocket Reference

By Andrew Ford


The Apache::, APR:: and ModPerl:: namespaces APIs for mod_perl 2.0

Part I: Apache:: Core API
-Apache -- A ghost mod_perl 2.0 class
There is no Apache class per se.
-Apache::Access - A Perl API for Apache request object
Apache::Access provides the Perl API for Apache request object.
-Apache::CmdParms - Perl API for XXX
META: to be completed
-Apache::Command - Perl API for XXX
META: to be completed
-Apache::compat -- 1.0 backward compatibility functions deprecated in 2.0
Apache::compat provides mod_perl 1.0 compatibility layer and can be used to smooth the transition process to mod_perl 2.0.
-Apache::Connection - Perl API for Apache connection object
META: to be completed
-Apache::Const - Perl Interface for Apache Constants
-Apache::Directive - Perl API for manipulating Apache configuration tree
Apache::Directive allows its users to search and navigate the internal Apache configuration.
-Apache::Filter - Perl API for Apache 2.0 Filtering
Apache::Filter provides the Perl API for Apache 2.0 filtering framework.
-Apache::FilterRec - Perl API for manipulating the Apache filter record
META: to be completed
-Apache::HookRun - Perl API for XXX
META: to be completed
-Apache::Log - Perl API for Apache Logging Methods
Apache::Log provides the Perl API for Apache logging methods.
-Apache::Module - Perl API for creating and working with Apache modules
META: to be completed
-Apache::PerlSections - Default Handler for Perl sections
With <Perl >...</Perl> sections, it is possible to configure your server entirely in Perl.
-Apache::Process - Perl API for XXX
META: to be completed
-Apache::RequestIO - Perl API for Apache request record IO
Apache::RequestIO provides the API to perform IO on the Apache request object.
-Apache::RequestRec - Perl API for Apache request record accessors
Apache::RequestRec provides the Perl API for Apache request object.
-Apache::RequestUtil - Perl API for Apache request record utils
META: to be completed
-Apache::Response - Perl API for Apache HTTP request response methods
META: to be completed
-Apache::Server - Perl API for for Apache server record accessors
META: to be completed
-Apache::ServerUtil - Perl API for XXX
Apache::ServerUtil provides the Perl API for Apache server object.
-Apache::SubProcess -- Executing SubProcesses from mod_perl
Apache::SubProcess provides the Perl API for running and communicating with processes spawned from mod_perl handlers.
-Apache::SubRequest - Perl API for Apache subrequests
META: to be completed
-Apache::URI - Perl API for manipulating URIs
META: to be completed
-Apache::Util - Perl API for XXX
META: to be completed
Part II: APR:: Core API
-APR - Perl Interface for libapr and libaprutil Libraries
Notes on how to use APR outside mod_perl 2.0.
-APR::Base64 - Perl API for XXX
META: to be completed
-APR::Brigade - Perl API for XXX
META: to be completed
-APR::Bucket - Perl API for XXX
META: to be completed
-APR::Const - Perl Interface for APR Constants
-APR::Date - Perl API for XXX
META: to be completed
-APR::Finfo - Perl API for XXX
META: to be completed
-APR::NetLib - Perl API for XXX
META: to be completed
-APR::PerlIO -- An APR Perl IO layer
APR::PerlIO implements a Perl IO layer using APR's file manipulation as its internals.
-APR::Pool - Perl API for XXX
META: to be completed
-APR::SockAddr - Perl API for XXX
META: to be completed
-APR::Socket - Perl API for XXX
META: to be completed
-APR::Table - Perl API for for manipulating opaque string-content table
APR::Table allows its users to manipulate opaque string-content tables.
-APR::ThreadMutex - Perl API for XXX
META: to be completed
-APR::URI - Perl API for XXX
META: to be completed
-APR::Util - Perl API for XXX
META: to be completed
Part III: ModPerl::
-ModPerl::MethodLookup -- Map mod_perl 2.0 modules, objects and methods
mod_perl 2.0 provides many methods, which reside in various modules. One has to load each of the modules before using the desired methods. ModPerl::MethodLookup provides the Perl API for finding module names which contain methods in question and other helper functions, like figuring out what methods defined by some module, or what methods can be called on a given object.
-ModPerl::MM -- A "subclass" of ExtUtils::MakeMaker for mod_perl 2.0
ModPerl::MM is a "subclass" of ExtUtils::MakeMaker for mod_perl 2.0, to a degree of sub-classability of ExtUtils::MakeMaker.
-ModPerl::PerlRun - Run unaltered CGI scripts under mod_perl
-ModPerl::Registry - Run unaltered CGI scripts persistently under mod_perl
URIs in the form of http://example.com/perl/test.pl will be compiled as the body of a Perl subroutine and executed. Each child process will compile the subroutine once and store it in memory. It will recompile it whenever the file (e.g. test.pl in our example) is updated on disk. Think of it as an object oriented server with each script implementing a class loaded at runtime.
-ModPerl::RegistryBB - Run unaltered CGI scripts persistently under mod_perl
ModPerl::RegistryBB is similar to ModPerl::Registry, but does the bare minimum (mnemonic: BB = Bare Bones) to compile a script file once and run it many times, in order to get the maximum performance. Whereas ModPerl::Registry does various checks, which add a slight overhead to response times.
-ModPerl::RegistryCooker - Cook mod_perl 2.0 Registry Modules
ModPerl::RegistryCooker is used to create flexible and overridable registry modules which emulate mod_cgi for Perl scripts. The concepts are discussed in the manpage of the following modules: ModPerl::Registry, ModPerl::Registry and ModPerl::RegistryBB.
-ModPerl::RegistryLoader - Compile ModPerl::RegistryCooker scripts at server startup
This modules allows compilation of scripts, running under packages derived from ModPerl::RegistryCooker, at server startup. The script's handler routine is compiled by the parent server, of which children get a copy and thus saves some memory by initially sharing the compiled copy with the parent and saving the overhead of script's compilation on the first request in every httpd instance.
-ModPerl::Util - Helper mod_perl 2.0 Functions
ModPerl::Util provides mod_perl 2.0 util functions.
Part IV: Helper Modules / Applications
-Apache::porting -- a helper module for mod_perl 1.0 to mod_perl 2.0 porting
Apache::porting helps to port mod_perl 1.0 code to run under mod_perl 2.0. It doesn't provide any back-compatibility functionality, however it knows trap calls to methods that are no longer in the mod_perl 2.0 API and tell what should be used instead if at all. If you attempts to use mod_perl 2.0 methods without first loading the modules that contain them, it will tell you which modules you need to load. Finally if your code tries to load modules that no longer exist in mod_perl 2.0 it'll also tell you what are the modules that should be used instead.
-Apache::Reload - Reload Perl Modules when Changed on Disk
Apache::Reload reloads modules that change on the disk.
-Apache::Status - Embedded interpreter status information
The Apache::Status module provides some information about the status of the Perl interpreter embedded in the server.
Part V: Internal Modules
-ModPerl::BuildMM -- A "subclass" of ModPerl::MM used for building mod_perl 2.0
ModPerl::BuildMM is a "subclass" of ModPerl::MM used for building mod_perl 2.0. Refer to ModPerl::MM manpage.

See search.cpan.org or www.perldoc.com for documentation of the 3rd party Apache:: modules.




TOP
previous page: OS-specific Infopage up: mod_perl 2.0 Documentationnext page: Developer's guide