| <?xml version="1.0" encoding="ISO-8859-1"?> |
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head> |
| <meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type" /> |
| <meta content="noindex, nofollow" name="robots" /> |
| <!-- |
| XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
| This file is generated from xml source: DO NOT EDIT |
| XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
| --> |
| <title>mod_so - Apache HTTP Server</title> |
| <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" /> |
| <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" /> |
| <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" /> |
| <link href="../images/favicon.ico" rel="shortcut icon" /><link href="http://httpd.apache.org/docs/current/mod/mod_so.html" rel="canonical" /></head> |
| <body> |
| <div id="page-header"> |
| <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p> |
| <p class="apache">Apache HTTP Server Version 2.0</p> |
| <img alt="" src="../images/feather.gif" /></div> |
| <div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div> |
| <div id="path"> |
| <a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs/">Documentation</a> > <a href="../">Version 2.0</a> > <a href="./">Modules</a></div> |
| <div id="page-content"> |
| <div class="retired"><h4>Please note</h4> |
| <p>This document refers to the <strong>2.0</strong> version of Apache httpd, which <strong>is no longer maintained</strong>. Upgrade, and refer to the current version of httpd instead, documented at:</p> |
| <ul><li><a href="http://httpd.apache.org/docs/current/">Current release version of Apache HTTP Server documentation</a></li></ul><p>You may follow <a href="http://httpd.apache.org/docs/current/mod/mod_so.html">this link</a> to go to the current version of this document.</p></div><div id="preamble"><h1>Apache Module mod_so</h1> |
| <div class="toplang"> |
| <p><span>Available Languages: </span><a href="../en/mod/mod_so.html" title="English"> en </a> | |
| <a href="../ja/mod/mod_so.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> | |
| <a href="../ko/mod/mod_so.html" hreflang="ko" rel="alternate" title="Korean"> ko </a> | |
| <a href="../tr/mod/mod_so.html" hreflang="tr" rel="alternate" title="Türkçe"> tr </a></p> |
| </div> |
| <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Loading of executable code and |
| modules into the server at start-up or restart time</td></tr> |
| <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr> |
| <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>so_module</td></tr> |
| <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_so.c</td></tr> |
| <tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>This is a Base module (always included) on |
| Windows</td></tr></table> |
| <h3>Summary</h3> |
| |
| |
| <p>On selected operating systems this module can be used to |
| load modules into Apache at runtime via the <a href="../dso.html">Dynamic Shared Object</a> (DSO) mechanism, |
| rather than requiring a recompilation.</p> |
| |
| <p>On Unix, the loaded code typically comes from shared object |
| files (usually with <code>.so</code> extension), on Windows |
| this may either the <code>.so</code> or <code>.dll</code> |
| extension.</p> |
| |
| <div class="warning"><h3>Warning</h3> |
| <p>Apache 1.3 modules cannot be directly used |
| with Apache 2.0 - the module must be modified to dynamically |
| load or compile into Apache 2.0.</p> |
| </div> |
| </div> |
| <div id="quickview"><h3 class="directives">Directives</h3> |
| <ul id="toc"> |
| <li><img alt="" src="../images/down.gif" /> <a href="#loadfile">LoadFile</a></li> |
| <li><img alt="" src="../images/down.gif" /> <a href="#loadmodule">LoadModule</a></li> |
| </ul> |
| <h3>Topics</h3> |
| <ul id="topics"> |
| <li><img alt="" src="../images/down.gif" /> <a href="#windows">Creating Loadable Modules for Windows</a></li> |
| </ul></div> |
| <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> |
| <div class="section"> |
| <h2><a name="windows" id="windows">Creating Loadable Modules for Windows</a></h2> |
| |
| <div class="note"><h3>Note</h3> |
| <p>The module name format changed for Windows |
| with Apache 1.3.15 and 2.0 - the modules are now named as |
| mod_foo.so</p> |
| |
| <p>While mod_so still loads modules with |
| ApacheModuleFoo.dll names, the new naming convention is |
| preferred; if you are converting your loadable module for 2.0, |
| please fix the name to this 2.0 convention.</p></div> |
| |
| <p>The Apache module API is unchanged between the Unix and |
| Windows versions. Many modules will run on Windows with no or |
| little change from Unix, although others rely on aspects of the |
| Unix architecture which are not present in Windows, and will |
| not work.</p> |
| |
| <p>When a module does work, it can be added to the server in |
| one of two ways. As with Unix, it can be compiled into the |
| server. Because Apache for Windows does not have the |
| <code>Configure</code> program of Apache for Unix, the module's |
| source file must be added to the ApacheCore project file, and |
| its symbols must be added to the |
| <code>os\win32\modules.c</code> file.</p> |
| |
| <p>The second way is to compile the module as a DLL, a shared |
| library that can be loaded into the server at runtime, using |
| the <code><code class="directive">LoadModule</code></code> |
| directive. These module DLLs can be distributed and run on any |
| Apache for Windows installation, without recompilation of the |
| server.</p> |
| |
| <p>To create a module DLL, a small change is necessary to the |
| module's source file: The module record must be exported from |
| the DLL (which will be created later; see below). To do this, |
| add the <code>AP_MODULE_DECLARE_DATA</code> (defined in the |
| Apache header files) to your module's module record definition. |
| For example, if your module has:</p> |
| |
| <div class="example"><p><code> |
| module foo_module; |
| </code></p></div> |
| |
| <p>Replace the above with:</p> |
| <div class="example"><p><code> |
| module AP_MODULE_DECLARE_DATA foo_module; |
| </code></p></div> |
| |
| <p>Note that this will only be activated on Windows, so the |
| module can continue to be used, unchanged, with Unix if needed. |
| Also, if you are familiar with <code>.DEF</code> files, you can |
| export the module record with that method instead.</p> |
| |
| <p>Now, create a DLL containing your module. You will need to |
| link this against the libhttpd.lib export library that is |
| created when the libhttpd.dll shared library is compiled. You |
| may also have to change the compiler settings to ensure that |
| the Apache header files are correctly located. You can find |
| this library in your server root's modules directory. It is |
| best to grab an existing module .dsp file from the tree to |
| assure the build environment is configured correctly, or |
| alternately compare the compiler and link options to your |
| .dsp.</p> |
| |
| <p>This should create a DLL version of your module. Now simply |
| place it in the <code>modules</code> directory of your server |
| root, and use the <code class="directive">LoadModule</code> |
| directive to load it.</p> |
| |
| </div> |
| <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> |
| <div class="directive-section"><h2><a name="LoadFile" id="LoadFile">LoadFile</a> <a name="loadfile" id="loadfile">Directive</a></h2> |
| <table class="directive"> |
| <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Link in the named object file or library</td></tr> |
| <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LoadFile <em>filename</em> [<em>filename</em>] ...</code></td></tr> |
| <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr> |
| <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr> |
| <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_so</td></tr> |
| </table> |
| |
| <p>The LoadFile directive links in the named object files or |
| libraries when the server is started or restarted; this is used |
| to load additional code which may be required for some module |
| to work. <em>Filename</em> is either an absolute path or |
| relative to <a href="core.html#serverroot">ServerRoot</a>.</p> |
| |
| <p>For example:</p> |
| |
| <div class="example"><p><code>LoadFile libexec/libxmlparse.so</code></p></div> |
| |
| |
| </div> |
| <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> |
| <div class="directive-section"><h2><a name="LoadModule" id="LoadModule">LoadModule</a> <a name="loadmodule" id="loadmodule">Directive</a></h2> |
| <table class="directive"> |
| <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Links in the object file or library, and adds to the list |
| of active modules</td></tr> |
| <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LoadModule <em>module filename</em></code></td></tr> |
| <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr> |
| <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr> |
| <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_so</td></tr> |
| </table> |
| <p>The LoadModule directive links in the object file or library |
| <em>filename</em> and adds the module structure named |
| <em>module</em> to the list of active modules. <em>Module</em> |
| is the name of the external variable of type |
| <code>module</code> in the file, and is listed as the <a href="module-dict.html#ModuleIdentifier">Module Identifier</a> |
| in the module documentation. Example:</p> |
| |
| <div class="example"><p><code> |
| LoadModule status_module modules/mod_status.so |
| </code></p></div> |
| |
| <p>loads the named module from the modules subdirectory of the |
| ServerRoot.</p> |
| |
| </div> |
| </div> |
| <div class="bottomlang"> |
| <p><span>Available Languages: </span><a href="../en/mod/mod_so.html" title="English"> en </a> | |
| <a href="../ja/mod/mod_so.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> | |
| <a href="../ko/mod/mod_so.html" hreflang="ko" rel="alternate" title="Korean"> ko </a> | |
| <a href="../tr/mod/mod_so.html" hreflang="tr" rel="alternate" title="Türkçe"> tr </a></p> |
| </div><div id="footer"> |
| <p class="apache">Copyright 2013 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> |
| <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div> |
| </body></html> |
