Apache HTTP Server Version 2.2
Apache Module mod_example
| Description: | Illustrates the Apache module API |
|---|---|
| Status: | Experimental |
| Module Identifier: | example_module |
| Source File: | mod_example.c |
Summary
Some files in the modules/experimental 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.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-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.
Compiling the example module
To include the example module in your server, follow the steps below:
-
Run
configurewith--enable-exampleoption. - Make the server (run "
make").
To add another module of your own:
cp modules/experimental/mod_example.c modules/new_module/mod_myexample.c- Modify the file.
- Create
modules/new_module/config.m4.- Add
APACHE_MODPATH_INIT(new_module). - Copy APACHE_MODULE line with "example" from
modules/experimental/config.m4. - Replace the first argument "example" with myexample.
- Replace the second argument with brief description of your module.
It will be used in
configure --help. - If your module needs additional C compiler flags, linker flags or
libraries, add them to CFLAGS, LDFLAGS and LIBS accordingly.
See other
config.m4files in modules directory for examples. - Add
APACHE_MODPATH_FINISH.
- Add
- Create
module/new_module/Makefile.in. If your module doesn't need special build instructions, all you need to have in that file isinclude $(top_srcdir)/build/special.mk. - Run ./buildconf from the top-level directory.
- Build the server with --enable-myexample
Using the mod_example Module
To activate the example module, include a block similar to
the following in your httpd.conf file:
<Location /example-info>
SetHandler example-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-handler .example
After reloading/restarting your server, you should be able to browse to this location and see the brief display mentioned earlier.
Example Directive
| Description: | Demonstration directive to illustrate the Apache module API |
|---|---|
| Syntax: | Example |
| Context: | server config, virtual host, directory, .htaccess |
| Status: | Experimental |
| Module: | mod_example |
The 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 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".