NAME

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

Synopsis

  use Apache::Module ();

META: to be completed

Description

META: to be completed

See Apache Server Configuration Customization in Perl.

API

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

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

obj: $name (string)

the name of the module

ret: $ret (Apache::Module)

the module structure if found, NULL otherwise

find_module_name

META: Autogenerated - needs to be reviewed/completed

Find the name of the specified module

  $ret = $module->find_module_name();

obj: $module (Apache::Module)

The module to get the name for

ret: $ret (string)

the name of the module

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();

obj: $module (Apache::Module)

ret: no return value

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();

obj: $module (Apache::Module)

the module structure of the module to remove

ret: no return value

top_module

META: Autogenerated - needs to be reviewed/completed

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

obj: Apache::Module (class name)

ret: $ret (Apache::Module)

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();

obj: $module (Apache::Module)

ret: $version (integer)

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();

obj: $module (Apache::Module)

ret: $minor_version (integer)

module_index

META: Autogenerated - needs to be reviewed/completed

Index to this modules structures in config vectors.

  $index = $module->module_index();

obj: $module (Apache::Module)

ret: $index (integer)

name

META: Autogenerated - needs to be reviewed/completed

The name of the module's C file

  $name = $module->name();

obj: $module (Apache::Module)

ret: $name (string)

dynamic_load_handle

META: Autogenerated - needs to be reviewed/completed

The handle for the DSO. Internal use only

  $dl_handle = $module->dynamic_load_handle();

obj: $module (Apache::Module)

ret: $dl_handle (SCALAR)

next

META: Autogenerated - needs to be reviewed/completed

A pointer to the next module in the list

  $next_module = $module->next();

obj: $module (Apache::Module)

ret: $next_module (Apache::Module)

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();

obj: $module (Apache::Module)

ret: $cmd_rec (Apache::Command)

See Also

mod_perl 2.0 documentation.

Copyright

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

Authors

The mod_perl development team and numerous contributors.

cpanm mod_perl

perl -MCPAN -e shell
install mod_perl