Skip to content

doc: value choice for imitating the old behavior of http.Server.keepAliveTimeout #17660

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
TysonAndre wants to merge 2 commits into from
Closed

doc: value choice for imitating the old behavior of http.Server.keepAliveTimeout #17660

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ed9287e
doc: value choice for imitating the old behavior of http.Server.keepA…
TysonAndre-tmg Dec 13, 2017
3391923
Mention the specific version where keepAliveTimeout was introduced
TysonAndre Dec 14, 2017
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
Next Next commit
doc: value choice for imitating the old behavior of http.Server.keepA… 
…liveTimeout

Documenting the best way to imitate the old behavior saves time for people
migrating from older versions.
(E.g. for unexpected ECONNRESET)

It isn't immediately obvious if earlier nodejs versions behaved the same
way as nodejs 8 does with keepAliveTimeout = 0.
From 0aa7ef5, it seems like they behave
the same way.

Related to issues such as #13391 that show up when migrating to node 8
  • Loading branch information
@TysonAndre-tmg @TysonAndre
TysonAndre-tmg authored and TysonAndre committed Dec 14, 2017
commit ed9287e25522969e36791f1e3124493f6fa63846
6 changes: 4 additions & 2 deletions doc/api/http.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -900,7 +900,7 @@ added: v0.9.12
The number of milliseconds of inactivity before a socket is presumed
to have timed out.

A value of 0 will disable the timeout behavior on incoming connections.
A value of `0` will disable the timeout behavior on incoming connections.

*Note*: The socket timeout logic is set up on connection, so changing this
value only affects new connections to the server, not any existing connections.
Expand All @@ -918,7 +918,9 @@ will be destroyed. If the server receives new data before the keep-alive
timeout has fired, it will reset the regular inactivity timeout, i.e.,
[`server.timeout`][].

A value of 0 will disable the keep-alive timeout behavior on incoming connections.
A value of `0` will disable the keep-alive timeout behavior on incoming connections.
A value of `0` makes the http server behave similarly to earlier Node.js versions,
which did not have a keep-alive timeout.

*Note*: The socket timeout logic is set up on connection, so changing this
value only affects new connections to the server, not any existing connections.
Expand Down