1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: document http2 timeouts

Browse Source 
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.

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>
This commit is contained in:
Sagi Tsofan 2018-09-11 01:14:10 +03:00 committed by Vse Mozhet Byt
parent 466cda0548
commit 19c0620dd6
1 changed files with 38 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
doc/api/http2.md
View File

@ -1615,6 +1615,7 @@ added: v8.4.0
The `'timeout'` event is emitted when there is no activity on the Server for The `'timeout'` event is emitted when there is no activity on the Server for
a given number of milliseconds set using `http2server.setTimeout()`. a given number of milliseconds set using `http2server.setTimeout()`.
**Default:** 2 minutes.
#### server.close([callback]) #### server.close([callback])
<!-- YAML <!-- YAML
@ -1628,6 +1629,24 @@ Note that this is not analogous to restricting new requests since HTTP/2
connections are persistent. To achieve a similar graceful shutdown behavior, connections are persistent. To achieve a similar graceful shutdown behavior,
consider also using [`http2session.close()`] on active sessions. 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 ### Class: Http2SecureServer
<!-- YAML <!-- YAML
added: v8.4.0 added: v8.4.0
@ -1728,6 +1747,7 @@ added: v8.4.0
The `'timeout'` event is emitted when there is no activity on the Server for The `'timeout'` event is emitted when there is no activity on the Server for
a given number of milliseconds set using `http2secureServer.setTimeout()`. a given number of milliseconds set using `http2secureServer.setTimeout()`.
**Default:** 2 minutes.
#### Event: 'unknownProtocol' #### Event: 'unknownProtocol'
<!-- YAML <!-- YAML
@ -1751,6 +1771,24 @@ Note that this is not analogous to restricting new requests since HTTP/2
connections are persistent. To achieve a similar graceful shutdown behavior, connections are persistent. To achieve a similar graceful shutdown behavior,
consider also using [`http2session.close()`] on active sessions. 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]) ### http2.createServer(options[, onRequestHandler])
<!-- YAML <!-- YAML
added: v8.4.0 added: v8.4.0