rubbos/app/apache2/manual/mod/mod_so.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_so - Apache HTTP Server</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" />
  12 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  13 <body>
  14 <div id="page-header">
  15 <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>
  16 <p class="apache">Apache HTTP Server Version 2.0</p>
  17 <img alt="" src="../images/feather.gif" /></div>
  18 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  19 <div id="path">
  20 <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.0</a> &gt; <a href="./">Modules</a></div>
  21 <div id="page-content">
  22 <div id="preamble"><h1>Apache Module mod_so</h1>
  23 <div class="toplang">
  24 <p><span>Available Languages: </span><a href="../en/mod/mod_so.html" title="English">&nbsp;en&nbsp;</a> |
  25 <a href="../ja/mod/mod_so.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
  26 <a href="../ko/mod/mod_so.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a> |
  27 <a href="../tr/mod/mod_so.html" hreflang="tr" rel="alternate" title="Türkçe">&nbsp;tr&nbsp;</a></p>
  28 </div>
  29 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Loading of executable code and
  30 modules into the server at start-up or restart time</td></tr>
  31 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  32 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>so_module</td></tr>
  33 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_so.c</td></tr>
  34 <tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>This is a Base module (always included) on
  35 Windows</td></tr></table>
  36 <h3>Summary</h3>
  37
  38
  39     <p>On selected operating systems this module can be used to
  40     load modules into Apache at runtime via the <a href="../dso.html">Dynamic Shared Object</a> (DSO) mechanism,
  41     rather than requiring a recompilation.</p>
  42
  43     <p>On Unix, the loaded code typically comes from shared object
  44     files (usually with <code>.so</code> extension), on Windows
  45     this may either the <code>.so</code> or <code>.dll</code>
  46     extension.</p>
  47
  48     <div class="warning"><h3>Warning</h3>
  49     <p>Apache 1.3 modules cannot be directly used
  50     with Apache 2.0 - the module must be modified to dynamically
  51     load or compile into Apache 2.0.</p>
  52     </div>
  53 </div>
  54 <div id="quickview"><h3 class="directives">Directives</h3>
  55 <ul id="toc">
  56 <li><img alt="" src="../images/down.gif" /> <a href="#loadfile">LoadFile</a></li>
  57 <li><img alt="" src="../images/down.gif" /> <a href="#loadmodule">LoadModule</a></li>
  58 </ul>
  59 <h3>Topics</h3>
  60 <ul id="topics">
  61 <li><img alt="" src="../images/down.gif" /> <a href="#windows">Creating Loadable Modules for Windows</a></li>
  62 </ul></div>
  63 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  64 <div class="section">
  65 <h2><a name="windows" id="windows">Creating Loadable Modules for Windows</a></h2>
  66
  67     <div class="note"><h3>Note</h3>
  68     <p>The module name format changed for Windows
  69     with Apache 1.3.15 and 2.0 - the modules are now named as
  70     mod_foo.so</p>
  71
  72     <p>While mod_so still loads modules with
  73     ApacheModuleFoo.dll names, the new naming convention is
  74     preferred; if you are converting your loadable module for 2.0,
  75     please fix the name to this 2.0 convention.</p></div>
  76
  77     <p>The Apache module API is unchanged between the Unix and
  78     Windows versions. Many modules will run on Windows with no or
  79     little change from Unix, although others rely on aspects of the
  80     Unix architecture which are not present in Windows, and will
  81     not work.</p>
  82
  83     <p>When a module does work, it can be added to the server in
  84     one of two ways. As with Unix, it can be compiled into the
  85     server. Because Apache for Windows does not have the
  86     <code>Configure</code> program of Apache for Unix, the module's
  87     source file must be added to the ApacheCore project file, and
  88     its symbols must be added to the
  89     <code>os\win32\modules.c</code> file.</p>
  90
  91     <p>The second way is to compile the module as a DLL, a shared
  92     library that can be loaded into the server at runtime, using
  93     the <code><code class="directive">LoadModule</code></code>
  94     directive. These module DLLs can be distributed and run on any
  95     Apache for Windows installation, without recompilation of the
  96     server.</p>
  97
  98     <p>To create a module DLL, a small change is necessary to the
  99     module's source file: The module record must be exported from
 100     the DLL (which will be created later; see below). To do this,
 101     add the <code>AP_MODULE_DECLARE_DATA</code> (defined in the
 102     Apache header files) to your module's module record definition.
 103     For example, if your module has:</p>
 104
 105 <div class="example"><p><code>
 106     module foo_module;
 107 </code></p></div>
 108
 109     <p>Replace the above with:</p>
 110 <div class="example"><p><code>
 111     module AP_MODULE_DECLARE_DATA foo_module;
 112 </code></p></div>
 113
 114     <p>Note that this will only be activated on Windows, so the
 115     module can continue to be used, unchanged, with Unix if needed.
 116     Also, if you are familiar with <code>.DEF</code> files, you can
 117     export the module record with that method instead.</p>
 118
 119     <p>Now, create a DLL containing your module. You will need to
 120     link this against the libhttpd.lib export library that is
 121     created when the libhttpd.dll shared library is compiled. You
 122     may also have to change the compiler settings to ensure that
 123     the Apache header files are correctly located. You can find
 124     this library in your server root's modules directory. It is
 125     best to grab an existing module .dsp file from the tree to
 126     assure the build environment is configured correctly, or
 127     alternately compare the compiler and link options to your
 128     .dsp.</p>
 129
 130     <p>This should create a DLL version of your module. Now simply
 131     place it in the <code>modules</code> directory of your server
 132     root, and use the <code class="directive">LoadModule</code>
 133     directive to load it.</p>
 134
 135 </div>
 136 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 137 <div class="directive-section"><h2><a name="LoadFile" id="LoadFile">LoadFile</a> <a name="loadfile" id="loadfile">Directive</a></h2>
 138 <table class="directive">
 139 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Link in the named object file or library</td></tr>
 140 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LoadFile <em>filename</em> [<em>filename</em>] ...</code></td></tr>
 141 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
 142 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 143 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_so</td></tr>
 144 </table>
 145
 146     <p>The LoadFile directive links in the named object files or
 147     libraries when the server is started or restarted; this is used
 148     to load additional code which may be required for some module
 149     to work. <em>Filename</em> is either an absolute path or
 150     relative to <a href="core.html#serverroot">ServerRoot</a>.</p>
 151
 152     <p>For example:</p>
 153
 154     <div class="example"><p><code>LoadFile libexec/libxmlparse.so</code></p></div>
 155
 156
 157 </div>
 158 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 159 <div class="directive-section"><h2><a name="LoadModule" id="LoadModule">LoadModule</a> <a name="loadmodule" id="loadmodule">Directive</a></h2>
 160 <table class="directive">
 161 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Links in the object file or library, and adds to the list
 162 of active modules</td></tr>
 163 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LoadModule <em>module filename</em></code></td></tr>
 164 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
 165 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 166 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_so</td></tr>
 167 </table>
 168     <p>The LoadModule directive links in the object file or library
 169     <em>filename</em> and adds the module structure named
 170     <em>module</em> to the list of active modules. <em>Module</em>
 171     is the name of the external variable of type
 172     <code>module</code> in the file, and is listed as the <a href="module-dict.html#ModuleIdentifier">Module Identifier</a>
 173     in the module documentation. Example:</p>
 174
 175     <div class="example"><p><code>
 176       LoadModule status_module modules/mod_status.so
 177     </code></p></div>
 178
 179     <p>loads the named module from the modules subdirectory of the
 180     ServerRoot.</p>
 181
 182 </div>
 183 </div>
 184 <div class="bottomlang">
 185 <p><span>Available Languages: </span><a href="../en/mod/mod_so.html" title="English">&nbsp;en&nbsp;</a> |
 186 <a href="../ja/mod/mod_so.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
 187 <a href="../ko/mod/mod_so.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a> |
 188 <a href="../tr/mod/mod_so.html" hreflang="tr" rel="alternate" title="Türkçe">&nbsp;tr&nbsp;</a></p>
 189 </div><div id="footer">
 190 <p class="apache">Copyright 2009 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>
 191 <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>
 192 </body></html>