From 073c0f75d786f881d4791af8b29a968b047e5116 Mon Sep 17 00:00:00 2001 From: Tyson Andre Date: Wed, 13 Dec 2017 10:47:30 -0800 Subject: [PATCH] doc: doc imitating the old behavior of http.Server.keepAliveTimeout 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 0aa7ef595084bca35f76cb38e28a0efc7a3128a3, it seems like they behave the same way. Related to issues such as #13391 that show up when migrating to node 8 PR-URL: https://github.com/nodejs/node/pull/17660 Reviewed-By: James M Snell Reviewed-By: Rich Trott Reviewed-By: Luigi Pinca Reviewed-By: Anna Henningsen Reviewed-By: Anatoli Papirovski --- doc/api/http.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/doc/api/http.md b/doc/api/http.md index 928ed0d972b472..a4ed90269d61d3 100644 --- a/doc/api/http.md +++ b/doc/api/http.md @@ -911,7 +911,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. @@ -929,7 +929,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 Node.js versions prior to 8.0.0, +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.