hooks.html.en revision 1c14060ebaf0bab91387c4be294e0d3fddf2068c
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd This file is generated from xml source: DO NOT EDIT
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd<title>Apache 2.0 Hook Functions - Apache HTTP Server</title>
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd<link href="/style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd<link href="/style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd<link href="/style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd<link href="/images/favicon.ico" rel="shortcut icon" /></head>
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/directives.html">Directives</a> | <a href="/faq/">FAQ</a> | <a href="/glossary.html">Glossary</a> | <a href="/sitemap.html">Sitemap</a></p>
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd<div class="up"><a href="./"><img title="<-" alt="<-" src="/images/left.gif" /></a></div>
c82fca6d3f5608b946f18d37e8710b1d71e3478dnd<a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs-project/">Documentation</a> > <a href="../">Version 2.1</a> > <a href="./">Developer Documentation</a></div><div id="page-content"><div id="preamble"><h1>Apache 2.0 Hook Functions</h1>
ad74a0524a06bfe11b7de9e3b4ce7233ab3bd3f7nd<p><span>Available Languages: </span><a href="/en/developer/hooks.html" title="English"> en </a></p>
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd <p>This document is still in development and may be partially out of
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd <p>In general, a hook function is one that Apache will call at
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd some point during the processing of a request. Modules can
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd provide functions that are called, and specify when they get
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd called in comparison to other modules.</p>
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd<div id="quickview"><ul id="toc"><li><img alt="" src="/images/down.gif" /> <a href="#create">Creating a hook function</a></li>
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd<li><img alt="" src="/images/down.gif" /> <a href="#hooking">Hooking the hook</a></li>
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd<h2><a name="create" id="create">Creating a hook function</a></h2>
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd <p>In order to create a new hook, four things need to be
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd <h3><a name="create-declare" id="create-declare">Declare the hook function</a></h3>
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd <p>Use the <code>AP_DECLARE_HOOK</code> macro, which needs to be given
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd the return type of the hook function, the name of the hook, and the
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd arguments. For example, if the hook returns an <code>int</code> and
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd takes a <code>request_rec *</code> and an <code>int</code> and is
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd called <code>do_something</code>, then declare it like this:</p>
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd AP_DECLARE_HOOK(int, do_something, (request_rec *r, int n))
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd <p>This should go in a header which modules will include if
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd they want to use the hook.</p>
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd <h3><a name="create-create" id="create-create">Create the hook structure</a></h3>
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd <p>Each source file that exports a hook has a private structure
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd which is used to record the module functions that use the hook.
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd This is declared as follows:</p>
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd APR_HOOK_STRUCT(<br />
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd APR_HOOK_LINK(do_something)<br />
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd <h3><a name="create-implement" id="create-implement">Implement the hook caller</a></h3>
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd <p>The source file that exports the hook has to implement a
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd function that will call the hook. There are currently three
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd possible ways to do this. In all cases, the calling function is
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd <p>If the return value of a hook is <code>void</code>, then all the
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd hooks are called, and the caller is implemented like this:</p>
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd AP_IMPLEMENT_HOOK_VOID(do_something, (request_rec *r, int n), (r, n))
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd <p>The second and third arguments are the dummy argument
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd declaration and the dummy arguments as they will be used when
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd calling the hook. In other words, this macro expands to
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd something like this:</p>
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd void ap_run_do_something(request_rec *r, int n)<br />
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd do_something(r, n);<br />
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd <p>If the hook returns a value, then it can either be run until
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd the first hook that does something interesting, like so:</p>
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd AP_IMPLEMENT_HOOK_RUN_FIRST(int, do_something, (request_rec *r, int n), (r, n), DECLINED)
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd <p>The first hook that does <em>not</em> return <code>DECLINED</code>
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd stops the loop and its return value is returned from the hook
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd caller. Note that <code>DECLINED</code> is the tradition Apache
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd hook return meaning "I didn't do anything", but it can be
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd whatever suits you.</p>
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd <p>Alternatively, all hooks can be run until an error occurs.
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd This boils down to permitting <em>two</em> return values, one of
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd which means "I did something, and it was OK" and the other
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd meaning "I did nothing". The first function that returns a
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd value other than one of those two stops the loop, and its
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd return is the return value. Declare these like so:</p>
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd AP_IMPLEMENT_HOOK_RUN_ALL(int, do_something, (request_rec *r, int n), (r, n), OK, DECLINED)
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd <p>Again, <code>OK</code> and <code>DECLINED</code> are the traditional
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd values. You can use what you want.</p>
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd <h3><a name="create-call" id="create-call">Call the hook callers</a></h3>
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd <p>At appropriate moments in the code, call the hook caller,
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd like so:</p>
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd int n, ret;<br />
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd request_rec *r;<br />
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd ret=ap_run_do_something(r, n);
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd</div><div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd<h2><a name="hooking" id="hooking">Hooking the hook</a></h2>
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd <p>A module that wants a hook to be called needs to do two
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd things.</p>
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd <h3><a name="hooking-implement" id="hooking-implement">Implement the hook function</a></h3>
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd <p>Include the appropriate header, and define a static function
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd of the correct type:</p>
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd static int my_something_doer(request_rec *r, int n)<br />
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd return OK;<br />
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd <h3><a name="hooking-add" id="hooking-add">Add a hook registering function</a></h3>
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd <p>During initialisation, Apache will call each modules hook
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd registering function, which is included in the module
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd structure:</p>
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd static void my_register_hooks()<br />
1c14060ebaf0bab91387c4be294e0d3fddf2068cyoshiki ap_hook_do_something(my_something_doer, NULL, NULL, APR_HOOK_MIDDLE);<br />
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd mode MODULE_VAR_EXPORT my_module =<br />
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd my_register_hooks /* register hooks */<br />
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd <h3><a name="hooking-order" id="hooking-order">Controlling hook calling order</a></h3>
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd <p>In the example above, we didn't use the three arguments in
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd the hook registration function that control calling order.
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd There are two mechanisms for doing this. The first, rather
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd crude, method, allows us to specify roughly where the hook is
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd run relative to other modules. The final argument control this.
1c14060ebaf0bab91387c4be294e0d3fddf2068cyoshiki There are three possible values: <code>APR_HOOK_FIRST</code>,
1c14060ebaf0bab91387c4be294e0d3fddf2068cyoshiki <code>APR_HOOK_MIDDLE</code> and <code>APR_HOOK_LAST</code>.</p>
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd <p>All modules using any particular value may be run in any
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd order relative to each other, but, of course, all modules using
1c14060ebaf0bab91387c4be294e0d3fddf2068cyoshiki <code>APR_HOOK_FIRST</code> will be run before <code>APR_HOOK_MIDDLE</code>
1c14060ebaf0bab91387c4be294e0d3fddf2068cyoshiki which are before <code>APR_HOOK_LAST</code>. Modules that don't care
1c14060ebaf0bab91387c4be294e0d3fddf2068cyoshiki when they are run should use <code>APR_HOOK_MIDDLE</code>. <em>(I spaced
1c14060ebaf0bab91387c4be294e0d3fddf2068cyoshiki these out so people could do stuff like <code>APR_HOOK_FIRST-2</code>
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd to get in slightly earlier, but is this wise? - Ben)</em></p>
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd <p>Note that there are two more values,
1c14060ebaf0bab91387c4be294e0d3fddf2068cyoshiki <code>APR_HOOK_REALLY_FIRST</code> and <code>APR_HOOK_REALLY_LAST</code>. These
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd should only be used by the hook exporter.</p>
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd <p>The other method allows finer control. When a module knows
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd that it must be run before (or after) some other modules, it
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd can specify them by name. The second (third) argument is a
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd NULL-terminated array of strings consisting of the names of
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd modules that must be run before (after) the current module. For
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd example, suppose we want "mod_xyz.c" and "mod_abc.c" to run
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd before we do, then we'd hook as follows:</p>
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd static void register_hooks()<br />
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd static const char * const aszPre[] = { "mod_xyz.c", "mod_abc.c", NULL };<br />
1c14060ebaf0bab91387c4be294e0d3fddf2068cyoshiki ap_hook_do_something(my_something_doer, aszPre, NULL, APR_HOOK_MIDDLE);<br />
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd <p>Note that the sort used to achieve this is stable, so
1c14060ebaf0bab91387c4be294e0d3fddf2068cyoshiki ordering set by <code>APR_HOOK_<var>ORDER</var></code> is preserved, as far
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd as is possible.</p>
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd <p class="cite"><cite>Ben Laurie</cite>, 15th August 1999</p>
ad74a0524a06bfe11b7de9e3b4ce7233ab3bd3f7nd<p><span>Available Languages: </span><a href="/en/developer/hooks.html" title="English"> en </a></p>
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd<p class="apache">Maintained by the <a href="http://httpd.apache.org/docs-project/">Apache HTTP Server Documentation Project</a></p>
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/directives.html">Directives</a> | <a href="/faq/">FAQ</a> | <a href="/glossary.html">Glossary</a> | <a href="/sitemap.html">Sitemap</a></p></div>