diff options
| author | James M Snell <jasnell@gmail.com> | 2020-07-09 23:52:15 +0300 |
|---|---|---|
| committer | James M Snell <jasnell@gmail.com> | 2020-07-16 03:16:41 +0300 |
| commit | 9f552df5b4892530e3c8cabc31705b265c317304 (patch) | |
| tree | 9fc62956bfc4ce6b5410aaf65cd3be3930ba966e /doc/api/quic.md | |
| parent | b80108c033325c00dabbde945522e7f3535a3977 (diff) | |
quic: fix endpointClose error handling, document
PR-URL: https://github.com/nodejs/node/pull/34283
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Diffstat (limited to 'doc/api/quic.md')
| -rw-r--r-- | doc/api/quic.md | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/api/quic.md b/doc/api/quic.md index d16b0a853e1..46f521789ef 100644 --- a/doc/api/quic.md +++ b/doc/api/quic.md @@ -1354,6 +1354,21 @@ Emitted after the `QuicSocket` has been destroyed and is no longer usable. The `'close'` event will not be emitted multiple times. +#### Event: `'endpointClose'` +<!-- YAML +added: REPLACEME +--> + +Emitted after a `QuicEndpoint` associated witht the `QuicSocket` closes and +has been destroyed. The handler will be invoked with two arguments: + +* `endpoint` {QuicEndpoint} The `QuicEndpoint` that has been destroyed. +* `error` {Error} An `Error` object if the `QuicEndpoint` was destroyed because + of an error. + +When all of the `QuicEndpoint` instances associated with a `QuicSocket` have +closed, the `QuicEndpoint` will also automatically close. + #### Event: `'error'` <!-- YAML added: REPLACEME |