aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2017-08-14 14:57:59 +0200
committerLoïc Hoguin <[email protected]>2017-08-14 14:57:59 +0200
commit0fe54af72b81fdb198a377198d7f3a91f9ad6d7c (patch)
treed7b7d5e014f0b2311fd3301e609bca20c15d278f /doc
parent6dc280be003c5bb648f4ea26f7a7670c62295c3f (diff)
downloadgun-0fe54af72b81fdb198a377198d7f3a91f9ad6d7c.tar.gz
gun-0fe54af72b81fdb198a377198d7f3a91f9ad6d7c.tar.bz2
gun-0fe54af72b81fdb198a377198d7f3a91f9ad6d7c.zip
Allow an infinity keepalive value1.0.0-pre.4
This disables the keepalive mechanism entirely.
Diffstat (limited to 'doc')
-rw-r--r--doc/src/manual/gun.asciidoc4
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/src/manual/gun.asciidoc b/doc/src/manual/gun.asciidoc
index b690558..02d0b86 100644
--- a/doc/src/manual/gun.asciidoc
+++ b/doc/src/manual/gun.asciidoc
@@ -57,12 +57,12 @@ Configuration for the HTTP protocol.
The following keys are defined:
-keepalive => pos_integer()::
+keepalive => timeout()::
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. Defaults to 5000.
+ idle connections. Use `infinity` to disable. Defaults to 5000.
transform_header_name => fun((LowercaseName :: binary()) -> TransformedName :: binary()) | undefined::
A function that will be applied to all header names before they
are sent to the server. Gun assumes that all header names are in