mirror of
https://github.com/apache/httpd.git
synced 2025-07-19 02:42:17 +03:00
5e8ac7dd19
git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@96159 13f79535-47bb-0310-9956-ffa450edef68
119 lines
8.2 KiB
Plaintext
119 lines
8.2 KiB
Plaintext
<html xmlns="http://www.w3.org/TR/xhtml1/strict"><head><!--
|
|
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
|
|
This file is generated from xml source: DO NOT EDIT
|
|
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
|
|
--><title>mod_so- Apache HTTP Server</title><link href="../style/manual.css" type="text/css" rel="stylesheet"/></head><body><blockquote><div align="center"><img src="../images/sub.gif" alt="[APACHE DOCUMENTATION]"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mod_so</h1><table cellspacing="1" cellpadding="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td nowrap="nowrap" valign="top"><span class="help">Description:</span></td><td>Loading of executable code and
|
|
modules into the server at start-up or restart time</td></tr><tr><td nowrap="nowrap"><a href="module-dict.html#Status" class="help">Status:</a></td><td>Base (Windows); Optional (Unix)</td></tr><tr><td nowrap="nowrap"><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>so_module</td></tr></table></td></tr></table><h2>Summary</h2>
|
|
|
|
<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>
|
|
|
|
<blockquote><table><tr><td bgcolor="#ffe5f5"><p align="center"><strong>Warning</strong></p>
|
|
<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>
|
|
</td></tr></table></blockquote>
|
|
<h2>Directives</h2><ul><li><a href="#loadfile">LoadFile</a></li><li><a href="#loadmodule">LoadModule</a></li></ul><h2>Creating Loadable Modules for Windows</h2>
|
|
|
|
<blockquote><table><tr><td bgcolor="#e0e5f5"><p align="center"><strong>Note</strong></p>
|
|
<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></td></tr></table></blockquote>
|
|
|
|
<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>
|
|
|
|
<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
|
|
module foo_module;
|
|
</code></td></tr></table></blockquote>
|
|
|
|
<p>Replace the above with:</p>
|
|
<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
|
|
module AP_MODULE_DECLARE_DATA foo_module;
|
|
</code></td></tr></table></blockquote>
|
|
|
|
<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>
|
|
|
|
<hr/><h2><a name="LoadFile">LoadFile</a> <a name="loadfile">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td nowrap="nowrap"><strong>Description: </strong></td><td>Link in the named object file or library</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>LoadFile <em>filename</em> [<em>filename</em>] ...</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base (Windows); Optional (Unix)</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_so</td></tr></table></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>
|
|
|
|
<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>LoadFile libexex/libxmlparse.so</code></td></tr></table></blockquote>
|
|
|
|
<hr/><h2><a name="LoadModule">LoadModule</a> <a name="loadmodule">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td nowrap="nowrap"><strong>Description: </strong></td><td>Links in the object file or library, and adds to the list
|
|
of active modules</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>LoadModule <em>module filename</em></td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base (Windows); Optional (Unix)</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_so</td></tr></table></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>
|
|
|
|
<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
|
|
LoadModule status_module modules/mod_status.so
|
|
</code></td></tr></table></blockquote>
|
|
|
|
<p>loads the named module from the modules subdirectory of the
|
|
ServerRoot.</p>
|
|
<hr/></blockquote><h3 align="center">Apache HTTP Server Version 2.0</h3><a href="./"><img src="../images/index.gif" alt="Index"/></a><a href="../"><img src="../images/home.gif" alt="Home"/></a></body></html> |