963N/A<?
xml version="1.0" encoding="ISO-8859-1"?>
919N/A XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX 919N/A This file is generated from xml source: DO NOT EDIT 919N/A XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX 919N/A<
title>Apache 2.0 Hook Functions - Apache HTTP Server</
title>
919N/A<
body id="manual-page"><
div id="page-header">
919N/A<
p class="apache">Apache HTTP Server Version 2.1</
p>
919N/A<
div class="up"><
a href="./"><
img title="<-" alt="<-" src="/images/left.gif" /></
a></
div>
550N/A <
div class="warning"><
h3>Warning</
h3>
550N/A <
p>This document is still in development and may be partially out of
550N/A <
p>In general, a hook function is one that Apache will call at
550N/A some point during the processing of a request. Modules can
550N/A provide functions that are called, and specify when they get
550N/A called in comparison to other modules.</
p>
550N/A<
div id="quickview"><
ul id="toc"><
li><
img alt="" src="/images/down.gif" /> <
a href="#create">Creating a hook function</
a></
li>
550N/A<
div class="top"><
a href="#page-header"><
img alt="top" src="/images/up.gif" /></
a></
div>
550N/A<
h2><
a name="create" id="create">Creating a hook function</
a></
h2>
963N/A <
p>In order to create a new hook, four things need to be
<
h3><
a name="create-declare" id="create-declare">Declare the hook function</
a></
h3>
<
p>Use the <
code>AP_DECLARE_HOOK</
code> macro, which needs to be given
the return type of the hook function, the name of the hook, and the
arguments. For example, if the hook returns an <
code>int</
code> and
takes a <
code>request_rec *</
code> and an <
code>int</
code> and is
called <
code>do_something</
code>, then declare it like this:</
p>
<
div class="example"><
p><
code>
AP_DECLARE_HOOK(int, do_something, (request_rec *r, int n))
<
p>This should go in a header which modules will include if
they want to use the hook.</
p>
<
h3><
a name="create-create" id="create-create">Create the hook structure</
a></
h3>
<
p>Each source file that exports a hook has a private structure
which is used to record the module functions that use the hook.
This is declared as follows:</
p>
<
div class="example"><
p><
code>
APR_HOOK_LINK(do_something)<
br />
<
h3><
a name="create-implement" id="create-implement">Implement the hook caller</
a></
h3>
<
p>The source file that exports the hook has to implement a
function that will call the hook. There are currently three
possible ways to do this. In all cases, the calling function is
called <
code>ap_run_<
var>hookname</
var>()</
code>.</
p>
<
p>If the return value of a hook is <
code>void</
code>, then all the
hooks are called, and the caller is implemented like this:</
p>
<
div class="example"><
p><
code>
AP_IMPLEMENT_HOOK_VOID(do_something, (request_rec *r, int n), (r, n))
<
p>The second and third arguments are the dummy argument
declaration and the dummy arguments as they will be used when
calling the hook. In other words, this macro expands to
<
div class="example"><
p><
code>
void ap_run_do_something(request_rec *r, int n)<
br />
do_something(r, n);<
br />
<
h4>Hooks that return a value</
h4>
<
p>If the hook returns a value, then it can either be run until
the first hook that does something interesting, like so:</
p>
<
div class="example"><
p><
code>
AP_IMPLEMENT_HOOK_RUN_FIRST(int, do_something, (request_rec *r, int n), (r, n), DECLINED)
<
p>The first hook that does <
em>not</
em> return <
code>DECLINED</
code>
stops the loop and its return value is returned from the hook
caller. Note that <
code>DECLINED</
code> is the tradition Apache
hook return meaning "I didn't do anything", but it can be
<
p>Alternatively, all hooks can be run until an error occurs.
This boils down to permitting <
em>two</
em> return values, one of
which means "I did something, and it was OK" and the other
meaning "I did nothing". The first function that returns a
value other than one of those two stops the loop, and its
return is the return value. Declare these like so:</
p>
<
div class="example"><
p><
code>
AP_IMPLEMENT_HOOK_RUN_ALL(int, do_something, (request_rec *r, int n), (r, n), OK, DECLINED)
<
p>Again, <
code>OK</
code> and <
code>DECLINED</
code> are the traditional
values. You can use what you want.</
p>
<
h3><
a name="create-call" id="create-call">Call the hook callers</
a></
h3>
<
p>At appropriate moments in the code, call the hook caller,
<
div class="example"><
p><
code>
ret=ap_run_do_something(r, n);
</
div><
div class="top"><
a href="#page-header"><
img alt="top" src="/images/up.gif" /></
a></
div>
<
h2><
a name="hooking" id="hooking">Hooking the hook</
a></
h2>
<
p>A module that wants a hook to be called needs to do two
<
h3><
a name="hooking-implement" id="hooking-implement">Implement the hook function</
a></
h3>
<
p>Include the appropriate header, and define a static function
<
div class="example"><
p><
code>
static int my_something_doer(request_rec *r, int n)<
br />
<
h3><
a name="hooking-add" id="hooking-add">Add a hook registering function</
a></
h3>
<
p>During initialisation, Apache will call each modules hook
registering function, which is included in the module
<
div class="example"><
p><
code>
static void my_register_hooks()<
br />
ap_hook_do_something(my_something_doer, NULL, NULL, HOOK_MIDDLE);<
br />
mode MODULE_VAR_EXPORT my_module =<
br />
my_register_hooks /* register hooks */<
br />
<
h3><
a name="hooking-order" id="hooking-order">Controlling hook calling order</
a></
h3>
<
p>In the example above, we didn't use the three arguments in
the hook registration function that control calling order.
There are two mechanisms for doing this. The first, rather
crude, method, allows us to specify roughly where the hook is
run relative to other modules. The final argument control this.
There are three possible values: <
code>HOOK_FIRST</
code>,
<
code>HOOK_MIDDLE</
code> and <
code>HOOK_LAST</
code>.</
p>
<
p>All modules using any particular value may be run in any
order relative to each other, but, of course, all modules using
<
code>HOOK_FIRST</
code> will be run before <
code>HOOK_MIDDLE</
code>
which are before <
code>HOOK_LAST</
code>. Modules that don't care
when they are run should use <
code>HOOK_MIDDLE</
code>. <
em>(I spaced
these out so people could do stuff like <
code>HOOK_FIRST-2</
code>
to get in slightly earlier, but is this wise? - Ben)</
em></
p>
<
p>Note that there are two more values,
<
code>HOOK_REALLY_FIRST</
code> and <
code>HOOK_REALLY_LAST</
code>. These
should only be used by the hook exporter.</
p>
<
p>The other method allows finer control. When a module knows
that it must be run before (or after) some other modules, it
can specify them by name. The second (third) argument is a
NULL-terminated array of strings consisting of the names of
modules that must be run before (after) the current module. For
before we do, then we'd hook as follows:</
p>
<
div class="example"><
p><
code>
static void register_hooks()<
br />
ap_hook_do_something(my_something_doer, aszPre, NULL, HOOK_MIDDLE);<
br />
<
p>Note that the sort used to achieve this is stable, so
ordering set by <
code>HOOK_<
var>ORDER</
var></
code> is preserved, as far
<
p class="cite"><
cite>Ben Laurie</
cite>, 15th August 1999</
p>