doc: keepAliveMsecs refers to an initial delay not interval #10702
Conversation
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.
nodejs-github-bot
added
doc
| @@ -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 | |||
There was a problem hiding this comment.
Still confusing.... the TCP keep alive socket option is not directly related to node's HTTP keepAlive option. Keep Alive packets will be sent whenever there is no data flowing over the socket for some period of time, whether HTTP keepAlive is enabled or not. Could you clarify?
There was a problem hiding this comment.
Agreed, tried to make it more similar to socket.setKeepAlive
Set initialDelay (in milliseconds) to set the delay between the last data packet received and the first keepalive probe. Setting 0 for initialDelay will leave the value unchanged from the default (or previous) setting. Defaults to 0.
The main thing that should be changed is that its not related to how often it sends, but how long the idle is, as we see here it refers to TCP_KEEPIDLE in unix, not TCP_KEEPINTVL
|
Looks like this pull request is bringing http.md into line #10715, will wait to see what comes out of it |
To bring the http docs in-line with the net docs,
keepAliveMsecsshould 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.
Checklist
Affected core subsystem(s)
doc
Fixes: #7335