manual/mod/mod_so.html

	mod_so.html revision 197983287252fbcd90647091be00349e05fae95f
6106N/A<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
6106N/A<HTML>
6106N/A<HEAD>
6106N/A<TITLE>Apache module mod_so</TITLE>
6106N/A</HEAD>
6106N/A
6106N/A<!-- Background white, links blue (unvisited), navy (visited), red (active) -->
6106N/A<BODY
6106N/A BGCOLOR="#FFFFFF"
6106N/A TEXT="#000000"
6106N/A LINK="#0000FF"
6106N/A VLINK="#000080"
6106N/A ALINK="#FF0000"
6106N/A>
6106N/A<!--#include virtual="header.html" -->
6106N/A<H1 ALIGN="CENTER">Module mod_so</H1>
6106N/A
6106N/A<p>This module provides for loading of executable code and modules into the
6106N/Aserver at start-up or restart time.</p>
6106N/A
6106N/A<P><A
6106N/AHREF="module-dict.html#Status"
6106N/AREL="Help"
6106N/A><STRONG>Status:</STRONG></A> Base (Windows); Experimental (Unix)
6106N/A<BR>
6106N/A<A
6106N/AHREF="module-dict.html#SourceFile"
6106N/AREL="Help"
6106N/A><STRONG>Source File:</STRONG></A> mod_so.c
6106N/A<BR>
6106N/A<A
6106N/AHREF="module-dict.html#ModuleIdentifier"
6106N/AREL="Help"
6106N/A><STRONG>Module Identifier:</STRONG></A> so_module
6106N/A<BR>
6106N/A<A
6137N/AHREF="module-dict.html#Compatibility"
6106N/AREL="Help"
6106N/A><STRONG>Compatibility:</STRONG></A> Available in Apache 1.3 and later.
6106N/A</P>
6137N/A
6137N/A
6137N/A<H2>Summary</H2>
6137N/A
6137N/A<p>This is an experimental module. On selected operating systems it
6137N/Acan be used to load modules into Apache at runtime via the <A
6137N/AHREF="/dso.html">Dynamic Shared Object</A> (DSO) mechanism, rather
6106N/Athan requiring a recompilation.
6106N/A
6106N/A<P>
6106N/AOn Unix, the loaded code typically comes from shared object files
6106N/A(usually with <SAMP>.so</SAMP> extension), whilst on Windows this
6106N/Amodule loads <SAMP>DLL</SAMP> files. This module is only available in
6106N/AApache 1.3 and up.
6106N/A
6106N/A
6106N/A<p>In previous releases, the functionality of this module was provided
6106N/Afor Unix by mod_dld, and for Windows by mod_dll. On Windows, mod_dll
6106N/Awas used in beta release 1.3b1 through 1.3b5. mod_so combines these
6106N/Atwo modules into a single module for all operating systems.
6106N/A
6106N/A<H2>Directives</H2>
6607N/A<UL>
6106N/A<LI><A HREF="#loadfile">LoadFile</A>
6106N/A<LI><A HREF="#loadmodule">LoadModule</A>
6106N/A</UL>
6106N/A
6106N/A<H2><A NAME="creating">Creating DLL Modules for Windows</A></H2>
6106N/A
6106N/A<P>The Apache module API is unchanged between the Unix and Windows
6106N/A   versions. Many modules will run on Windows with no or little change
6106N/A   from Unix, although others rely on aspects of the Unix architecture
6106N/A   which are not present in Windows, and will not work.</P>
6106N/A
6106N/A<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><A HREF="#loadmodule">LoadModule</A></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>MODULE_VAR_EXPORT</CODE> (defined in the Apache header files) to
   your module's module record definition. For example, if your module
   has:</P>
<PRE>
    module foo_module;
</PRE>
<P>Replace the above with:</P>
<PRE>
    module MODULE_VAR_EXPORT foo_module;
</PRE>
<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 ApacheCore.lib export library that is created when the
   ApacheCore.dll shared library is compiled. You may also have to change
   the compiler settings to ensure that the Apache header files are
   correctly located.</P>

<P>This should create a DLL version of your module. Now simply place it
   in the <SAMP>modules</SAMP> directory of your server root, and use
   the <CODE><A HREF="#loadmodule">LoadModule</A></CODE> directive to
   load it.</P>

<HR>

<H2><A NAME="loadfile">LoadFile</A> directive</H2>
<!--%plaintext &lt;?INDEX {\tt LoadFile} directive&gt; -->
<A
 HREF="directive-dict.html#Syntax"
 REL="Help"
><STRONG>Syntax:</STRONG></A> LoadFile <EM>filename filename ...</EM><BR>
<A
 HREF="directive-dict.html#Context"
 REL="Help"
><STRONG>Context:</STRONG></A> server config<BR>
<A
 HREF="directive-dict.html#Status"
 REL="Help"
><STRONG>Status:</STRONG></A> Base<BR>
<A
 HREF="directive-dict.html#Module"
 REL="Help"
><STRONG>Module:</STRONG></A> mod_so<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 and absolute path or relative to <A
HREF="core.html#serverroot">ServerRoot</A>.<P><HR>

<H2><A NAME="loadmodule">LoadModule</A> directive</H2>
<!--%plaintext &lt;?INDEX {\tt LoadModule} directive&gt; -->
<A
 HREF="directive-dict.html#Syntax"
 REL="Help"
><STRONG>Syntax:</STRONG></A> LoadModule <EM>module filename</EM><BR>
<A
 HREF="directive-dict.html#Context"
 REL="Help"
><STRONG>Context:</STRONG></A> server config<BR>
<A
 HREF="directive-dict.html#Status"
 REL="Help"
><STRONG>Status:</STRONG></A> Base<BR>
<A
 HREF="directive-dict.html#Module"
 REL="Help"
><STRONG>Module:</STRONG></A> mod_so<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. Example (Unix):
<BLOCKQUOTE><CODE>
LoadModule status_module modules/mod_status.so
</CODE></BLOCKQUOTE>

<P>

Example (Windows):
<BLOCKQUOTE><CODE>
LoadModule status_module modules/ApacheModuleStatus.dll<BR>
</CODE></BLOCKQUOTE>

loads the named module from the modules subdirectory of the
ServerRoot.<P>


<!--#include virtual="footer.html" -->
</BODY>
</HTML>