diff options
| author | Sagi Tsofan <sagitsofan@gmail.com> | 2018-09-11 01:14:10 +0300 |
|---|---|---|
| committer | Beth Griggs <Bethany.Griggs@uk.ibm.com> | 2018-10-17 02:07:24 +0300 |
| commit | bae7c608e253d880c6241d787e45cd58b555d3b4 (patch) | |
| tree | 71580e6093c12a74c7f0351ffe4eddfe941dd9cc /doc | |
| parent | 805bf40bfdc4747acd69b16112d693508685136c (diff) | |
doc: document http2 timeouts
New default timeout values of "2 minutes" were added into documentation
inside 2 classes under "Event: 'timeout'":
1) Class: Http2SecureServer
2) Class: Http2Server
New sections for `.setTimeout()` method were added inside
`Http2SecureServer` & `Http2Server` docs.
Backport-PR-URL: https://github.com/nodejs/node/pull/22850
PR-URL: https://github.com/nodejs/node/pull/22798
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/http2.md | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/doc/api/http2.md b/doc/api/http2.md index 7a8abcf4b58..81d1c8fa8e0 100644 --- a/doc/api/http2.md +++ b/doc/api/http2.md @@ -1604,6 +1604,7 @@ added: v8.4.0 The `'timeout'` event is emitted when there is no activity on the Server for a given number of milliseconds set using `http2server.setTimeout()`. +**Default:** 2 minutes. #### server.close([callback]) <!-- YAML @@ -1617,6 +1618,24 @@ Note that this is not analogous to restricting new requests since HTTP/2 connections are persistent. To achieve a similar graceful shutdown behavior, consider also using [`http2session.close()`] on active sessions. +#### server.setTimeout([msecs][, callback]) +<!-- YAML +added: v8.4.0 +--> + +* `msecs` {number} **Default:** `120000` (2 minutes) +* `callback` {Function} +* Returns: {Http2Server} + +Used to set the timeout value for http2 server requests, +and sets a callback function that is called when there is no activity +on the `Http2Server` after `msecs` milliseconds. + +The given callback is registered as a listener on the `'timeout'` event. + +In case of no callback function were assigned, a new `ERR_INVALID_CALLBACK` +error will be thrown. + ### Class: Http2SecureServer <!-- YAML added: v8.4.0 @@ -1717,6 +1736,7 @@ added: v8.4.0 The `'timeout'` event is emitted when there is no activity on the Server for a given number of milliseconds set using `http2secureServer.setTimeout()`. +**Default:** 2 minutes. #### Event: 'unknownProtocol' <!-- YAML @@ -1740,6 +1760,24 @@ Note that this is not analogous to restricting new requests since HTTP/2 connections are persistent. To achieve a similar graceful shutdown behavior, consider also using [`http2session.close()`] on active sessions. +#### server.setTimeout([msecs][, callback]) +<!-- YAML +added: v8.4.0 +--> + +* `msecs` {number} **Default:** `120000` (2 minutes) +* `callback` {Function} +* Returns: {Http2SecureServer} + +Used to set the timeout value for http2 secure server requests, +and sets a callback function that is called when there is no activity +on the `Http2SecureServer` after `msecs` milliseconds. + +The given callback is registered as a listener on the `'timeout'` event. + +In case of no callback function were assigned, a new `ERR_INVALID_CALLBACK` +error will be thrown. + ### http2.createServer(options[, onRequestHandler]) <!-- YAML added: v8.4.0 |