Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Http2 timeout documentation #22798

Closed
wants to merge 9 commits into from
Closed

Http2 timeout documentation #22798

Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
93a39e7
Http2 timeout documentation
sagitsofan Sep 10, 2018
a47d0ab
backticks
sagitsofan Sep 11, 2018
8d409ce
lower casing
sagitsofan Sep 11, 2018
f703eb0
added new section
sagitsofan Sep 11, 2018
30678e9
fix typo
sagitsofan Sep 11, 2018
885ecf9
row max length fix
sagitsofan Sep 11, 2018
acda854
typos & order
sagitsofan Sep 11, 2018
5ac898c
added function word
sagitsofan Sep 11, 2018
c749d6e
words changing :+1:
sagitsofan Sep 11, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions doc/api/http2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1615,6 +1615,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
Expand All @@ -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,
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
Expand Down Expand Up @@ -1728,6 +1747,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
Expand All @@ -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,
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
Expand Down