home *** CD-ROM | disk | FTP | other *** search
/ PC World 2003 November / PCWorld_2003-11_cd.bin / Komunik / apache / apache_2.0.47-win32-x86-no_ssl.msi / Data.Cab / F250734_hooks.xml < prev    next >
Extensible Markup Language  |  2003-04-15  |  8KB  |  219 lines
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <!DOCTYPE manualpage SYSTEM "../style/manualpage.dtd">
  3. <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
  4.  
  5. <manualpage metafile="hooks.xml.meta">
  6. <parentdocument href="./">Developer Documentation</parentdocument>
  7.  
  8. <title>Apache 2.0 Hook Functions</title>
  9.  
  10. <summary>
  11.     <note type="warning"><title>Warning</title>
  12.       <p>This document is still in development and may be partially out of
  13.       date.</p>
  14.     </note>
  15.  
  16.     <p>In general, a hook function is one that Apache will call at
  17.     some point during the processing of a request. Modules can
  18.     provide functions that are called, and specify when they get
  19.     called in comparison to other modules.</p>
  20. </summary>
  21.  
  22. <section id="create"><title>Creating a hook function</title>
  23.     <p>In order to create a new hook, four things need to be
  24.     done:</p>
  25.  
  26.     <section id="create-declare"><title>Declare the hook function</title>
  27.       <p>Use the <code>AP_DECLARE_HOOK</code> macro, which needs to be given
  28.       the return type of the hook function, the name of the hook, and the
  29.       arguments. For example, if the hook returns an <code>int</code> and
  30.       takes a <code>request_rec *</code> and an <code>int</code> and is
  31.       called <code>do_something</code>, then declare it like this:</p>
  32.       <example>
  33.         AP_DECLARE_HOOK(int, do_something, (request_rec *r, int n))
  34.       </example>
  35.  
  36.       <p>This should go in a header which modules will include if
  37.       they want to use the hook.</p>
  38.     </section>
  39.  
  40.     <section id="create-create"><title>Create the hook structure</title>
  41.       <p>Each source file that exports a hook has a private structure
  42.       which is used to record the module functions that use the hook.
  43.       This is declared as follows:</p>
  44.  
  45.       <example>
  46.         APR_HOOK_STRUCT(<br />
  47.         <indent>
  48.           APR_HOOK_LINK(do_something)<br />
  49.           ...<br />
  50.         </indent>
  51.         )
  52.       </example>
  53.     </section>
  54.  
  55.     <section id="create-implement"><title>Implement the hook caller</title>
  56.       <p>The source file that exports the hook has to implement a
  57.       function that will call the hook. There are currently three
  58.       possible ways to do this. In all cases, the calling function is
  59.       called <code>ap_run_<var>hookname</var>()</code>.</p>
  60.  
  61.       <section><title>Void hooks</title>
  62.         <p>If the return value of a hook is <code>void</code>, then all the
  63.         hooks are called, and the caller is implemented like this:</p>
  64.  
  65.         <example>
  66.           AP_IMPLEMENT_HOOK_VOID(do_something, (request_rec *r, int n), (r, n))
  67.         </example>
  68.  
  69.         <p>The second and third arguments are the dummy argument
  70.         declaration and the dummy arguments as they will be used when
  71.         calling the hook. In other words, this macro expands to
  72.         something like this:</p>
  73.  
  74.         <example>
  75.           void ap_run_do_something(request_rec *r, int n)<br />
  76.           {<br />
  77.           <indent>
  78.             ...<br />
  79.             do_something(r, n);<br />
  80.           </indent>
  81.           }
  82.         </example>
  83.       </section>
  84.  
  85.       <section><title>Hooks that return a value</title>
  86.         <p>If the hook returns a value, then it can either be run until
  87.         the first hook that does something interesting, like so:</p>
  88.  
  89.         <example>
  90.           AP_IMPLEMENT_HOOK_RUN_FIRST(int, do_something, (request_rec *r, int n), (r, n), DECLINED)
  91.         </example>
  92.  
  93.         <p>The first hook that does <em>not</em> return <code>DECLINED</code>
  94.         stops the loop and its return value is returned from the hook
  95.         caller. Note that <code>DECLINED</code> is the tradition Apache
  96.         hook return meaning "I didn't do anything", but it can be
  97.         whatever suits you.</p>
  98.  
  99.         <p>Alternatively, all hooks can be run until an error occurs.
  100.         This boils down to permitting <em>two</em> return values, one of
  101.         which means "I did something, and it was OK" and the other
  102.         meaning "I did nothing". The first function that returns a
  103.         value other than one of those two stops the loop, and its
  104.         return is the return value. Declare these like so:</p>
  105.  
  106.         <example>
  107.           AP_IMPLEMENT_HOOK_RUN_ALL(int, do_something, (request_rec *r, int n), (r, n), OK, DECLINED)
  108.         </example>
  109.  
  110.         <p>Again, <code>OK</code> and <code>DECLINED</code> are the traditional
  111.         values. You can use what you want.</p>
  112.       </section>
  113.     </section>
  114.  
  115.     <section id="create-call"><title>Call the hook callers</title>
  116.       <p>At appropriate moments in the code, call the hook caller,
  117.       like so:</p>
  118.  
  119.       <example>
  120.         int n, ret;<br />
  121.         request_rec *r;<br />
  122.         <br />
  123.         ret=ap_run_do_something(r, n);
  124.       </example>
  125.     </section>
  126. </section>
  127.  
  128. <section id="hooking"><title>Hooking the hook</title>
  129.     <p>A module that wants a hook to be called needs to do two
  130.     things.</p>
  131.  
  132.     <section id="hooking-implement"><title>Implement the hook function</title>
  133.       <p>Include the appropriate header, and define a static function
  134.       of the correct type:</p>
  135.  
  136.       <example>
  137.         static int my_something_doer(request_rec *r, int n)<br />
  138.         {<br />
  139.         <indent>
  140.           ...<br />
  141.           return OK;<br />
  142.         </indent>
  143.         }
  144.       </example>
  145.     </section>
  146.  
  147.     <section id="hooking-add"><title>Add a hook registering function</title>
  148.       <p>During initialisation, Apache will call each modules hook
  149.       registering function, which is included in the module
  150.       structure:</p>
  151.  
  152.       <example>
  153.         static void my_register_hooks()<br />
  154.         {<br />
  155.         <indent>
  156.           ap_hook_do_something(my_something_doer, NULL, NULL, HOOK_MIDDLE);<br />
  157.         </indent>
  158.         }<br />
  159.         <br />
  160.         mode MODULE_VAR_EXPORT my_module =<br />
  161.         {<br />
  162.         <indent>
  163.           ...<br />
  164.           my_register_hooks       /* register hooks */<br />
  165.         </indent>
  166.         };
  167.       </example>
  168.     </section>
  169.  
  170.     <section id="hooking-order"><title>Controlling hook calling order</title>
  171.       <p>In the example above, we didn't use the three arguments in
  172.       the hook registration function that control calling order.
  173.       There are two mechanisms for doing this. The first, rather
  174.       crude, method, allows us to specify roughly where the hook is
  175.       run relative to other modules. The final argument control this.
  176.       There are three possible values: <code>HOOK_FIRST</code>,
  177.       <code>HOOK_MIDDLE</code> and <code>HOOK_LAST</code>.</p>
  178.  
  179.       <p>All modules using any particular value may be run in any
  180.       order relative to each other, but, of course, all modules using
  181.       <code>HOOK_FIRST</code> will be run before <code>HOOK_MIDDLE</code>
  182.       which are before <code>HOOK_LAST</code>. Modules that don't care
  183.       when they are run should use <code>HOOK_MIDDLE</code>. <em>(I spaced
  184.       these out so people could do stuff like <code>HOOK_FIRST-2</code>
  185.       to get in slightly earlier, but is this wise? - Ben)</em></p>
  186.  
  187.       <p>Note that there are two more values,
  188.       <code>HOOK_REALLY_FIRST</code> and <code>HOOK_REALLY_LAST</code>. These
  189.       should only be used by the hook exporter.</p>
  190.  
  191.       <p>The other method allows finer control. When a module knows
  192.       that it must be run before (or after) some other modules, it
  193.       can specify them by name. The second (third) argument is a
  194.       NULL-terminated array of strings consisting of the names of
  195.       modules that must be run before (after) the current module. For
  196.       example, suppose we want "mod_xyz.c" and "mod_abc.c" to run
  197.       before we do, then we'd hook as follows:</p>
  198.  
  199.       <example>
  200.         static void register_hooks()<br />
  201.         {<br />
  202.         <indent>
  203.           static const char * const aszPre[] = { "mod_xyz.c", "mod_abc.c", NULL };<br />
  204.           <br />
  205.           ap_hook_do_something(my_something_doer, aszPre, NULL, HOOK_MIDDLE);<br />
  206.         </indent>
  207.         }
  208.       </example>
  209.  
  210.       <p>Note that the sort used to achieve this is stable, so
  211.       ordering set by <code>HOOK_<var>ORDER</var></code> is preserved, as far
  212.       as is possible.</p>
  213.  
  214.       <p class="cite"><cite>Ben Laurie</cite>, 15th August 1999</p>
  215.     </section>
  216. </section>
  217. </manualpage>
  218.  
  219.