stas 2004/08/09 20:35:26 Modified: src/docs/2.0/api/Apache Module.pod Log: prep Apache::Module Revision Changes Path 1.4 +131 -77 modperl-docs/src/docs/2.0/api/Apache/Module.pod Index: Module.pod =================================================================== RCS file: /home/cvs/modperl-docs/src/docs/2.0/api/Apache/Module.pod,v retrieving revision 1.3 retrieving revision 1.4 diff -u -u -r1.3 -r1.4 --- Module.pod 22 May 2004 02:03:27 -0000 1.3 +++ Module.pod 10 Aug 2004 03:35:26 -0000 1.4 @@ -29,23 +29,26 @@ -=head2 C<find_linked_module> + + +=head2 C<cmds> META: Autogenerated - needs to be reviewed/completed -Find a module based on the name of the module +A command_rec table that describes all of the directives this module +defines. - $ret = find_linked_module($name); + $cmd_rec = $module->cmds(); =over 4 -=item obj: C<$name> (string) +=item obj: C<$module> +( C<L<Apache::Module object|docs::2.0::api::Apache::Module>> ) -the name of the module - -=item ret: C<$ret> (C<L<Apache::Module|docs::2.0::api::Apache::Module>>) +=item ret: C<$cmd_rec> +( C<L<Apache::Command object|docs::2.0::api::Apache::Command>> ) -the module structure if found, NULL otherwise +=item since: 1.99_12 =back @@ -53,23 +56,24 @@ -=head2 C<find_module_name> + + +=head2 C<dynamic_load_handle> META: Autogenerated - needs to be reviewed/completed -Find the name of the specified module +The handle for the DSO. Internal use only - $ret = $module->find_module_name(); + $dl_handle = $module->dynamic_load_handle(); =over 4 -=item obj: C<$module> (C<L<Apache::Module|docs::2.0::api::Apache::Module>>) +=item obj: C<$module> +( C<L<Apache::Module object|docs::2.0::api::Apache::Module>> ) -The module to get the name for +=item ret: C<$dl_handle> ( SCALAR ) -=item ret: C<$ret> (string) - -the name of the module +=item since: 1.99_12 =back @@ -77,22 +81,35 @@ -=head2 C<remove_loaded_module> + + + +=head2 C<get_config> + + + + + +=head2 C<find_linked_module> META: Autogenerated - needs to be reviewed/completed -Remove a module from the chained modules list and the list of loaded -modules +Find a module based on the name of the module - $module->remove_loaded_module(); + $ret = find_linked_module($name); =over 4 -=item obj: C<$module> (C<L<Apache::Module|docs::2.0::api::Apache::Module>>) +=item obj: C<$name> ( string ) +the name of the module +=item ret: C<$ret> +( C<L<Apache::Module object|docs::2.0::api::Apache::Module>> ) -=item ret: no return value +the module structure if found, NULL otherwise + +=item since: 1.99_12 =back @@ -100,45 +117,53 @@ -=head2 C<remove_module> +=head2 C<find_module_name> 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. +Find the name of the specified module - $module->remove_module(); + $ret = $module->find_module_name(); =over 4 -=item obj: C<$module> (C<L<Apache::Module|docs::2.0::api::Apache::Module>>) +=item obj: C<$module> +( C<L<Apache::Module object|docs::2.0::api::Apache::Module>> ) -the module structure of the module to remove +The module to get the name for -=item ret: no return value +=item ret: C<$ret> ( string ) + +the name of the module + +=item since: 1.99_12 =back +=head2 C<loaded> -=head2 C<top_module> -META: Autogenerated - needs to be reviewed/completed +=head2 C<minor_version> +META: Autogenerated - needs to be reviewed/completed - $ret = Apache::Module->top_module(); +API minor version. Provides API feature milestones. Not checked +during module init + + $minor_version = $module->minor_version(); =over 4 -=item obj: C<Apache::Module> (class name) +=item obj: C<$module> +( C<L<Apache::Module object|docs::2.0::api::Apache::Module>> ) + +=item ret: C<$minor_version> ( integer ) -=item ret: C<$ret> (C<L<Apache::Module|docs::2.0::api::Apache::Module>>) +=item since: 1.99_12 =back @@ -146,20 +171,22 @@ -=head2 C<version> +=head2 C<module_index> META: Autogenerated - needs to be reviewed/completed -API version, *not* module version; check that module is -compatible with this version of the server. +Index to this modules structures in config vectors. - $version = $module->version(); + $index = $module->module_index(); =over 4 -=item obj: C<$module> (C<L<Apache::Module|docs::2.0::api::Apache::Module>>) +=item obj: C<$module> +( C<L<Apache::Module object|docs::2.0::api::Apache::Module>> ) -=item ret: C<$version> (integer) +=item ret: C<$index> ( integer ) + +=item since: 1.99_12 =back @@ -167,20 +194,22 @@ -=head2 C<minor_version> +=head2 C<name> META: Autogenerated - needs to be reviewed/completed -API minor version. Provides API feature milestones. Not checked -during module init +The name of the module's C file - $minor_version = $module->minor_version(); + $name = $module->name(); =over 4 -=item obj: C<$module> (C<L<Apache::Module|docs::2.0::api::Apache::Module>>) +=item obj: C<$module> +( C<L<Apache::Module object|docs::2.0::api::Apache::Module>> ) -=item ret: C<$minor_version> (integer) +=item ret: C<$name> ( string ) + +=item since: 1.99_12 =back @@ -188,19 +217,23 @@ -=head2 C<module_index> +=head2 C<next> META: Autogenerated - needs to be reviewed/completed -Index to this modules structures in config vectors. +A pointer to the next module in the list - $index = $module->module_index(); + $next_module = $module->next(); =over 4 -=item obj: C<$module> (C<L<Apache::Module|docs::2.0::api::Apache::Module>>) +=item obj: C<$module> +( C<L<Apache::Module object|docs::2.0::api::Apache::Module>> ) -=item ret: C<$index> (integer) +=item ret: C<$next_module> +( C<L<Apache::Module object|docs::2.0::api::Apache::Module>> ) + +=item since: 1.99_12 =back @@ -208,39 +241,54 @@ -=head2 C<name> + + + +=head2 C<remove_loaded_module> META: Autogenerated - needs to be reviewed/completed -The name of the module's C file +Remove a module from the chained modules list and the list of loaded +modules - $name = $module->name(); + $module->remove_loaded_module(); =over 4 -=item obj: C<$module> (C<L<Apache::Module|docs::2.0::api::Apache::Module>>) +=item obj: C<$module> +( C<L<Apache::Module object|docs::2.0::api::Apache::Module>> ) -=item ret: C<$name> (string) -=back +=item ret: no return value +=item since: 1.99_12 +=back -=head2 C<dynamic_load_handle> +=head2 C<remove_module> META: Autogenerated - needs to be reviewed/completed -The handle for the DSO. Internal use only +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. - $dl_handle = $module->dynamic_load_handle(); + $module->remove_module(); =over 4 -=item obj: C<$module> (C<L<Apache::Module|docs::2.0::api::Apache::Module>>) +=item obj: C<$module> +( C<L<Apache::Module object|docs::2.0::api::Apache::Module>> ) + +the module structure of the module to remove + +=item ret: no return value -=item ret: C<$dl_handle> (SCALAR) +=item since: 1.99_12 =back @@ -248,19 +296,21 @@ -=head2 C<next> -META: Autogenerated - needs to be reviewed/completed +=head2 C<top_module> -A pointer to the next module in the list +META: Autogenerated - needs to be reviewed/completed - $next_module = $module->next(); + $ret = Apache::Module->top_module(); =over 4 -=item obj: C<$module> (C<L<Apache::Module|docs::2.0::api::Apache::Module>>) +=item obj: C<Apache::Module> ( class name ) + +=item ret: C<$ret> +( C<L<Apache::Module object|docs::2.0::api::Apache::Module>> ) -=item ret: C<$next_module> (C<L<Apache::Module|docs::2.0::api::Apache::Module>>) +=item since: 1.99_12 =back @@ -268,22 +318,26 @@ -=head2 C<cmds> +=head2 C<version> META: Autogenerated - needs to be reviewed/completed -A command_rec table that describes all of the directives this module -defines. +API version, *not* module version; check that module is +compatible with this version of the server. - $cmd_rec = $module->cmds(); + $version = $module->version(); =over 4 -=item obj: C<$module> (C<L<Apache::Module|docs::2.0::api::Apache::Module>>) +=item obj: C<$module> +( C<L<Apache::Module object|docs::2.0::api::Apache::Module>> ) -=item ret: C<$cmd_rec> (C<L<Apache::Command|docs::2.0::api::Apache::Command>>) +=item ret: C<$version> ( integer ) + +=item since: 1.99_12 =back +
--------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
