summaryrefslogtreecommitdiffstats
path: root/docs/manual/mod/mod_firehose.xml
diff options
context:
space:
mode:
authorGraham Leggett <minfrin@apache.org>2011-12-18 18:05:43 +0100
committerGraham Leggett <minfrin@apache.org>2011-12-18 18:05:43 +0100
commit0e223841a83ecb78fecef112b9d56c648692e153 (patch)
treef8d93896c03e92bbfa265b632d0e9a49ca830f1c /docs/manual/mod/mod_firehose.xml
parentRemove unused variable. (diff)
downloadapache2-0e223841a83ecb78fecef112b9d56c648692e153.tar.xz
apache2-0e223841a83ecb78fecef112b9d56c648692e153.zip
mod_firehose: Support portable non blocking support, and make non blocking
support optional. git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@1220456 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'docs/manual/mod/mod_firehose.xml')
-rw-r--r--docs/manual/mod/mod_firehose.xml22
1 files changed, 12 insertions, 10 deletions
diff --git a/docs/manual/mod/mod_firehose.xml b/docs/manual/mod/mod_firehose.xml
index 299f9394c8..b86cf9c2f2 100644
--- a/docs/manual/mod/mod_firehose.xml
+++ b/docs/manual/mod/mod_firehose.xml
@@ -72,10 +72,12 @@
silently stand down and not record anything, and the server will
keep running as normal.</p>
- <p>All file writes are non blocking, and buffer overflows will cause
- debugging data to be lost. The module makes the call that the
- reliable running of the server takes precedence over the recording
- of firehose data.</p>
+ <p>By default, all attempts to write will block the server. If the
+ webserver has been built against APR v2.0 or later, and an optional
+ "nonblock" parameter is specified all file writes will be non
+ blocking, and buffer overflows will cause debugging data to be lost.
+ In this case it is possible to prioritise the running of the server
+ over the recording of firehose data.</p>
</section>
@@ -144,7 +146,7 @@
<name>FirehoseConnectionInput</name>
<description>Capture traffic coming into the server on each connection</description>
-<syntax>FirehoseConnectionInput <var>filename</var></syntax>
+<syntax>FirehoseConnectionInput <var>[ block | nonblock ]</var> <var>filename</var></syntax>
<default>none</default>
<contextlist><context>server config</context></contextlist>
<compatibility>FirehoseConnectionInput is only available in Apache 2.5.0 and
@@ -166,7 +168,7 @@ later.</compatibility>
<name>FirehoseConnectionOutput</name>
<description>Capture traffic going out of the server on each connection</description>
-<syntax>FirehoseConnectionOutput <var>filename</var></syntax>
+<syntax>FirehoseConnectionOutput <var>[ block | nonblock ]</var> <var>filename</var></syntax>
<default>none</default>
<contextlist><context>server config</context></contextlist>
<compatibility>FirehoseConnectionOutput is only available in Apache 2.5.0 and
@@ -188,7 +190,7 @@ later.</compatibility>
<name>FirehoseRequestInput</name>
<description>Capture traffic coming into the server on each request</description>
-<syntax>FirehoseRequestInput <var>filename</var></syntax>
+<syntax>FirehoseRequestInput <var>[ block | nonblock ]</var> <var>filename</var></syntax>
<default>none</default>
<contextlist><context>server config</context></contextlist>
<compatibility>FirehoseRequestInput is only available in Apache 2.5.0 and
@@ -209,7 +211,7 @@ later.</compatibility>
<name>FirehoseRequestOutput</name>
<description>Capture traffic going out of the server on each request</description>
-<syntax>FirehoseRequestOutput <var>filename</var></syntax>
+<syntax>FirehoseRequestOutput <var>[ block | nonblock ]</var> <var>filename</var></syntax>
<default>none</default>
<contextlist><context>server config</context></contextlist>
<compatibility>FirehoseRequestOutput is only available in Apache 2.5.0 and
@@ -230,7 +232,7 @@ later.</compatibility>
<name>FirehoseProxyConnectionInput</name>
<description>Capture traffic coming into the back of mod_proxy</description>
-<syntax>FirehoseProxyConnectionInput <var>filename</var></syntax>
+<syntax>FirehoseProxyConnectionInput <var>[ block | nonblock ]</var> <var>filename</var></syntax>
<default>none</default>
<contextlist><context>server config</context></contextlist>
<compatibility>FirehoseProxyConnectionInput is only available in Apache 2.5.0 and
@@ -250,7 +252,7 @@ later.</compatibility>
<name>FirehoseProxyConnectionOutput</name>
<description>Capture traffic sent out from the back of mod_proxy</description>
-<syntax>FirehoseProxyConnectionOutput <var>filename</var></syntax>
+<syntax>FirehoseProxyConnectionOutput <var>[ block | nonblock ]</var> <var>filename</var></syntax>
<default>none</default>
<contextlist><context>server config</context></contextlist>
<compatibility>FirehoseProxyConnectionOutput is only available in Apache 2.5.0 and