aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2018-12-31 18:01:19 +0100
committerLoïc Hoguin <[email protected]>2018-12-31 18:03:27 +0100
commit228879bfc4eda8bac1919bab176c859c64ac54c2 (patch)
tree426ecb20acb366abcecc4d28c688449175ed53d6 /doc
parent630bd475e6aa4b9fdde01272236d08305034cb48 (diff)
downloadgun-228879bfc4eda8bac1919bab176c859c64ac54c2.tar.gz
gun-228879bfc4eda8bac1919bab176c859c64ac54c2.tar.bz2
gun-228879bfc4eda8bac1919bab176c859c64ac54c2.zip
Disable keepalive by default for HTTP/1.1
This is safer as servers may reject too many extra empty lines.
Diffstat (limited to 'doc')
-rw-r--r--doc/src/manual/gun.asciidoc7
1 files changed, 5 insertions, 2 deletions
diff --git a/doc/src/manual/gun.asciidoc b/doc/src/manual/gun.asciidoc
index 1b4e6d7..dff927c 100644
--- a/doc/src/manual/gun.asciidoc
+++ b/doc/src/manual/gun.asciidoc
@@ -154,13 +154,14 @@ The default value is given next to the option name:
// @todo Document content_handlers and gun_sse_h.
-keepalive (5000)::
+keepalive (infinity)::
Time between pings in milliseconds. Since the HTTP protocol has
no standardized way to ping the server, Gun will simply send an
empty line when the connection is idle. Gun only makes a best
effort here as servers usually have configurable limits to drop
-idle connections. Use `infinity` to disable.
+idle connections. Disabled by default due to potential
+incompatibilities.
transform_header_name - see below::
@@ -315,6 +316,8 @@ undocumented and must be set to `gun_ws_h`.
== Changelog
* *2.0*: Function `gun:headers/4,5` introduced.
+* *2.0*: The `keepalive` option is now set to `infinity` by
+ default for the HTTP/1.1 protocol, disabling it.
* *1.3*: Add the CONNECT destination's `protocols` option and
deprecate the previously introduced `protocol` option.
* *1.2*: Introduce the type `connect_destination()`.