1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
fd9abdda70912b99b24e3bf1a38f26fde908a74cnd<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
fd9abdda70912b99b24e3bf1a38f26fde908a74cnd<meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type" />
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd This file is generated from xml source: DO NOT EDIT
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
96ad5d81ee4a2cc66a4ae19893efc8aa6d06fae7jailletc<title>Hook Functions in the Apache HTTP Server 2.x - Apache HTTP Server Version 2.5</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" />
d29d9ab4614ff992b0e8de6e2b88d52b6f1f153erbowen<link href="/style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" /><link rel="stylesheet" type="text/css" href="/style/css/prettify.css" />
2e545ce2450a9953665f701bb05350f0d3f26275nd<script src="/style/scripts/prettify.min.js" type="text/javascript">
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd<link href="/images/favicon.ico" rel="shortcut icon" /></head>
af33a4994ae2ff15bc67d19ff1a7feb906745bf8rbowen<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/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>
8b7e19de6d547ab1ad4256316fbf0d2497f724f8humbedooh<a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs/">Documentation</a> > <a href="../">Version 2.5</a> > <a href="./">Developer Documentation</a></div><div id="page-content"><div id="preamble"><h1>Hook Functions in the Apache HTTP Server 2.x</h1>
f086b4b402fa9a2fefc7dda85de2a3cc1cd0a654rjung<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
a99c5d4cc3cab6a62b04d52000dbc22ce1fa2d94coar <p>In general, a hook function is one that the Apache HTTP Server
a99c5d4cc3cab6a62b04d52000dbc22ce1fa2d94coar will call at some point during the processing of a request.
a99c5d4cc3cab6a62b04d52000dbc22ce1fa2d94coar Modules can provide functions that are called, and specify when
8b7e19de6d547ab1ad4256316fbf0d2497f724f8humbedooh they get 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>
30471a4650391f57975f60bbb6e4a90be7b284bfhumbedooh</ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
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>
20f499565e77defe9dab24dd85c02f38a1175855nd <pre class="prettyprint lang-c">AP_DECLARE_HOOK(int, do_something, (request_rec *r, int n))</pre>
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>
e41ae559e8408edb1c949c1237034f277d423eccminfrin APR_HOOK_LINK(do_something)
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>
20f499565e77defe9dab24dd85c02f38a1175855nd <pre class="prettyprint lang-c">AP_IMPLEMENT_HOOK_VOID(do_something, (request_rec *r, int n), (r, n))</pre>
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>
4aa603e6448b99f9371397d439795c91a93637eand <pre class="prettyprint lang-c">void ap_run_do_something(request_rec *r, int n)
fd5a091eb07540ab440f8ac3a277caa590be46c1humbedooh do_something(r, n);
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>
20f499565e77defe9dab24dd85c02f38a1175855nd <pre class="prettyprint lang-c">AP_IMPLEMENT_HOOK_RUN_FIRST(int, do_something, (request_rec *r, int n), (r, n), DECLINED)</pre>
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
a99c5d4cc3cab6a62b04d52000dbc22ce1fa2d94coar caller. Note that <code>DECLINED</code> is the traditional
8b7e19de6d547ab1ad4256316fbf0d2497f724f8humbedooh hook return value 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>
20f499565e77defe9dab24dd85c02f38a1175855nd <pre class="prettyprint lang-c">AP_IMPLEMENT_HOOK_RUN_ALL(int, do_something, (request_rec *r, int n), (r, n), OK, DECLINED)</pre>
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>
e41ae559e8408edb1c949c1237034f277d423eccminfrinrequest_rec *r;
4aa603e6448b99f9371397d439795c91a93637eandret=ap_run_do_something(r, n);</pre>
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>
4aa603e6448b99f9371397d439795c91a93637eand <pre class="prettyprint lang-c">static int my_something_doer(request_rec *r, int n)<br />
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd <h3><a name="hooking-add" id="hooking-add">Add a hook registering function</a></h3>
8b7e19de6d547ab1ad4256316fbf0d2497f724f8humbedooh <p>During initialisation, the server will call each modules hook
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd registering function, which is included in the module
1eba1be63201689b2d3e651d3a35f0bc2057e2c0nd structure:</p>
4aa603e6448b99f9371397d439795c91a93637eand <pre class="prettyprint lang-c">static void my_register_hooks()
e41ae559e8408edb1c949c1237034f277d423eccminfrin ap_hook_do_something(my_something_doer, NULL, NULL, APR_HOOK_MIDDLE);
e41ae559e8408edb1c949c1237034f277d423eccminfrinmode MODULE_VAR_EXPORT my_module =
e41ae559e8408edb1c949c1237034f277d423eccminfrin my_register_hooks /* register hooks */
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
a99c5d4cc3cab6a62b04d52000dbc22ce1fa2d94coar when they are run should use <code>APR_HOOK_MIDDLE</code>. <em>These
8b7e19de6d547ab1ad4256316fbf0d2497f724f8humbedooh values are spaced out, so that positions like <code>APR_HOOK_FIRST-2</code>
8b7e19de6d547ab1ad4256316fbf0d2497f724f8humbedooh are possible to hook slightly earlier than other functions.</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>
4aa603e6448b99f9371397d439795c91a93637eand <pre class="prettyprint lang-c">static void register_hooks()
e41ae559e8408edb1c949c1237034f277d423eccminfrin static const char * const aszPre[] = { "mod_xyz.c", "mod_abc.c", NULL };
e41ae559e8408edb1c949c1237034f277d423eccminfrin ap_hook_do_something(my_something_doer, aszPre, NULL, APR_HOOK_MIDDLE);
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>
f086b4b402fa9a2fefc7dda85de2a3cc1cd0a654rjung<p><span>Available Languages: </span><a href="/en/developer/hooks.html" title="English"> en </a></p>
727872d18412fc021f03969b8641810d8896820bhumbedooh</div><div class="top"><a href="#page-header"><img src="/images/up.gif" alt="top" /></a></div><div class="section"><h2><a id="comments_section" name="comments_section">Comments</a></h2><div class="warning"><strong>Notice:</strong><br />This is not a Q&A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed again by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Freenode, or sent to our <a href="http://httpd.apache.org/lists.html">mailing lists</a>.</div>
727872d18412fc021f03969b8641810d8896820bhumbedoohvar comments_shortname = 'httpd';
cc7e1025de9ac63bd4db6fe7f71c158b2cf09fe4humbedoohvar comments_identifier = 'http://httpd.apache.org/docs/trunk/developer/hooks.html';
0d0ba3a410038e179b695446bb149cce6264e0abnd(function(w, d) {
cc7e1025de9ac63bd4db6fe7f71c158b2cf09fe4humbedooh if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
727872d18412fc021f03969b8641810d8896820bhumbedooh d.write('<div id="comments_thread"><\/div>');
0d0ba3a410038e179b695446bb149cce6264e0abnd var s = d.createElement('script');
ac082aefa89416cbdc9a1836eaf3bed9698201c8humbedooh s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
0d0ba3a410038e179b695446bb149cce6264e0abnd (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
727872d18412fc021f03969b8641810d8896820bhumbedooh d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
0d0ba3a410038e179b695446bb149cce6264e0abnd})(window, document);
205f749042ed530040a4f0080dbcb47ceae8a374rjung<p class="apache">Copyright 2015 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
af33a4994ae2ff15bc67d19ff1a7feb906745bf8rbowen<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="/glossary.html">Glossary</a> | <a href="/sitemap.html">Sitemap</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!--
0d0ba3a410038e179b695446bb149cce6264e0abndif (typeof(prettyPrint) !== 'undefined') {
7fec19672a491661b2fe4b29f685bc7f4efa64d4nd prettyPrint();