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="http://httpd.apache.org/dev/dist/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">Open bugs</a></li></ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
  64 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  65 <div class="section">
  66 <h2><a name="compiling" id="compiling">Compiling the example_hooks module</a></h2>
  67
  68     <p>To include the example_hooks module in your server, follow the
  69     steps below:</p>
  70
  71     <ol>
  72       <li>
  73         Run <code class="program"><a href="../programs/configure.html">configure</a></code> with <code>--enable-example-hooks</code>
  74         option.</li>
  75
  76       <li>Make the server (run "<code>make</code>").</li>
  77     </ol>
  78
  79     <p>To add another module of your own:</p>
  80
  81     <ol class="up-A">
  82       <li><code>cp modules/examples/mod_example_hooks.c
  83       modules/new_module/<em>mod_myexample.c</em></code></li>
  84
  85       <li>Modify the file.</li>
  86
  87       <li>Create <code>modules/new_module/config.m4</code>.
  88         <ol>
  89           <li>Add <code>APACHE_MODPATH_INIT(new_module)</code>.</li>
  90           <li>Copy APACHE_MODULE line with "example_hooks" from
  91             <code>modules/examples/config.m4</code>.</li>
  92           <li>Replace the first argument "example_hooks" with <em>myexample</em>.</li>
  93           <li>Replace the second argument with brief description of your module.
  94             It will be used in <code>configure --help</code>.</li>
  95           <li>If your module needs additional C compiler flags, linker flags or
  96             libraries, add them to CFLAGS, LDFLAGS and LIBS accordingly.
  97             See other <code>config.m4</code> files in modules directory for
  98             examples.</li>
  99           <li>Add <code>APACHE_MODPATH_FINISH</code>.</li>
 100         </ol>
 101       </li>
 102
 103       <li>Create <code>module/new_module/Makefile.in</code>.
 104       If your module doesn't need special build instructions,
 105       all you need to have in that file is
 106       <code>include $(top_srcdir)/build/special.mk</code>.</li>
 107
 108       <li>Run ./buildconf from the top-level directory.</li>
 109
 110       <li>Build the server with --enable-myexample</li>
 111
 112     </ol>
 113 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 114 <div class="section">
 115 <h2><a name="using" id="using">Using the <code>mod_example_hooks</code> Module</a></h2>
 116
 117     <p>To activate the example_hooks module, include a block similar to
 118     the following in your <code>httpd.conf</code> file:</p>
 119 <pre class="prettyprint lang-config">&lt;Location "/example-hooks-info"&gt;
 120    SetHandler example-hooks-handler
 121 &lt;/Location&gt;</pre>
 122
 123
 124     <p>As an alternative, you can put the following into a <a href="core.html#accessfilename"><code>.htaccess</code></a> file
 125     and then request the file "test.example" from that location:</p>
 126 <pre class="prettyprint lang-config">AddHandler example-hooks-handler .example</pre>
 127
 128
 129     <p>After reloading/restarting your server, you should be able
 130     to browse to this location and see the brief display mentioned
 131     earlier.</p>
 132 </div>
 133 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 134 <div class="directive-section"><h2><a name="Example" id="Example">Example</a> <a name="example" id="example">Directive</a></h2>
 135 <table class="directive">
 136 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Demonstration directive to illustrate the Apache module
 137 API</td></tr>
 138 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Example</code></td></tr>
 139 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 140 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
 141 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_example_hooks</td></tr>
 142 </table>
 143     <p>The <code class="directive">Example</code> directive just sets a demonstration
 144     flag which the example module's content handler displays. It
 145     takes no arguments. If you browse to an URL to which the
 146     example-hooks content-handler applies, you will get a display of the
 147     routines within the module and how and in what order they were
 148     called to service the document request. The effect of this
 149     directive one can observe under the point "<code>Example
 150     directive declared here: YES/NO</code>".</p>
 151
 152 </div>
 153 </div>
 154 <div class="bottomlang">
 155 <p><span>Available Languages: </span><a href="../en/mod/mod_example_hooks.html" title="English">&nbsp;en&nbsp;</a> |
 156 <a href="../fr/mod/mod_example_hooks.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a> |
 157 <a href="../ko/mod/mod_example_hooks.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
 158 </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>
 159 <script type="text/javascript"><!--//--><![CDATA[//><!--
 160 var comments_shortname = 'httpd';
 161 var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_example_hooks.html';
 162 (function(w, d) {
 163     if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
 164         d.write('<div id="comments_thread"><\/div>');
 165         var s = d.createElement('script');
 166         s.type = 'text/javascript';
 167         s.async = true;
 168         s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
 169         (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
 170     }
 171     else {
 172         d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
 173     }
 174 })(window, document);
 175 //--><!]]></script></div><div id="footer">
 176 <p class="apache">Copyright 2016 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>
 177 <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[//><!--
 178 if (typeof(prettyPrint) !== 'undefined') {
 179     prettyPrint();
 180 }
 181 //--><!]]></script>
 182 </body></html>