summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorTyson Andre <tandre@themeetgroup.com>2017-12-13 10:47:30 -0800
committerJames M Snell <jasnell@gmail.com>2017-12-28 10:10:26 -0800
commit214bbb5228e1f8baedf704a3c7bb0f7b6ce78c69 (patch)
treef671d2a8efbbbd3e290a9e2f6634d3e6fe5bf735 /doc
parent120ea9b5c480c985dc77846a150008f6092c08d0 (diff)
downloadandroid-node-v8-214bbb5228e1f8baedf704a3c7bb0f7b6ce78c69.tar.gz
android-node-v8-214bbb5228e1f8baedf704a3c7bb0f7b6ce78c69.tar.bz2
android-node-v8-214bbb5228e1f8baedf704a3c7bb0f7b6ce78c69.zip
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 <jasnell@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/api/http.md6
1 files changed, 4 insertions, 2 deletions
diff --git a/doc/api/http.md b/doc/api/http.md
index 928ed0d972..a4ed90269d 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.