From 0925caf2052401c9a6089ab74402d63fcb65e4ba Mon Sep 17 00:00:00 2001 From: Fabian Cook Date: Mon, 9 Jan 2017 20:19:37 +1300 Subject: [PATCH] doc: keepAliveMsecs refers to an initial delay not interval To bring the http docs in-line with the net docs, keepAliveMsecs should refer to the initial delay, rather than an interval between keep alive probes. There is currently no way to set the actual interval between keep alive probes. --- doc/api/http.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/api/http.md b/doc/api/http.md index fb90123330458c..605a5255360a23 100644 --- a/doc/api/http.md +++ b/doc/api/http.md @@ -102,8 +102,8 @@ added: v0.3.4 Can have the following fields: * `keepAlive` {Boolean} Keep sockets around in a pool to be used by other requests in the future. Default = `false` - * `keepAliveMsecs` {Integer} When using HTTP KeepAlive, how often - to send TCP KeepAlive packets over sockets being kept alive. + * `keepAliveMsecs` {Integer} When using HTTP KeepAlive, the initial delay + between the last data packet and the first TCP KeepAlive packet. Default = `1000`. Only relevant if `keepAlive` is set to `true`. * `maxSockets` {Number} Maximum number of sockets to allow per host. Default = `Infinity`.