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

quic: additional quic refactors/cleanups #34160

Closed
wants to merge 11 commits into from
Closed

quic: additional quic refactors/cleanups #34160

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
76f941b
quic: continued refactoring for quic_stream/quic_session
jasnell Jul 1, 2020
8a702bd
quic: refactor native object flags for better readability
jasnell Jul 1, 2020
790eac1
quic: additional cleanups on the c++ side
jasnell Jul 1, 2020
a545951
quic: refactor QuicSession close/destroy flow
jasnell Jul 1, 2020
b78df93
quic: refactor QuicSession shared state to use AliasedStruct
jasnell Jul 1, 2020
d90c2e7
quic: remove onSessionDestroy callback
jasnell Jul 2, 2020
676e89f
quic: refactor qlog handling
jasnell Jul 2, 2020
d1bbb55
quic: fixup lint issues
jasnell Jul 2, 2020
5ee492e
quic: cleanup timers if they haven't been already
jasnell Jul 3, 2020
d50bd7d
fixup! quic: refactor qlog handling
jasnell Jul 3, 2020
c9e78fb
quic: add missing memory tracker fields
jasnell Jul 3, 2020
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
45 changes: 28 additions & 17 deletions doc/api/quic.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -274,7 +274,7 @@ added: REPLACEME
* `maxStatelessResetsPerHost` {number} The maximum number of stateless
resets that the `QuicSocket` is permitted to send per remote host.
Default: `10`.
* `qlog` {boolean} Whether to emit ['qlog'][] events for incoming sessions.
* `qlog` {boolean} Whether to enable ['qlog'][] for incoming sessions.
(For outgoing client sessions, set `client.qlog`.) Default: `false`.
* `retryTokenTimeout` {number} The maximum number of *seconds* for retry token
validation. Default: `10` seconds.
Expand Down Expand Up @@ -633,20 +633,6 @@ The callback will be invoked with three arguments:

The `'pathValidation'` event will be emitted multiple times.

#### Event: `'qlog'`
<!-- YAML
added: REPLACEME
-->

* `jsonChunk` {string} A JSON fragment.

Emitted if the `qlog: true` option was passed to `quicsocket.connect()` or
`net.createQuicSocket()` functions.

The argument is a JSON fragment according to the [qlog standard][].

The `'qlog'` event will be emitted multiple times.

#### Event: `'secure'`
<!-- YAML
added: REPLACEME
Expand Down Expand Up @@ -1044,6 +1030,19 @@ added: REPLACEME
A `BigInt` representing the total number of `QuicStreams` initiated by the
connected peer.

#### quicsession.qlog
<!-- YAML
added: REPLACEME
-->

* Type: {stream.Readable}

If `qlog` support is enabled for `QuicSession`, the `quicsession.qlog` property
provides a [`stream.Readable`][] that may be used to access the `qlog` event
data according to the [qlog standard][]. For client `QuicSessions`, the
`quicsession.qlog` property will be `undefined` untilt the `'qlog'` event
is emitted.

#### quicsession.remoteAddress
<!-- YAML
added: REPLACEME
Expand Down Expand Up @@ -1183,6 +1182,17 @@ The `sessionTicket` and `remoteTransportParams` are useful when creating a new

The `'sessionTicket'` event may be emitted multiple times.

#### Event: `'qlog'`
<!-- YAML
added: REPLACEME
-->

The `'qlog'` event is emitted when the `QuicClientSession` is ready to begin
providing `qlog` event data. The callback is invoked with a single argument:

* `qlog` {stream.Readable} A [`stream.Readable`][] that is also available using
the `quicsession.qlog` property.

#### Event: `'usePreferredAddress'`
<!-- YAML
added: REPLACEME
Expand Down Expand Up @@ -1573,7 +1583,7 @@ added: REPLACEME
transport parameters from a previously established session. These would
have been provided as part of the `'sessionTicket'` event on a previous
`QuicClientSession` object.
* `qlog` {boolean} Whether to emit ['qlog'][] events for this session.
* `qlog` {boolean} Whether to enable ['qlog'][] for this session.
Default: `false`.
* `requestOCSP` {boolean} If `true`, specifies that the OCSP status request
extension will be added to the client hello and an `'OCSPResponse'` event
Expand Down Expand Up @@ -2278,6 +2288,7 @@ added: REPLACEME
Set to `true` if the `QuicStream` is unidirectional.

[`crypto.getCurves()`]: crypto.html#crypto_crypto_getcurves
[`stream.Readable`]: #stream_class_stream_readable
[`tls.DEFAULT_ECDH_CURVE`]: #tls_tls_default_ecdh_curve
[`tls.getCiphers()`]: tls.html#tls_tls_getciphers
[ALPN]: https://tools.ietf.org/html/rfc7301
Expand All @@ -2286,5 +2297,5 @@ Set to `true` if the `QuicStream` is unidirectional.
[modifying the default cipher suite]: tls.html#tls_modifying_the_default_tls_cipher_suite
[OpenSSL Options]: crypto.html#crypto_openssl_options
[Perfect Forward Secrecy]: #tls_perfect_forward_secrecy
['qlog']: #quic_event_qlog
['qlog']: #quic_quicsession_qlog
[qlog standard]: https://tools.ietf.org/id/draft-marx-qlog-event-definitions-quic-h3-00.html
Loading