granicus.if.org Git - apache/blob - docs/manual/mod/mod_example_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 <meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type" />
   5 <!--
   6         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   7               This file is generated from xml source: DO NOT EDIT
   8         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   9       -->
  10 <title>mod_example_hooks - Apache HTTP Server Version 2.5</title>
  11 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
  12 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
  13 <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" />
  14 <script src="../style/scripts/prettify.min.js" type="text/javascript">
  15 </script>
  16
  17 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  18 <body>
  19 <div id="page-header">
  20 <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>
  21 <p class="apache">Apache HTTP Server Version 2.5</p>
  22 <img alt="" src="../images/feather.png" /></div>
  23 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  24 <div id="path">
  25 <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="./">Modules</a></div>
  26 <div id="page-content">
  27 <div id="preamble"><h1>Apache Module mod_example_hooks</h1>
  28 <div class="toplang">
  29 <p><span>Available Languages: </span><a href="../en/mod/mod_example_hooks.html" title="English">&nbsp;en&nbsp;</a> |
  30 <a href="../fr/mod/mod_example_hooks.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a> |
  31 <a href="../ko/mod/mod_example_hooks.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
  32 </div>
  33 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Illustrates the Apache module API</td></tr>
  34 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
  35 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>example_hooks_module</td></tr>
  36 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_example_hooks.c</td></tr></table>
  37 <h3>Summary</h3>
  38
  39     <p>The files in the <code>modules/examples</code> directory
  40     under the Apache distribution directory tree are provided as an
  41     example to those that wish to write modules that use the Apache
  42     API.</p>
  43
  44     <p>The main file is <code>mod_example_hooks.c</code>, which
  45     illustrates all the different callback mechanisms and call
  46     syntaxes. By no means does an add-on module need to include
  47     routines for all of the callbacks - quite the contrary!</p>
  48
  49     <p>The example module is an actual working module. If you link
  50     it into your server, enable the "example-hooks-handler" handler for a
  51     location, and then browse to that location, you will see a
  52     display of some of the tracing the example module did as the
  53     various callbacks were made.</p>
  54 </div>
  55 <div id="quickview"><h3>Topics</h3>
  56 <ul id="topics">
  57 <li><img alt="" src="../images/down.gif" /> <a href="#compiling">Compiling the example_hooks module</a></li>
  58 <li><img alt="" src="../images/down.gif" /> <a href="#using">Using the <code>mod_example_hooks</code> Module</a></li>
  59 </ul><h3 class="directives">Directives</h3>
  60 <ul id="toc">
  61 <li><img alt="" src="../images/down.gif" /> <a href="#example">Example</a></li>
  62 </ul>
  63 <h3>Bugfix checklist</h3><ul class="seealso"><li><a href="https://www.apache.org/dist/httpd/CHANGES_2.4">httpd changelog</a></li><li><a href="https://bz.apache.org/bugzilla/buglist.cgi?bug_status=__open__&amp;list_id=144532&amp;product=Apache%20httpd-2&amp;query_format=specific&amp;order=changeddate%20DESC%2Cpriority%2Cbug_severity&amp;component=mod_example_hooks">Known issues</a></li><li><a href="https://bz.apache.org/bugzilla/enter_bug.cgi?product=Apache%20httpd-2&amp;component=mod_example_hooks">Report a bug</a></li></ul><h3>See also</h3>
  64 <ul class="seealso">
  65 <li><a href="#comments_section">Comments</a></li></ul></div>
  66 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  67 <div class="section">
  68 <h2><a name="compiling" id="compiling">Compiling the example_hooks module</a> <a title="Permanent link" href="#compiling" class="permalink">&para;</a></h2>
  69
  70     <p>To include the example_hooks module in your server, follow the
  71     steps below:</p>
  72
  73     <ol>
  74       <li>
  75         Run <code class="program"><a href="../programs/configure.html">configure</a></code> with <code>--enable-example-hooks</code>
  76         option.</li>
  77
  78       <li>Make the server (run "<code>make</code>").</li>
  79     </ol>
  80
  81     <p>To add another module of your own:</p>
  82
  83     <ol class="up-A">
  84       <li><code>cp modules/examples/mod_example_hooks.c
  85       modules/new_module/<em>mod_myexample.c</em></code></li>
  86
  87       <li>Modify the file.</li>
  88
  89       <li>Create <code>modules/new_module/config.m4</code>.
  90         <ol>
  91           <li>Add <code>APACHE_MODPATH_INIT(new_module)</code>.</li>
  92           <li>Copy APACHE_MODULE line with "example_hooks" from
  93             <code>modules/examples/config.m4</code>.</li>
  94           <li>Replace the first argument "example_hooks" with <em>myexample</em>.</li>
  95           <li>Replace the second argument with brief description of your module.
  96             It will be used in <code>configure --help</code>.</li>
  97           <li>If your module needs additional C compiler flags, linker flags or
  98             libraries, add them to CFLAGS, LDFLAGS and LIBS accordingly.
  99             See other <code>config.m4</code> files in modules directory for
 100             examples.</li>
 101           <li>Add <code>APACHE_MODPATH_FINISH</code>.</li>
 102         </ol>
 103       </li>
 104
 105       <li>Create <code>module/new_module/Makefile.in</code>.
 106       If your module doesn't need special build instructions,
 107       all you need to have in that file is
 108       <code>include $(top_srcdir)/build/special.mk</code>.</li>
 109
 110       <li>Run ./buildconf from the top-level directory.</li>
 111
 112       <li>Build the server with --enable-myexample</li>
 113
 114     </ol>
 115 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 116 <div class="section">
 117 <h2><a name="using" id="using">Using the <code>mod_example_hooks</code> Module</a> <a title="Permanent link" href="#using" class="permalink">&para;</a></h2>
 118
 119     <p>To activate the example_hooks module, include a block similar to
 120     the following in your <code>httpd.conf</code> file:</p>
 121 <pre class="prettyprint lang-config">&lt;Location "/example-hooks-info"&gt;
 122    SetHandler example-hooks-handler
 123 &lt;/Location&gt;</pre>
 124
 125
 126     <p>As an alternative, you can put the following into a <a href="core.html#accessfilename"><code>.htaccess</code></a> file
 127     and then request the file "test.example" from that location:</p>
 128 <pre class="prettyprint lang-config">AddHandler example-hooks-handler .example</pre>
 129
 130
 131     <p>After reloading/restarting your server, you should be able
 132     to browse to this location and see the brief display mentioned
 133     earlier.</p>
 134 </div>
 135 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 136 <div class="directive-section"><h2><a name="Example" id="Example">Example</a> <a name="example" id="example">Directive</a> <a title="Permanent link" href="#example" class="permalink">&para;</a></h2>
 137 <table class="directive">
 138 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Demonstration directive to illustrate the Apache module
 139 API</td></tr>
 140 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Example</code></td></tr>
 141 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 142 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Options</td></tr>
 143 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
 144 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_example_hooks</td></tr>
 145 </table>
 146     <p>The <code class="directive">Example</code> directive just sets a demonstration
 147     flag which the example module's content handler displays. It
 148     takes no arguments. If you browse to an URL to which the
 149     example-hooks content-handler applies, you will get a display of the
 150     routines within the module and how and in what order they were
 151     called to service the document request. The effect of this
 152     directive one can observe under the point "<code>Example
 153     directive declared here: YES/NO</code>".</p>
 154
 155 </div>
 156 </div>
 157 <div class="bottomlang">
 158 <p><span>Available Languages: </span><a href="../en/mod/mod_example_hooks.html" title="English">&nbsp;en&nbsp;</a> |
 159 <a href="../fr/mod/mod_example_hooks.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a> |
 160 <a href="../ko/mod/mod_example_hooks.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
 161 </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>
 162 <script type="text/javascript"><!--//--><![CDATA[//><!--
 163 var comments_shortname = 'httpd';
 164 var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_example_hooks.html';
 165 (function(w, d) {
 166     if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
 167         d.write('<div id="comments_thread"><\/div>');
 168         var s = d.createElement('script');
 169         s.type = 'text/javascript';
 170         s.async = true;
 171         s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
 172         (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
 173     }
 174     else {
 175         d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
 176     }
 177 })(window, document);
 178 //--><!]]></script></div><div id="footer">
 179 <p class="apache">Copyright 2019 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>
 180 <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[//><!--
 181 if (typeof(prettyPrint) !== 'undefined') {
 182     prettyPrint();
 183 }
 184 //--><!]]></script>
 185 </body></html>