1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
|
<?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><!--
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
This file is generated from xml source: DO NOT EDIT
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
-->
<title>mod_isapi - 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" /></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.3</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.3</a> > <a href="./">Modules</a></div>
<div id="page-content">
<div id="preamble"><h1>Apache Module mod_isapi</h1>
<div class="toplang">
<p><span>Available Languages: </span><a href="../en/mod/mod_isapi.html" title="English"> en </a> |
<a href="../ko/mod/mod_isapi.html" hreflang="ko" rel="alternate" title="Korean"> ko </a></p>
</div>
<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>ISAPI Extensions within Apache for Windows</td></tr>
<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Base</td></tr>
<tr><th><a href="module-dict.html#ModuleIdentifier">Module�Identifier:</a></th><td>isapi_module</td></tr>
<tr><th><a href="module-dict.html#SourceFile">Source�File:</a></th><td>mod_isapi.c</td></tr>
<tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Win32 only</td></tr></table>
<h3>Summary</h3>
<p>This module implements the Internet Server extension API. It
allows Internet Server extensions (<em>e.g.</em> ISAPI .dll
modules) to be served by Apache for Windows, subject to the
noted restrictions.</p>
<p>ISAPI extension modules (.dll files) are written by third
parties. The Apache Group does not author these modules, so we
provide no support for them. Please contact the ISAPI's author
directly if you are experiencing problems running their ISAPI
extension. <strong>Please <em>do not</em> post such problems to
Apache's lists or bug reporting pages.</strong></p>
</div>
<div id="quickview"><h3 class="directives">Directives</h3>
<ul id="toc">
<li><img alt="" src="../images/down.gif" /> <a href="#isapiappendlogtoerrors">ISAPIAppendLogToErrors</a></li>
<li><img alt="" src="../images/down.gif" /> <a href="#isapiappendlogtoquery">ISAPIAppendLogToQuery</a></li>
<li><img alt="" src="../images/down.gif" /> <a href="#isapicachefile">ISAPICacheFile</a></li>
<li><img alt="" src="../images/down.gif" /> <a href="#isapifakeasync">ISAPIFakeAsync</a></li>
<li><img alt="" src="../images/down.gif" /> <a href="#isapilognotsupported">ISAPILogNotSupported</a></li>
<li><img alt="" src="../images/down.gif" /> <a href="#isapireadaheadbuffer">ISAPIReadAheadBuffer</a></li>
</ul>
<h3>Topics</h3>
<ul id="topics">
<li><img alt="" src="../images/down.gif" /> <a href="#usage">Usage</a></li>
<li><img alt="" src="../images/down.gif" /> <a href="#notes">Additional Notes</a></li>
<li><img alt="" src="../images/down.gif" /> <a href="#journal">Programmer's Journal</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="usage" id="usage">Usage</a></h2>
<p>In the server configuration file, use
the <code class="directive"><a href="../mod/mod_mime.html#addhandler">AddHandler</a></code> directive to
associate ISAPI files with the <code>isapi-handler</code> handler, and map
it to them with their file extensions. To enable any .dll file to be
processed as an ISAPI extension, edit the httpd.conf file and add the
following line:</p>
<div class="example"><p><code>
AddHandler isapi-handler .dll
</code></p></div>
<div class="note">In older versions of the Apache server,
<code>isapi-isa</code> was the proper handler name, rather than
<code>isapi-handler</code>. As of 2.3 development versions of the Apache
server, <code>isapi-isa</code> is no longer valid. You will need to
change your configuration to use <code>isapi-handler</code>
instead.</div>
<p>There is no capability within the Apache server to leave a
requested module loaded. However, you may preload and keep a
specific module loaded by using the following syntax in your
httpd.conf:</p>
<div class="example"><p><code>
ISAPICacheFile c:/WebWork/Scripts/ISAPI/mytest.dll
</code></p></div>
<p>Whether or not you have preloaded an ISAPI extension, all
ISAPI extensions are governed by the same permissions and
restrictions as CGI scripts. That is, <code class="directive"><a href="../mod/core.html#options">Options</a></code> <code>ExecCGI</code> must be set for the
directory that contains the ISAPI .dll file.</p>
<p>Review the <a href="#notes">Additional Notes</a> and the <a href="#journal">Programmer's Journal</a> for additional details
and clarification of the specific ISAPI support offered by
<code class="module"><a href="../mod/mod_isapi.html">mod_isapi</a></code>.</p>
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
<div class="section">
<h2><a name="notes" id="notes">Additional Notes</a></h2>
<p>Apache's ISAPI implementation conforms to all of the ISAPI
2.0 specification, except for some "Microsoft-specific"
extensions dealing with asynchronous I/O. Apache's I/O model
does not allow asynchronous reading and writing in a manner
that the ISAPI could access. If an ISA tries to access
unsupported features, including async I/O, a message is placed
in the error log to help with debugging. Since these messages
can become a flood, the directive <code>ISAPILogNotSupported
Off</code> exists to quiet this noise.</p>
<p>Some servers, like Microsoft IIS, load the ISAPI extension
into the server and keep it loaded until memory usage is too
high, or unless configuration options are specified. Apache
currently loads and unloads the ISAPI extension each time it is
requested, unless the <code class="directive"><a href="#isapicachefile">ISAPICacheFile</a></code> directive is specified.
This is inefficient, but Apache's memory model makes this the
most effective method. Many ISAPI modules are subtly
incompatible with the Apache server, and unloading these
modules helps to ensure the stability of the server.</p>
<p>Also, remember that while Apache supports ISAPI Extensions,
it <strong>does not support ISAPI Filters</strong>. Support for
filters may be added at a later date, but no support is planned
at this time.</p>
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
<div class="section">
<h2><a name="journal" id="journal">Programmer's Journal</a></h2>
<p>If you are programming Apache 2.0 <code class="module"><a href="../mod/mod_isapi.html">mod_isapi</a></code>
modules, you must limit your calls to <code>ServerSupportFunction</code>
to the following directives:</p>
<dl>
<dt><code>HSE_REQ_SEND_URL_REDIRECT_RESP</code></dt>
<dd>Redirect the user to another location.<br />
This must be a fully qualified URL (<em>e.g.</em>
<code>http://server/location</code>).</dd>
<dt><code>HSE_REQ_SEND_URL</code></dt>
<dd>Redirect the user to another location.<br />
This cannot be a fully qualified URL, you are not allowed to
pass the protocol or a server name (<em>e.g.</em> simply
<code>/location</code>).<br />
This redirection is handled by the server, not the
browser.<br />
<div class="warning"><h3>Warning</h3>
<p>In their recent documentation, Microsoft appears to have
abandoned the distinction between the two
<code>HSE_REQ_SEND_URL</code> functions. Apache continues to treat
them as two distinct functions with different requirements
and behaviors.</p>
</div></dd>
<dt><code>HSE_REQ_SEND_RESPONSE_HEADER</code></dt>
<dd>Apache accepts a response body following the header if it
follows the blank line (two consecutive newlines) in the
headers string argument. This body cannot contain NULLs,
since the headers argument is NULL terminated.</dd>
<dt><code>HSE_REQ_DONE_WITH_SESSION</code></dt>
<dd>Apache considers this a no-op, since the session will be
finished when the ISAPI returns from processing.</dd>
<dt><code>HSE_REQ_MAP_URL_TO_PATH</code></dt>
<dd>Apache will translate a virtual name to a physical
name.</dd>
<dt><code>HSE_APPEND_LOG_PARAMETER</code></dt>
<dd>
This logged message may be captured in any of the following
logs:
<ul>
<li>in the <code>\"%{isapi-parameter}n\"</code> component in a
<code class="directive"><a href="../mod/mod_log_config.html#customlog">CustomLog</a></code>
directive</li>
<li>in the <code>%q</code> log component with the
<code class="directive"><a href="#isapiappendlogtoquery">ISAPIAppendLogToQuery</a></code>
<code>On</code> directive</li>
<li>in the error log with the <code class="directive"><a href="#isapiappendlogtoerrors">ISAPIAppendLogToErrors</a></code> <code>On</code> directive</li>
</ul>
<p>The first option, the <code>%{isapi-parameter}n</code> component,
is always available and preferred.</p>
</dd>
<dt><code>HSE_REQ_IS_KEEP_CONN</code></dt>
<dd>Will return the negotiated Keep-Alive status.</dd>
<dt><code>HSE_REQ_SEND_RESPONSE_HEADER_EX</code></dt>
<dd>Will behave as documented, although the <code>fKeepConn</code>
flag is ignored.</dd>
<dt><code>HSE_REQ_IS_CONNECTED</code></dt>
<dd>Will report false if the request has been aborted.</dd>
</dl>
<p>Apache returns <code>FALSE</code> to any unsupported call to
<code>ServerSupportFunction</code>, and sets the
<code>GetLastError</code> value to
<code>ERROR_INVALID_PARAMETER</code>.</p>
<p><code>ReadClient</code> retrieves the request body exceeding the
initial buffer (defined by <code class="directive"><a href="#isapireadaheadbuffer">ISAPIReadAheadBuffer</a></code>). Based on the
<code class="directive">ISAPIReadAheadBuffer</code> setting (number of bytes
to buffer prior to calling the ISAPI handler) shorter requests are sent
complete to the extension when it is invoked. If the request is
longer, the ISAPI extension must use <code>ReadClient</code> to
retrieve the remaining request body.</p>
<p><code>WriteClient</code> is supported, but only with the
<code>HSE_IO_SYNC</code> flag or no option flag (value of
<code>0</code>). Any other <code>WriteClient</code> request
will be rejected with a return value of <code>FALSE</code>, and a
<code>GetLastError</code> value of
<code>ERROR_INVALID_PARAMETER</code>.</p>
<p><code>GetServerVariable</code> is supported, although extended server
variables do not exist (as defined by other servers.) All the
usual Apache CGI environment variables are available from
<code>GetServerVariable</code>, as well as the <code>ALL_HTTP</code>
and <code>ALL_RAW</code> values.</p>
<p>Apache 2.0 <code class="module"><a href="../mod/mod_isapi.html">mod_isapi</a></code> supports additional
features introduced in later versions of the ISAPI specification,
as well as limited emulation of async I/O and the
<code>TransmitFile</code> semantics. Apache also supports preloading
ISAPI .dlls for performance, neither of which were not available under
Apache 1.3 <code>mod_isapi</code>.</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="ISAPIAppendLogToErrors" id="ISAPIAppendLogToErrors">ISAPIAppendLogToErrors</a> <a name="isapiappendlogtoerrors" id="isapiappendlogtoerrors">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Record <code>HSE_APPEND_LOG_PARAMETER</code> requests from
ISAPI extensions to the error log</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ISAPIAppendLogToErrors on|off</code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ISAPIAppendLogToErrors off</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_isapi</td></tr>
</table>
<p>Record <code>HSE_APPEND_LOG_PARAMETER</code> requests from ISAPI
extensions to the server error log.</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="ISAPIAppendLogToQuery" id="ISAPIAppendLogToQuery">ISAPIAppendLogToQuery</a> <a name="isapiappendlogtoquery" id="isapiappendlogtoquery">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Record <code>HSE_APPEND_LOG_PARAMETER</code> requests from
ISAPI extensions to the query field</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ISAPIAppendLogToQuery on|off</code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ISAPIAppendLogToQuery on</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_isapi</td></tr>
</table>
<p>Record <code>HSE_APPEND_LOG_PARAMETER</code> requests from ISAPI
extensions to the query field (appended to the <code class="directive"><a href="../mod/mod_log_config.html#customlog">CustomLog</a></code> <code>%q</code>
component).</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="ISAPICacheFile" id="ISAPICacheFile">ISAPICacheFile</a> <a name="isapicachefile" id="isapicachefile">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>ISAPI .dll files to be loaded at startup</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ISAPICacheFile <var>file-path</var> [<var>file-path</var>]
...</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_isapi</td></tr>
</table>
<p>Specifies a space-separated list of file names to be loaded
when the Apache server is launched, and remain loaded until the
server is shut down. This directive may be repeated for every
ISAPI .dll file desired. The full path name of each file should
be specified. If the path name is not absolute, it will be treated
relative to <code class="directive"><a href="../mod/core.html#serverroot">ServerRoot</a></code>.</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="ISAPIFakeAsync" id="ISAPIFakeAsync">ISAPIFakeAsync</a> <a name="isapifakeasync" id="isapifakeasync">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Fake asynchronous support for ISAPI callbacks</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ISAPIFakeAsync on|off</code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ISAPIFakeAsync off</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_isapi</td></tr>
</table>
<p>While set to on, asynchronous support for ISAPI callbacks is
simulated.</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="ISAPILogNotSupported" id="ISAPILogNotSupported">ISAPILogNotSupported</a> <a name="isapilognotsupported" id="isapilognotsupported">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Log unsupported feature requests from ISAPI
extensions</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ISAPILogNotSupported on|off</code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ISAPILogNotSupported off</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_isapi</td></tr>
</table>
<p>Logs all requests for unsupported features from ISAPI
extensions in the server error log. This may help administrators
to track down problems. Once set to on and all desired ISAPI modules
are functioning, it should be set back to off.</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="ISAPIReadAheadBuffer" id="ISAPIReadAheadBuffer">ISAPIReadAheadBuffer</a> <a name="isapireadaheadbuffer" id="isapireadaheadbuffer">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Size of the Read Ahead Buffer sent to ISAPI
extensions</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ISAPIReadAheadBuffer <var>size</var></code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ISAPIReadAheadBuffer 49152</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_isapi</td></tr>
</table>
<p>Defines the maximum size of the Read Ahead Buffer sent to
ISAPI extensions when they are initially invoked. All remaining
data must be retrieved using the <code>ReadClient</code> callback; some
ISAPI extensions may not support the <code>ReadClient</code> function.
Refer questions to the ISAPI extension's author.</p>
</div>
</div>
<div class="bottomlang">
<p><span>Available Languages: </span><a href="../en/mod/mod_isapi.html" title="English"> en </a> |
<a href="../ko/mod/mod_isapi.html" hreflang="ko" rel="alternate" title="Korean"> ko </a></p>
</div><div id="footer">
<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>
<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>
|
