granicus.if.org Git - apache/blob - docs/manual/developer/hooks.html.en

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
   4         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   5               This file is generated from xml source: DO NOT EDIT
   6         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   7       -->
   8 <title>Hook Functions in the Apache HTTP Server 2.x - Apache HTTP Server</title>
   9 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
  10 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
  11 <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" />
  12 <script src="../style/scripts/prettify.js" type="text/javascript">
  13 </script>
  14
  15 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  16 <body id="manual-page"><div id="page-header">
  17 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.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>
  18 <p class="apache">Apache HTTP Server Version 2.5</p>
  19 <img alt="" src="../images/feather.gif" /></div>
  20 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  21 <div id="path">
  22 <a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs/">Documentation</a> &gt; <a href="../">Version 2.5</a> &gt; <a href="./">Developer Documentation</a></div><div id="page-content"><div id="preamble"><h1>Hook Functions in the Apache HTTP Server 2.x</h1>
  23 <div class="toplang">
  24 <p><span>Available Languages: </span><a href="../en/developer/hooks.html" title="English">&nbsp;en&nbsp;</a></p>
  25 </div>
  26
  27     <div class="warning"><h3>Warning</h3>
  28       <p>This document is still in development and may be partially out of
  29       date.</p>
  30     </div>
  31
  32     <p>In general, a hook function is one that the Apache HTTP Server
  33     will call at some point during the processing of a request.
  34     Modules can provide functions that are called, and specify when
  35     they get called in comparison to other modules.</p>
  36 </div>
  37 <div id="quickview"><ul id="toc"><li><img alt="" src="../images/down.gif" /> <a href="#create">Creating a hook function</a></li>
  38 <li><img alt="" src="../images/down.gif" /> <a href="#hooking">Hooking the hook</a></li>
  39 </ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
  40 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  41 <div class="section">
  42 <h2><a name="create" id="create">Creating a hook function</a></h2>
  43     <p>In order to create a new hook, four things need to be
  44     done:</p>
  45
  46     <h3><a name="create-declare" id="create-declare">Declare the hook function</a></h3>
  47       <p>Use the <code>AP_DECLARE_HOOK</code> macro, which needs to be given
  48       the return type of the hook function, the name of the hook, and the
  49       arguments. For example, if the hook returns an <code>int</code> and
  50       takes a <code>request_rec *</code> and an <code>int</code> and is
  51       called <code>do_something</code>, then declare it like this:</p>
  52       <pre class="prettyprint lang-c">
  53         AP_DECLARE_HOOK(int, do_something, (request_rec *r, int n))
  54       </pre>
  55
  56
  57       <p>This should go in a header which modules will include if
  58       they want to use the hook.</p>
  59
  60
  61     <h3><a name="create-create" id="create-create">Create the hook structure</a></h3>
  62       <p>Each source file that exports a hook has a private structure
  63       which is used to record the module functions that use the hook.
  64       This is declared as follows:</p>
  65
  66       <pre class="prettyprint lang-c">
  67 APR_HOOK_STRUCT(
  68   APR_HOOK_LINK(do_something)
  69   ...
  70 )
  71       </pre>
  72
  73
  74
  75     <h3><a name="create-implement" id="create-implement">Implement the hook caller</a></h3>
  76       <p>The source file that exports the hook has to implement a
  77       function that will call the hook. There are currently three
  78       possible ways to do this. In all cases, the calling function is
  79       called <code>ap_run_<var>hookname</var>()</code>.</p>
  80
  81       <h4>Void hooks</h4>
  82         <p>If the return value of a hook is <code>void</code>, then all the
  83         hooks are called, and the caller is implemented like this:</p>
  84
  85         <pre class="prettyprint lang-c">
  86           AP_IMPLEMENT_HOOK_VOID(do_something, (request_rec *r, int n), (r, n))
  87         </pre>
  88
  89
  90         <p>The second and third arguments are the dummy argument
  91         declaration and the dummy arguments as they will be used when
  92         calling the hook. In other words, this macro expands to
  93         something like this:</p>
  94
  95         <pre class="prettyprint lang-c">
  96 void ap_run_do_something(request_rec *r, int n)
  97 {
  98 ...
  99 do_something(r, n);
 100 }
 101         </pre>
 102
 103
 104
 105       <h4>Hooks that return a value</h4>
 106         <p>If the hook returns a value, then it can either be run until
 107         the first hook that does something interesting, like so:</p>
 108
 109         <pre class="prettyprint lang-c">
 110           AP_IMPLEMENT_HOOK_RUN_FIRST(int, do_something, (request_rec *r, int n), (r, n), DECLINED)
 111         </pre>
 112
 113
 114         <p>The first hook that does <em>not</em> return <code>DECLINED</code>
 115         stops the loop and its return value is returned from the hook
 116         caller. Note that <code>DECLINED</code> is the traditional
 117         hook return value meaning "I didn't do anything", but it can be
 118         whatever suits you.</p>
 119
 120         <p>Alternatively, all hooks can be run until an error occurs.
 121         This boils down to permitting <em>two</em> return values, one of
 122         which means "I did something, and it was OK" and the other
 123         meaning "I did nothing". The first function that returns a
 124         value other than one of those two stops the loop, and its
 125         return is the return value. Declare these like so:</p>
 126
 127         <pre class="prettyprint lang-c">
 128           AP_IMPLEMENT_HOOK_RUN_ALL(int, do_something, (request_rec *r, int n), (r, n), OK, DECLINED)
 129         </pre>
 130
 131
 132         <p>Again, <code>OK</code> and <code>DECLINED</code> are the traditional
 133         values. You can use what you want.</p>
 134
 135
 136
 137     <h3><a name="create-call" id="create-call">Call the hook callers</a></h3>
 138       <p>At appropriate moments in the code, call the hook caller,
 139       like so:</p>
 140
 141       <pre class="prettyprint lang-c">
 142 int n, ret;
 143 request_rec *r;
 144
 145 ret=ap_run_do_something(r, n);
 146       </pre>
 147
 148
 149 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 150 <div class="section">
 151 <h2><a name="hooking" id="hooking">Hooking the hook</a></h2>
 152     <p>A module that wants a hook to be called needs to do two
 153     things.</p>
 154
 155     <h3><a name="hooking-implement" id="hooking-implement">Implement the hook function</a></h3>
 156       <p>Include the appropriate header, and define a static function
 157       of the correct type:</p>
 158
 159       <pre class="prettyprint lang-c">
 160 static int my_something_doer(request_rec *r, int n)<br />
 161 {
 162     ...
 163     return OK;
 164 }
 165       </pre>
 166
 167
 168
 169     <h3><a name="hooking-add" id="hooking-add">Add a hook registering function</a></h3>
 170       <p>During initialisation, the server will call each modules hook
 171       registering function, which is included in the module
 172       structure:</p>
 173
 174       <pre class="prettyprint lang-c">
 175 static void my_register_hooks()
 176 {
 177     ap_hook_do_something(my_something_doer, NULL, NULL, APR_HOOK_MIDDLE);
 178 }
 179
 180 mode MODULE_VAR_EXPORT my_module =
 181 {
 182     ...
 183     my_register_hooks       /* register hooks */
 184 };
 185       </pre>
 186
 187
 188
 189     <h3><a name="hooking-order" id="hooking-order">Controlling hook calling order</a></h3>
 190       <p>In the example above, we didn't use the three arguments in
 191       the hook registration function that control calling order.
 192       There are two mechanisms for doing this. The first, rather
 193       crude, method, allows us to specify roughly where the hook is
 194       run relative to other modules. The final argument control this.
 195       There are three possible values: <code>APR_HOOK_FIRST</code>,
 196       <code>APR_HOOK_MIDDLE</code> and <code>APR_HOOK_LAST</code>.</p>
 197
 198       <p>All modules using any particular value may be run in any
 199       order relative to each other, but, of course, all modules using
 200       <code>APR_HOOK_FIRST</code> will be run before <code>APR_HOOK_MIDDLE</code>
 201       which are before <code>APR_HOOK_LAST</code>. Modules that don't care
 202       when they are run should use <code>APR_HOOK_MIDDLE</code>. <em>These
 203       values are spaced out, so that positions like <code>APR_HOOK_FIRST-2</code>
 204       are possible to hook slightly earlier than other functions.</em></p>
 205
 206       <p>Note that there are two more values,
 207       <code>APR_HOOK_REALLY_FIRST</code> and <code>APR_HOOK_REALLY_LAST</code>. These
 208       should only be used by the hook exporter.</p>
 209
 210       <p>The other method allows finer control. When a module knows
 211       that it must be run before (or after) some other modules, it
 212       can specify them by name. The second (third) argument is a
 213       NULL-terminated array of strings consisting of the names of
 214       modules that must be run before (after) the current module. For
 215       example, suppose we want "mod_xyz.c" and "mod_abc.c" to run
 216       before we do, then we'd hook as follows:</p>
 217
 218       <pre class="prettyprint lang-c">
 219 static void register_hooks()
 220 {
 221     static const char * const aszPre[] = { "mod_xyz.c", "mod_abc.c", NULL };
 222
 223     ap_hook_do_something(my_something_doer, aszPre, NULL, APR_HOOK_MIDDLE);
 224 }
 225       </pre>
 226
 227
 228       <p>Note that the sort used to achieve this is stable, so
 229       ordering set by <code>APR_HOOK_<var>ORDER</var></code> is preserved, as far
 230       as is possible.</p>
 231
 232
 233 </div></div>
 234 <div class="bottomlang">
 235 <p><span>Available Languages: </span><a href="../en/developer/hooks.html" title="English">&nbsp;en&nbsp;</a></p>
 236 </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&amp;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>
 237 <script type="text/javascript"><!--//--><![CDATA[//><!--
 238 var comments_shortname = 'httpd';
 239 var comments_identifier = 'http://httpd.apache.org/docs/trunk/developer/hooks.html';
 240 (function(w, d) {
 241     if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
 242         d.write('<div id="comments_thread"><\/div>');
 243         var s = d.createElement('script');
 244         s.type = 'text/javascript';
 245         s.async = true;
 246         s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
 247         (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
 248     }
 249     else {
 250         d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
 251     }
 252 })(window, document);
 253 //--><!]]></script></div><div id="footer">
 254 <p class="apache">Copyright 2012 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>
 255 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.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[//><!--
 256 if (typeof(prettyPrint) !== 'undefined') {
 257     prettyPrint();
 258 }
 259 //--><!]]></script>
 260 </body></html>