Skip to content
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.

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

doc: document new TCP_KEEPCNT and TCP_KEEPINTVL defaults #38298

Closed
1 task done
ArnoldZokas opened this issue Apr 19, 2021 · 0 comments
Closed
1 task done

doc: document new TCP_KEEPCNT and TCP_KEEPINTVL defaults #38298

ArnoldZokas opened this issue Apr 19, 2021 · 0 comments
Labels
doc Issues and PRs related to the documentations. good first issue Issues that are suitable for first-time contributors.

Comments

@ArnoldZokas
Copy link
Contributor

📗 API Reference Docs Problem

  • Version: v14.0.0 and above, v12.17.0 and above.
  • Platform: All
  • Subsystem: net

Location

Net, socket documentation.

Affected URL(s):

Description

PR #32204 introduced new defaults for the TCP keep-alive socket options (see deps/uv/src/unix/tcp.c):

  • TCP_KEEPCNT now defaults to 10 on all platforms
  • TCP_KEEPINTVL now defaults to 1 on all platforms

Previously, TCP_KEEPCNT and TCP_KEEPINTVL were not set explicitly and OS-default values were used.

This affects Node.js releases v14.0.0 and above, v12.17.0 and above (but not v10).

The change is not mentioned in the documentation or the release notes.

Would be great to add this information either alongside socket.setKeepAlive([enable][, initialDelay]) or as a separate section under net.Socket documentation.


  • I would like to work on this issue and submit a pull request.
@ArnoldZokas ArnoldZokas added the doc Issues and PRs related to the documentations. label Apr 19, 2021
@juanarbol juanarbol added the good first issue Issues that are suitable for first-time contributors. label Apr 19, 2021
ArnoldZokas added a commit to ArnoldZokas/node that referenced this issue Apr 20, 2021
PR nodejs#32204 introduced new defaults for the TCP keep-alive socket options (see deps/uv/src/unix/tcp.c):
- "TCP_KEEPCNT" now defaults to 10 on all platforms
- "TCP_KEEPINTVL" now defaults to 1 on all platforms

Previously, "TCP_KEEPCNT" and "TCP_KEEPINTVL" were not set explicitly and OS-default values were used.

Fixes: nodejs#38298
Refs: nodejs#32204
ArnoldZokas added a commit to ArnoldZokas/node that referenced this issue Apr 20, 2021
PR nodejs#32204 introduced new defaults for the TCP keep-alive socket options (see deps/uv/src/unix/tcp.c):
- "TCP_KEEPCNT" now defaults to 10 on all platforms
- "TCP_KEEPINTVL" now defaults to 1 on all platforms

Previously, "TCP_KEEPCNT" and "TCP_KEEPINTVL" were not set explicitly and OS-default values were used.

Fixes: nodejs#38298
Refs: nodejs#32204
targos pushed a commit that referenced this issue Apr 29, 2021
PR #32204 introduced new defaults for
the TCP keep-alive socket options (see deps/uv/src/unix/tcp.c):
- "TCP_KEEPCNT" now defaults to 10 on all platforms
- "TCP_KEEPINTVL" now defaults to 1 on all platforms

Previously, "TCP_KEEPCNT" and "TCP_KEEPINTVL" were not set explicitly
and OS-default values were used.

Fixes: #38298
Refs: #32204

PR-URL: #38313
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
targos pushed a commit that referenced this issue May 30, 2021
PR #32204 introduced new defaults for
the TCP keep-alive socket options (see deps/uv/src/unix/tcp.c):
- "TCP_KEEPCNT" now defaults to 10 on all platforms
- "TCP_KEEPINTVL" now defaults to 1 on all platforms

Previously, "TCP_KEEPCNT" and "TCP_KEEPINTVL" were not set explicitly
and OS-default values were used.

Fixes: #38298
Refs: #32204

PR-URL: #38313
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
targos pushed a commit that referenced this issue Jun 5, 2021
PR #32204 introduced new defaults for
the TCP keep-alive socket options (see deps/uv/src/unix/tcp.c):
- "TCP_KEEPCNT" now defaults to 10 on all platforms
- "TCP_KEEPINTVL" now defaults to 1 on all platforms

Previously, "TCP_KEEPCNT" and "TCP_KEEPINTVL" were not set explicitly
and OS-default values were used.

Fixes: #38298
Refs: #32204

PR-URL: #38313
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
targos pushed a commit that referenced this issue Jun 5, 2021
PR #32204 introduced new defaults for
the TCP keep-alive socket options (see deps/uv/src/unix/tcp.c):
- "TCP_KEEPCNT" now defaults to 10 on all platforms
- "TCP_KEEPINTVL" now defaults to 1 on all platforms

Previously, "TCP_KEEPCNT" and "TCP_KEEPINTVL" were not set explicitly
and OS-default values were used.

Fixes: #38298
Refs: #32204

PR-URL: #38313
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
targos pushed a commit that referenced this issue Jun 11, 2021
PR #32204 introduced new defaults for
the TCP keep-alive socket options (see deps/uv/src/unix/tcp.c):
- "TCP_KEEPCNT" now defaults to 10 on all platforms
- "TCP_KEEPINTVL" now defaults to 1 on all platforms

Previously, "TCP_KEEPCNT" and "TCP_KEEPINTVL" were not set explicitly
and OS-default values were used.

Fixes: #38298
Refs: #32204

PR-URL: #38313
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations. good first issue Issues that are suitable for first-time contributors.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants