[couchdb-documentation] branch main updated: Add [chttpd] buffer_response option (#645)

[wo...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

wohali pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/couchdb-documentation.git


The following commit(s) were added to refs/heads/main by this push:
     new 5ec190a  Add [chttpd] buffer_response option (#645)
5ec190a is described below

commit 5ec190a4b40c69779a6fcf0fca0a47fc93646822
Author: Joan Touzet <wo...@users.noreply.github.com>
AuthorDate: Tue Mar 30 05:05:33 2021 +0000

    Add [chttpd] buffer_response option (#645)
---
 src/config/http.rst | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/src/config/http.rst b/src/config/http.rst
index 068ef66..573fd1a 100644
--- a/src/config/http.rst
+++ b/src/config/http.rst
@@ -93,6 +93,20 @@ HTTP Server Options
         - ``{chttpd_auth, default_authentication_handler}``: used for Basic auth;
         - ``{couch_httpd_auth, null_authentication_handler}``: disables auth, breaks CouchDB.
 
+    .. config:option:: buffer_response :: Buffered response
+
+        .. versionchanged:: 3.1.1
+
+        Set this to ``true`` to delay the start of a response until the end has
+        been calculated. This increases memory usage, but simplifies client error
+        handling as it eliminates the possibility that a response may be deliberately
+        terminated midway through, due to a timeout. This config value may be changed
+        at runtime, without impacting any in-flight responses.
+
+        Even if this is set to ``false`` (the default), buffered responses can be
+        enabled on a per-request basis for any delayed JSON response call by adding
+        ``?buffer_response=true`` to the request's parameters.
+
 .. config:section:: httpd :: HTTP Server Options
 
     .. config:option:: allow_jsonp :: Enables JSONP support