From 27cdd9f4849a45f6069e1b6563b08f880d2e4f34 Mon Sep 17 00:00:00 2001 From: Andre Malo Date: Sat, 16 Nov 2002 02:20:35 +0000 Subject: [PATCH] - -> - add markup - fix contextlist of ISAPIReadAheadBuffer -> update transformation git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@97538 13f79535-47bb-0310-9956-ffa450edef68 --- docs/manual/mod/mod_isapi.html.en | 167 ++++++++++---------- docs/manual/mod/mod_isapi.xml | 204 ++++++++++++------------- docs/manual/mod/quickreference.html.en | 15 +- 3 files changed, 191 insertions(+), 195 deletions(-) diff --git a/docs/manual/mod/mod_isapi.html.en b/docs/manual/mod/mod_isapi.html.en index fab91e7c29..91a88d06bd 100644 --- a/docs/manual/mod/mod_isapi.html.en +++ b/docs/manual/mod/mod_isapi.html.en @@ -49,13 +49,12 @@

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, Options - ExecCGI must be set for the directory that contains the - ISAPI .dll file.

+ restrictions as CGI scripts. That is, Options ExecCGI must be set for the + directory that contains the ISAPI .dll file.

Review the Additional Notes and the Programmer's Journal for additional details and clarification of the specific ISAPI support offered by - mod_isapi.

+ mod_isapi.

top

Additional Notes

Apache's ISAPI implementation conforms to all of the ISAPI @@ -72,149 +71,148 @@ 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 ISAPICacheFile directive is specified. + requested, unless the ISAPICacheFile 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.

Also, remember that while Apache supports ISAPI Extensions, - it does not support ISAPI Filters. Support for + it does not support ISAPI Filters. Support for filters may be added at a later date, but no support is planned at this time.

top

Programmer's Journal

If you are programming Apache 2.0 mod_isapi - modules, you must limit your calls to ServerSupportFunction to the - following directives:

+ modules, you must limit your calls to ServerSupportFunction + to the following directives:

