Skip to content

doc: clarify setKeepAlive delay precision #63339

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
MukundaKatta wants to merge 1 commit into from
+8 −4
Closed

doc: clarify setKeepAlive delay precision #63339

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions doc/api/net.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -773,7 +773,9 @@ changes:
the socket immediately after the connection is established, similarly on what
is done in [`socket.setKeepAlive()`][]. **Default:** `false`.
* `keepAliveInitialDelay` {number} If set to a positive number, it sets the
initial delay before the first keepalive probe is sent on an idle socket. **Default:** `0`.
initial delay, in milliseconds, before the first keepalive probe is sent on
an idle socket. The value is rounded down to whole seconds before use.
**Default:** `0`.
* `noDelay` {boolean} If set to `true`, it disables the use of Nagle's algorithm
immediately after the socket is established. **Default:** `false`.
* `onread` {Object} If specified, incoming data is stored in a single `buffer`
Expand Down Expand Up @@ -1400,8 +1402,9 @@ Enable/disable keep-alive functionality, and optionally set the initial
delay before the first keepalive probe is sent on an idle socket.

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
data packet received and the first keepalive probe. The value is rounded down
to whole seconds before it is passed to the operating system. Values less than
`1000` ms become `0`, which leaves the value unchanged from the default
(or previous) setting.

Enabling the keep-alive functionality will set the following socket options:
Expand Down Expand Up @@ -1823,7 +1826,8 @@ changes:
similarly on what is done in [`socket.setKeepAlive()`][]. **Default:**
`false`.
* `keepAliveInitialDelay` {number} If set to a positive number, it sets the
initial delay before the first keepalive probe is sent on an idle socket.
initial delay, in milliseconds, before the first keepalive probe is sent on
an idle socket. The value is rounded down to whole seconds before use.
**Default:** `0`.
* `noDelay` {boolean} If set to `true`, it disables the use of Nagle's
algorithm immediately after a new incoming connection is received.
Expand Down