mod_perl logo
perl icon







previous page: Apache::Log - Perl API for Apache Logging Methodspage up: mod_perl APIsnext page: Apache::PerlSections - Default Handler for Perl sections


Apache::Module - Perl API for creating and working with Apache modules











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
Writing Apache Modules with Perl and C

Writing Apache Modules with Perl and C

By Lincoln Stein, Doug MacEachern


Table of Contents

Synopsis

  use Apache::Module ();

META: to be completed



TOP

Description

META: to be completed

See Apache Server Configuration Customization in Perl.



TOP

API

Apache::Module provides the following functions and/or methods:



TOP

find_linked_module

META: Autogenerated - needs to be reviewed/completed

Find a module based on the name of the module

  $ret = find_linked_module($name);


TOP

find_module_name

META: Autogenerated - needs to be reviewed/completed

Find the name of the specified module

  $ret = $module->find_module_name();


TOP

remove_loaded_module

META: Autogenerated - needs to be reviewed/completed

Remove a module from the chained modules list and the list of loaded modules

  $module->remove_loaded_module();


TOP

remove_module

META: Autogenerated - needs to be reviewed/completed

Remove a module from the server. There are some caveats: when the module is removed, its slot is lost so all the current per-dir and per-server configurations are invalid. So we should only ever call this function when you are invalidating almost all our current data. I.e. when doing a restart.

  $module->remove_module();


TOP

top_module

META: Autogenerated - needs to be reviewed/completed

  $ret = Apache::Module->top_module();


TOP

version

META: Autogenerated - needs to be reviewed/completed

API version, *not* module version; check that module is compatible with this version of the server.

  $version = $module->version();


TOP

minor_version

META: Autogenerated - needs to be reviewed/completed

API minor version. Provides API feature milestones. Not checked during module init

  $minor_version = $module->minor_version();


TOP

module_index

META: Autogenerated - needs to be reviewed/completed

Index to this modules structures in config vectors.

  $index = $module->module_index();


TOP

name

META: Autogenerated - needs to be reviewed/completed

The name of the module's C file

  $name = $module->name();


TOP

dynamic_load_handle

META: Autogenerated - needs to be reviewed/completed

The handle for the DSO. Internal use only

  $dl_handle = $module->dynamic_load_handle();


TOP

next

META: Autogenerated - needs to be reviewed/completed

A pointer to the next module in the list

  $next_module = $module->next();


TOP

cmds

META: Autogenerated - needs to be reviewed/completed

A command_rec table that describes all of the directives this module defines.

  $cmd_rec = $module->cmds();


TOP

See Also

mod_perl 2.0 documentation.



TOP

Copyright

mod_perl 2.0 and its core modules are copyrighted under The Apache Software License, Version 1.1.



TOP

Authors

The mod_perl development team and numerous contributors.







TOP
previous page: Apache::Log - Perl API for Apache Logging Methodspage up: mod_perl APIsnext page: Apache::PerlSections - Default Handler for Perl sections