summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorAndrew Moss <andrew@mossage.co.uk>2019-01-27 23:09:17 +0000
committerLuigi Pinca <luigipinca@gmail.com>2019-02-09 07:24:39 +0100
commit02601c247db8a7b147065f5757af5ac47165e517 (patch)
tree42c67969461adbd2366aca5f85411c6ba0f6eecc /doc
parent016c7b9c32c3f5a06c8cc0e23bd12bb0ba215cda (diff)
downloadandroid-node-v8-02601c247db8a7b147065f5757af5ac47165e517.tar.gz
android-node-v8-02601c247db8a7b147065f5757af5ac47165e517.tar.bz2
android-node-v8-02601c247db8a7b147065f5757af5ac47165e517.zip
doc: clarify http timeouts
Socket timeouts set using the `'connection'` event are replaced by `server.keepAliveTimeout` when a response is handled. PR-URL: https://github.com/nodejs/node/pull/25748 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/api/http.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/api/http.md b/doc/api/http.md
index 149fc53668..8803078569 100644
--- a/doc/api/http.md
+++ b/doc/api/http.md
@@ -914,6 +914,10 @@ also be accessed at `request.connection`.
This event can also be explicitly emitted by users to inject connections
into the HTTP server. In that case, any [`Duplex`][] stream can be passed.
+If `socket.setTimeout()` is called here, the timeout will be replaced with
+`server.keepAliveTimeout` when the socket has served a request (if
+`server.keepAliveTimeout` is non-zero).
+
### Event: 'request'
<!-- YAML
added: v0.1.0