From: Luca Toscano <elukey@apache.org>
Date: Tue, 12 Sep 2017 16:26:19 +0000 (+0000)
Subject: mod_proxy_fcgi.xml: add examples for flushpackets=on
X-Git-Tag: 2.5.0-alpha~136
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=adadcb53b32064cd33a9cff04f754fb15e78d16b;p=apache

mod_proxy_fcgi.xml: add examples for flushpackets=on

git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@1808129 13f79535-47bb-0310-9956-ffa450edef68
---

diff --git a/docs/manual/mod/mod_proxy_fcgi.xml b/docs/manual/mod/mod_proxy_fcgi.xml
index f63e3985d7..38074215bd 100644
--- a/docs/manual/mod/mod_proxy_fcgi.xml
+++ b/docs/manual/mod/mod_proxy_fcgi.xml
@@ -102,6 +102,27 @@ ProxyPassMatch "^/(.*\.php(/.*)?)$" "unix:/var/run/php5-fpm.sock|fcgi://localhos
     </highlight>
     </example>
 
+    <p> The following example forces the module to flush every chunk of data received
+    from the FCGI backend as soon as it receives it, without buffering.</p>
+    <example><title>Force flush of FCGI data without buffering</title>
+    <highlight language="config">
+ProxyPassMatch "^/myapp/.*\.php(/.*)?$" "fcgi://localhost:9000/var/www/" enablereuse=on flushpackets=on
+    </highlight>
+    </example>
+
+    <p> The following example is related to the previous one with a difference: the module waits/polls
+    for a fixed amount of time before flushing (buffering data from the FCGI backend).
+    This method is useful when the FCGI backend emits data in short bursts, since
+    forcing a flush would result inefficient and expensive for performances. Please note
+    that this setting might not be the best one in use cases when outgoing data chunks
+    from the FCGI application are blocked waiting on incoming chunks from the client.
+    </p>
+    <example><title>Force flush of FCGI data buffering for 20ms</title>
+    <highlight language="config">
+ProxyPassMatch "^/myapp/.*\.php(/.*)?$" "fcgi://localhost:9000/var/www/" flushpackets=on flushwait=20
+    </highlight>
+    </example>
+
     <p>The balanced gateway needs <module>mod_proxy_balancer</module> and
     at least one load balancer algorithm module, such as
     <module>mod_lbmethod_byrequests</module>, in addition to the proxy