Skip to content

Commit 3091115

Browse files
cjihrigcjihrig
committed
doc: clarify http2 server.close() behavior
This commit is an attempt to clarify the behavior of HTTP2's server.close() method. Specifically, this makes it more clear that the server stops allowing new sessions although the callback may not be invoked for some time due to previously existing sessions. PR-URL: #28581 Fixes: #28214 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Jiawen Geng <technicalcute@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>
1 parent e04ee9b commit 3091115

1 file changed

Lines changed: 14 additions & 8 deletions

File tree

‎doc/api/http2.md‎

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1749,11 +1749,14 @@ added: v8.4.0
17491749
-->
17501750
* `callback` {Function}
17511751

1752-
Stops the server from accepting new connections. See [`net.Server.close()`][].
1752+
Stops the server from establishing new sessions. This does not prevent new
1753+
request streams from being created due to the persistent nature of HTTP/2
1754+
sessions. To gracefully shut down the server, call [`http2session.close()`] on
1755+
all active sessions.
17531756

1754-
This is not analogous to restricting new requests since HTTP/2
1755-
connections are persistent. To achieve a similar graceful shutdown behavior,
1756-
consider also using [`http2session.close()`] on active sessions.
1757+
If `callback` is provided, it is not invoked until all active sessions have been
1758+
closed, although the server has already stopped allowing new sessions. See
1759+
[`net.Server.close()`][] for more details.
17571760

17581761
#### server.setTimeout([msecs][, callback])
17591762
<!-- YAML
@@ -1895,11 +1898,14 @@ added: v8.4.0
18951898
-->
18961899
* `callback` {Function}
18971900

1898-
Stops the server from accepting new connections. See [`tls.Server.close()`][].
1901+
Stops the server from establishing new sessions. This does not prevent new
1902+
request streams from being created due to the persistent nature of HTTP/2
1903+
sessions. To gracefully shut down the server, call [`http2session.close()`] on
1904+
all active sessions.
18991905

1900-
This is not analogous to restricting new requests since HTTP/2
1901-
connections are persistent. To achieve a similar graceful shutdown behavior,
1902-
consider also using [`http2session.close()`] on active sessions.
1906+
If `callback` is provided, it is not invoked until all active sessions have been
1907+
closed, although the server has already stopped allowing new sessions. See
1908+
[`tls.Server.close()`][] for more details.
19031909

19041910
#### server.setTimeout([msecs][, callback])
19051911
<!-- YAML

0 commit comments

Comments
 (0)