|Description:||Illustrates the Apache module API|
The files in the
modules/examples directory under the Apache distribution directory tree are provided as an example to those that wish to write modules that use the Apache API.
The main file is
mod_example_hooks.c, which illustrates all the different callback mechanisms and call syntaxes. By no means does an add-on module need to include routines for all of the callbacks - quite the contrary!
The example module is an actual working module. If you link it into your server, enable the "example-hooks-handler" handler for a location, and then browse to that location, you will see a display of some of the tracing the example module did as the various callbacks were made.
To include the example_hooks module in your server, follow the steps below:
To add another module of your own:
cp modules/examples/mod_example_hooks.c modules/new_module/mod_myexample.c
config.m4files in modules directory for examples.
module/new_module/Makefile.in. If your module doesn't need special build instructions, all you need to have in that file is
To activate the example_hooks module, include a block similar to the following in your
<Location "/example-hooks-info"> SetHandler example-hooks-handler </Location>
As an alternative, you can put the following into a
.htaccess file and then request the file "test.example" from that location:
AddHandler example-hooks-handler ".example"
After reloading/restarting your server, you should be able to browse to this location and see the brief display mentioned earlier.
|Description:||Demonstration directive to illustrate the Apache module API|
|Context:||server config, virtual host, directory, .htaccess|
Example directive just sets a demonstration flag which the example module's content handler displays. It takes no arguments. If you browse to an URL to which the example-hooks content-handler applies, you will get a display of the routines within the module and how and in what order they were called to service the document request. The effect of this directive one can observe under the point "
Example directive declared here: YES/NO".
© 2016 The Apache Software Foundation
Licensed under the Apache License, Version 2.0.