-
HSE_REQ_SEND_URL_REDIRECT_RESP
- +
HSE_REQ_SEND_URL_REDIRECT_RESP
Redirect the user to another location.
- This must be a fully qualified URL (e.g. - http://server/location).
- -
HSE_REQ_SEND_URL
+ This must be a fully qualified URL (e.g. + http://server/location). +
HSE_REQ_SEND_URL
Redirect the user to another location.
- This cannot be a fully qualified URL, you are not allowed to - pass the protocol or a server name (e.g. simply - /location).
- This redirection is handled by the server, not the + This cannot be a fully qualified URL, you are not allowed to + pass the protocol or a server name (e.g. simply + /location).
+ This redirection is handled by the server, not the browser.
- Warning: in their recent documentation, - Microsoft appears to have abandoned the distinction between - the two HSE_REQ_SEND_URL functions. Apache continues to treat - them as two distinct functions with different requirements - and behaviors.
- -
HSE_REQ_SEND_RESPONSE_HEADER
- +

Warning

+

In their recent documentation, Microsoft appears to have + abandoned the distinction between the two + HSE_REQ_SEND_URL functions. Apache continues to treat + them as two distinct functions with different requirements + and behaviors.

+
+ +
HSE_REQ_SEND_RESPONSE_HEADER
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.
-
HSE_REQ_DONE_WITH_SESSION
- +
HSE_REQ_DONE_WITH_SESSION
Apache considers this a no-op, since the session will be finished when the ISAPI returns from processing.
-
HSE_REQ_MAP_URL_TO_PATH
- +
HSE_REQ_MAP_URL_TO_PATH
Apache will translate a virtual name to a physical name.
-
HSE_APPEND_LOG_PARAMETER
- +
HSE_APPEND_LOG_PARAMETER
This logged message may be captured in any of the following logs:
    -
  • in the \"%{isapi-parameter}n\" component in a - CustomLog directive
    • +
  • in the \"%{isapi-parameter}n\" component in a + CustomLog + directive
    • -
  • in the %q log component with the - ISAPIAppendLogToQuery On directive
    • +
  • in the %q log component with the + ISAPIAppendLogToQuery + On directive
    • -
  • in the error log with the ISAPIAppendLogToErrors On - directive
    • +
  • in the error log with the ISAPIAppendLogToErrors On directive
- The first option, the %{isapi-parameter}n component, is - always available and prefered. -
-
HSE_REQ_IS_KEEP_CONN
+

The first option, the %{isapi-parameter}n component, + is always available and preferred.

+ +
HSE_REQ_IS_KEEP_CONN
Will return the negotiated Keep-Alive status.
-
HSE_REQ_SEND_RESPONSE_HEADER_EX
- -
Will behave as documented, although the fKeepConn flag is - ignored.
- -
HSE_REQ_IS_CONNECTED
+
HSE_REQ_SEND_RESPONSE_HEADER_EX
+
Will behave as documented, although the fKeepConn + flag is ignored.
+
HSE_REQ_IS_CONNECTED
Will report false if the request has been aborted.
-

Apache returns FALSE to any unsupported call to - ServerSupportFunction, and sets the GetLastError value to - ERROR_INVALID_PARAMETER.

+

Apache returns FALSE to any unsupported call to + ServerSupportFunction, and sets the + GetLastError value to + ERROR_INVALID_PARAMETER.

-

ReadClient retrieves the request body exceeding the initial - buffer (defined by ISAPIReadAheadBuffer). Based on the - ISAPIReadAheadBuffer setting (number of bytes to buffer prior - to calling the ISAPI handler) shorter requests are sent +

ReadClient retrieves the request body exceeding the + initial buffer (defined by ISAPIReadAheadBuffer). Based on the + ISAPIReadAheadBuffer 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 ReadClient to retrieve the - remaining request body.

+ longer, the ISAPI extension must use ReadClient to + retrieve the remaining request body.

-

WriteClient is supported, but only with the HSE_IO_SYNC flag - or no option flag (value of 0). Any other WriteClient request - will be rejected with a return value of FALSE, and a - GetLastError value of ERROR_INVALID_PARAMETER.

+

WriteClient is supported, but only with the + HSE_IO_SYNC flag or no option flag (value of + 0). Any other WriteClient request + will be rejected with a return value of FALSE, and a + GetLastError value of + ERROR_INVALID_PARAMETER.

-

GetServerVariable is supported, although extended server +

GetServerVariable is supported, although extended server variables do not exist (as defined by other servers.) All the usual Apache CGI environment variables are available from - GetServerVariable, as well as the ALL_HTTP and ALL_RAW - values.

+ GetServerVariable, as well as the ALL_HTTP + and ALL_RAW values.

Apache 2.0 mod_isapi supports additional features introduced in later versions of the ISAPI specification, - as well as limited emulation of async I/O and the TransmitFile - semantics. Apache also supports preloading ISAPI .dlls for - performance, neither of which were not available under Apache 1.3 - mod_isapi.

+ as well as limited emulation of async I/O and the + TransmitFile semantics. Apache also supports preloading + ISAPI .dlls for performance, neither of which were not available under + Apache 1.3 mod_isapi.

top

ISAPIAppendLogToErrors Directive

Description: - Record HSE_APPEND_LOG_PARAMETER requests from ISAPI -extensions to the error log
Syntax: + Record HSE_APPEND_LOG_PARAMETER requests from +ISAPI extensions to the error log
Syntax: ISAPIAppendLogToErrors on|off
Default: ISAPIAppendLogToErrors off
Context: server config, virtual host, directory, .htaccess
Override: FileInfo
Status: Base
Module: mod_isapi
-

Record HSE_APPEND_LOG_PARAMETER requests from ISAPI +

Record HSE_APPEND_LOG_PARAMETER requests from ISAPI extensions to the server error log.

top

ISAPIAppendLogToQuery Directive

Description: - Record HSE_APPEND_LOG_PARAMETER requests from ISAPI -extensions to the query field
Syntax: + Record HSE_APPEND_LOG_PARAMETER requests from +ISAPI extensions to the query field
Syntax: ISAPIAppendLogToQuery on|off
Default: ISAPIAppendLogToQuery on
Context: server config, virtual host, directory, .htaccess
Override: FileInfo
Status: Base
Module: mod_isapi
-

Record HSE_APPEND_LOG_PARAMETER requests from ISAPI - extensions to the query field (appended to the CustomLog %q +

Record HSE_APPEND_LOG_PARAMETER requests from ISAPI + extensions to the query field (appended to the CustomLog %q component).

top

ISAPICacheFile Directive

Description: ISAPI .dll files to be loaded at startup
Syntax: - ISAPICacheFile file-path [file-path] ...
Context: + ISAPICacheFile file-path [file-path] +...
Context: server config, virtual host
Status: Base
Module: mod_isapi
@@ -222,16 +220,17 @@ extensions to the query fieldServerRoot.

top

ISAPIFakeAsync Directive

Description: - Fake asynchronous support for isapi callbacks
Syntax: + Fake asynchronous support for ISAPI callbacks
Syntax: ISAPIFakeAsync on|off
Default: ISAPIFakeAsync off
Context: server config, virtual host, directory, .htaccess
Override: FileInfo
Status: Base
Module: mod_isapi
-

While set to on, asynchronous support for isapi callbacks is +

While set to on, asynchronous support for ISAPI callbacks is simulated.

top

ISAPILogNotSupported Directive

indexing - - - - + + + + -
Description: Log unsupported feature requests from ISAPI @@ -249,15 +248,15 @@ extensions
Syntax:
top

ISAPIReadAheadBuffer Directive

Description: Size of the Read Ahead Buffer sent to ISAPI extensions
Syntax: - ISAPIReadAheadBuffer size
Default: + ISAPIReadAheadBuffer size
Default: ISAPIReadAheadBuffer 49152
Context: - server config, directory, .htaccess
Override: + server config, virtual host, directory, .htaccess
Override: FileInfo
Status: Base
Module: mod_isapi

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 ReadClient callback; some - ISAPI extensions may not support the ReadClient function. Refer - questions to the ISAPI extension's author.

+ data must be retrieved using the ReadClient callback; some + ISAPI extensions may not support the ReadClient function. + Refer questions to the ISAPI extension's author.

\ No newline at end of file diff --git a/docs/manual/mod/mod_isapi.xml b/docs/manual/mod/mod_isapi.xml index 4202f8bd01..f6f026f907 100644 --- a/docs/manual/mod/mod_isapi.xml +++ b/docs/manual/mod/mod_isapi.xml @@ -46,14 +46,14 @@

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, Options - ExecCGI must be set for the directory that contains the - ISAPI .dll file.

+ restrictions as CGI scripts. That is, Options ExecCGI must be set for the + directory that contains the ISAPI .dll file.

Review the Additional Notes and the Programmer's Journal for additional details and clarification of the specific ISAPI support offered by - mod_isapi.

+ mod_isapi.

Additional Notes @@ -72,14 +72,15 @@ 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 ISAPICacheFile directive is specified. + requested, unless the ISAPICacheFile 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.

Also, remember that while Apache supports ISAPI Extensions, - it does not support ISAPI Filters. Support for + it does not support ISAPI Filters. Support for filters may be added at a later date, but no support is planned at this time.

@@ -87,125 +88,127 @@
Programmer's Journal

If you are programming Apache 2.0 mod_isapi - modules, you must limit your calls to ServerSupportFunction to the - following directives:

+ modules, you must limit your calls to ServerSupportFunction + to the following directives:

-
HSE_REQ_SEND_URL_REDIRECT_RESP
- +
HSE_REQ_SEND_URL_REDIRECT_RESP
Redirect the user to another location.
- This must be a fully qualified URL (e.g. - http://server/location).
- -
HSE_REQ_SEND_URL
+ This must be a fully qualified URL (e.g. + http://server/location). +
HSE_REQ_SEND_URL
Redirect the user to another location.
- This cannot be a fully qualified URL, you are not allowed to - pass the protocol or a server name (e.g. simply - /location).
- This redirection is handled by the server, not the + This cannot be a fully qualified URL, you are not allowed to + pass the protocol or a server name (e.g. simply + /location).
+ This redirection is handled by the server, not the browser.
- Warning: in their recent documentation, - Microsoft appears to have abandoned the distinction between - the two HSE_REQ_SEND_URL functions. Apache continues to treat - them as two distinct functions with different requirements - and behaviors.
- -
HSE_REQ_SEND_RESPONSE_HEADER
- + Warning +

In their recent documentation, Microsoft appears to have + abandoned the distinction between the two + HSE_REQ_SEND_URL functions. Apache continues to treat + them as two distinct functions with different requirements + and behaviors.

+ + +
HSE_REQ_SEND_RESPONSE_HEADER
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.
-
HSE_REQ_DONE_WITH_SESSION
- +
HSE_REQ_DONE_WITH_SESSION
Apache considers this a no-op, since the session will be finished when the ISAPI returns from processing.
-
HSE_REQ_MAP_URL_TO_PATH
- +
HSE_REQ_MAP_URL_TO_PATH
Apache will translate a virtual name to a physical name.
-
HSE_APPEND_LOG_PARAMETER
- +
HSE_APPEND_LOG_PARAMETER
This logged message may be captured in any of the following logs:
    -
  • in the \"%{isapi-parameter}n\" component in a - CustomLog directive
    • +
  • in the \"%{isapi-parameter}n\" component in a + CustomLog + directive
    • -
  • in the %q log component with the - ISAPIAppendLogToQuery On directive
    • +
  • in the %q log component with the + ISAPIAppendLogToQuery + On directive
    • -
  • in the error log with the ISAPIAppendLogToErrors On - directive
    • +
  • in the error log with the ISAPIAppendLogToErrors On directive
- The first option, the %{isapi-parameter}n component, is - always available and prefered. -
-
HSE_REQ_IS_KEEP_CONN
+

The first option, the %{isapi-parameter}n component, + is always available and preferred.

+ +
HSE_REQ_IS_KEEP_CONN
Will return the negotiated Keep-Alive status.
-
HSE_REQ_SEND_RESPONSE_HEADER_EX
- -
Will behave as documented, although the fKeepConn flag is - ignored.
- -
HSE_REQ_IS_CONNECTED
+
HSE_REQ_SEND_RESPONSE_HEADER_EX
+
Will behave as documented, although the fKeepConn + flag is ignored.
+
HSE_REQ_IS_CONNECTED
Will report false if the request has been aborted.
-

Apache returns FALSE to any unsupported call to - ServerSupportFunction, and sets the GetLastError value to - ERROR_INVALID_PARAMETER.

+

Apache returns FALSE to any unsupported call to + ServerSupportFunction, and sets the + GetLastError value to + ERROR_INVALID_PARAMETER.

-

ReadClient retrieves the request body exceeding the initial - buffer (defined by ISAPIReadAheadBuffer). Based on the - ISAPIReadAheadBuffer setting (number of bytes to buffer prior - to calling the ISAPI handler) shorter requests are sent +

ReadClient retrieves the request body exceeding the + initial buffer (defined by ISAPIReadAheadBuffer). Based on the + ISAPIReadAheadBuffer 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 ReadClient to retrieve the - remaining request body.

+ longer, the ISAPI extension must use ReadClient to + retrieve the remaining request body.

-

WriteClient is supported, but only with the HSE_IO_SYNC flag - or no option flag (value of 0). Any other WriteClient request - will be rejected with a return value of FALSE, and a - GetLastError value of ERROR_INVALID_PARAMETER.

+

WriteClient is supported, but only with the + HSE_IO_SYNC flag or no option flag (value of + 0). Any other WriteClient request + will be rejected with a return value of FALSE, and a + GetLastError value of + ERROR_INVALID_PARAMETER.

-

GetServerVariable is supported, although extended server +

GetServerVariable is supported, although extended server variables do not exist (as defined by other servers.) All the usual Apache CGI environment variables are available from - GetServerVariable, as well as the ALL_HTTP and ALL_RAW - values.

+ GetServerVariable, as well as the ALL_HTTP + and ALL_RAW values.

Apache 2.0 mod_isapi supports additional features introduced in later versions of the ISAPI specification, - as well as limited emulation of async I/O and the TransmitFile - semantics. Apache also supports preloading ISAPI .dlls for - performance, neither of which were not available under Apache 1.3 - mod_isapi.

+ as well as limited emulation of async I/O and the + TransmitFile semantics. Apache also supports preloading + ISAPI .dlls for performance, neither of which were not available under + Apache 1.3 mod_isapi.

ISAPICacheFile ISAPI .dll files to be loaded at startup -ISAPICacheFile file-path [file-path] ... -server config -virtual host +ISAPICacheFile file-path [file-path] +... +server configvirtual host +

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.

+ be specified. If the path name is not absolute, it will be treated + relative to ServerRoot.

 @@ -213,19 +216,18 @@ ISAPIReadAheadBuffer Size of the Read Ahead Buffer sent to ISAPI extensions -ISAPIReadAheadBuffer size +ISAPIReadAheadBuffer size ISAPIReadAheadBuffer 49152 -server config -directory -.htaccess +server configvirtual host +directory.htaccess FileInfo

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 ReadClient callback; some - ISAPI extensions may not support the ReadClient function. Refer - questions to the ISAPI extension's author.

+ data must be retrieved using the ReadClient callback; some + ISAPI extensions may not support the ReadClient function. + Refer questions to the ISAPI extension's author.

 @@ -235,10 +237,8 @@ extensions extensions ISAPILogNotSupported on|off ISAPILogNotSupported off -server config -virtual host -directory -.htaccess +server configvirtual host +directory.htaccess FileInfo @@ -251,56 +251,52 @@ extensions ISAPIAppendLogToErrors -Record HSE_APPEND_LOG_PARAMETER requests from ISAPI -extensions to the error log +Record HSE_APPEND_LOG_PARAMETER requests from +ISAPI extensions to the error log ISAPIAppendLogToErrors on|off ISAPIAppendLogToErrors off -server config -virtual host -directory -.htaccess +server configvirtual host +directory.htaccess FileInfo -

Record HSE_APPEND_LOG_PARAMETER requests from ISAPI +

Record HSE_APPEND_LOG_PARAMETER requests from ISAPI extensions to the server error log.

 ISAPIAppendLogToQuery -Record HSE_APPEND_LOG_PARAMETER requests from ISAPI -extensions to the query field +Record HSE_APPEND_LOG_PARAMETER requests from +ISAPI extensions to the query field ISAPIAppendLogToQuery on|off ISAPIAppendLogToQuery on -server config -virtual host -directory -.htaccess +server configvirtual host +directory.htaccess FileInfo -

Record HSE_APPEND_LOG_PARAMETER requests from ISAPI - extensions to the query field (appended to the CustomLog %q +

Record HSE_APPEND_LOG_PARAMETER requests from ISAPI + extensions to the query field (appended to the CustomLog %q component).

 ISAPIFakeAsync -Fake asynchronous support for isapi callbacks +Fake asynchronous support for ISAPI callbacks ISAPIFakeAsync on|off ISAPIFakeAsync off -server config -virtual host -directory -.htaccess +server configvirtual host +directory.htaccess FileInfo -

While set to on, asynchronous support for isapi callbacks is +

While set to on, asynchronous support for ISAPI callbacks is simulated.

 + diff --git a/docs/manual/mod/quickreference.html.en b/docs/manual/mod/quickreference.html.en index 800e7928b1..7f9b3329fb 100644 --- a/docs/manual/mod/quickreference.html.en +++ b/docs/manual/mod/quickreference.html.en @@ -317,15 +317,16 @@ a directory
IndexOrderDefault Ascending|Descending Name|Date|Size|Description Ascending Name svdhB
Sets the default ordering of the directory index
ISAPIAppendLogToErrors on|off off svdhB
Record HSE_APPEND_LOG_PARAMETER requests from ISAPI -extensions to the error log
ISAPIAppendLogToQuery on|off on svdhB
Record HSE_APPEND_LOG_PARAMETER requests from ISAPI -extensions to the query field
ISAPICacheFile file-path [file-path] ...svB
ISAPI .dll files to be loaded at startup
ISAPIFakeAsync on|off off svdhB
Fake asynchronous support for isapi callbacks
ISAPIAppendLogToErrors on|off off svdhB
Record HSE_APPEND_LOG_PARAMETER requests from +ISAPI extensions to the error log
ISAPIAppendLogToQuery on|off on svdhB
Record HSE_APPEND_LOG_PARAMETER requests from +ISAPI extensions to the query field
ISAPICacheFile file-path [file-path] +...svB
ISAPI .dll files to be loaded at startup
ISAPIFakeAsync on|off off svdhB
Fake asynchronous support for ISAPI callbacks
ISAPILogNotSupported on|off off svdhB
Log unsupported feature requests from ISAPI extensions
ISAPIReadAheadBuffer size 49152 sdhB
Size of the Read Ahead Buffer sent to ISAPI +
ISAPIReadAheadBuffer size 49152 svdhB
Size of the Read Ahead Buffer sent to ISAPI extensions
KeepAlive on|off On svC
Enables HTTP persistent connections
KeepAliveTimeout seconds 15 svC
Amount of time the server will wait for subsequent -- 2.40.0