Skip to content

Commit

Permalink
doc: note http.closeAllConnections excludes upgraded sockets
Browse files Browse the repository at this point in the history
PR-URL: nodejs#53560
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Paolo Insogna <paolo@cowtech.it>
  • Loading branch information
robhogan committed Jun 25, 2024
1 parent 73236d5 commit d7d9278
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions doc/api/http.md
Original file line number Diff line number Diff line change
Expand Up @@ -1705,8 +1705,10 @@ setTimeout(() => {
added: v18.2.0
-->

Closes all connections connected to this server, including active connections
connected to this server which are sending a request or waiting for a response.
Closes all established HTTP(S) connections connected to this server, including
active connections connected to this server which are sending a request or
waiting for a response. This does _not_ destroy sockets upgraded to a different
protocol, such as WebSocket or HTTP/2.

> This is a forceful way of closing all connections and should be used with
> caution. Whenever using this in conjunction with `server.close`, calling this
Expand Down

0 comments on commit d7d9278

Please sign in to comment.