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