{ "type": "module", "source": "doc/api/quic.md", "modules": [ { "textRaw": "QUIC", "name": "quic", "introduced_in": "REPLACEME", "stability": 1, "stabilityText": "Experimental", "desc": "

The net module provides an implementation of the QUIC protocol. To\naccess it, the Node.js binary must be compiled using the\n--experimental-quic configuration flag.

\n
const { createQuicSocket } = require('net');\n
\n

Example

\n
'use strict';\n\nconst key = getTLSKeySomehow();\nconst cert = getTLSCertSomehow();\n\nconst { createQuicSocket } = require('net');\n\n// Create the QUIC UDP IPv4 socket bound to local IP port 1234\nconst socket = createQuicSocket({ endpoint: { port: 1234 } });\n\n// Tell the socket to operate as a server using the given\n// key and certificate to secure new connections, using\n// the fictional 'hello' application protocol.\nsocket.listen({ key, cert, alpn: 'hello' });\n\nsocket.on('session', (session) => {\n  // A new server side session has been created!\n\n  session.on('secure', () => {\n    // Once the TLS handshake is completed, we can\n    // open streams...\n    const uni = session.openStream({ halfOpen: true });\n    uni.write('hi ');\n    uni.end('from the server!');\n  });\n\n  // The peer opened a new stream!\n  session.on('stream', (stream) => {\n    // Let's say hello\n    stream.end('Hello World');\n\n    // Let's see what the peer has to say...\n    stream.setEncoding('utf8');\n    stream.on('data', console.log);\n    stream.on('end', () => console.log('stream ended'));\n  });\n});\n\nsocket.on('listening', () => {\n  // The socket is listening for sessions!\n});\n
", "modules": [ { "textRaw": "QUIC Basics", "name": "quic_basics", "desc": "

QUIC is a UDP-based network transport protocol that includes built-in security\nvia TLS 1.3, flow control, error correction, connection migration,\nmultiplexing, and more.

\n

Within the Node.js implementation of the QUIC protocol, there are three main\ncomponents: the QuicSocket, the QuicSession and the QuicStream.

", "modules": [ { "textRaw": "QuicSocket", "name": "quicsocket", "desc": "

A QuicSocket encapsulates a binding to one or more local UDP ports. It is\nused to send data to, and receive data from, remote endpoints. Once created,\na QuicSocket is associated with a local network address and IP port and can\nact as both a QUIC client and server simultaneously. User code at the\nJavaScript level interacts with the QuicSocket object to:

\n\n

Unlike the net.Socket and tls.TLSSocket, a QuicSocket instance cannot be\ndirectly used by user code at the JavaScript level to send or receive data over\nthe network.

", "type": "module", "displayName": "QuicSocket" }, { "textRaw": "Client and Server QuicSessions", "name": "client_and_server_quicsessions", "desc": "

A QuicSession represents a logical connection between two QUIC endpoints (a\nclient and a server). In the JavaScript API, each is represented by the\nQuicClientSession and QuicServerSession specializations.

\n

At any given time, a QuicSession exists is one of four possible states:

\n\n

New instances of QuicClientSession are created using the connect()\nfunction on a QuicSocket as in the example below:

\n
const { createQuicSocket } = require('net');\n\n// Create a QuicSocket associated with localhost and port 1234\nconst socket = createQuicSocket({ endpoint: { port: 1234 } });\n\nconst client = socket.connect({\n  address: 'example.com',\n  port: 4567,\n  alpn: 'foo'\n});\n
\n

As soon as the QuicClientSession is created, the address provided in\nthe connect options will be resolved to an IP address (if necessary), and\nthe TLS 1.3 handshake will begin. The QuicClientSession cannot be used\nto exchange application data until after the 'secure' event has been\nemitted by the QuicClientSession object, signaling the completion of\nthe TLS 1.3 handshake.

\n
client.on('secure', () => {\n  // The QuicClientSession can now be used for application data\n});\n
\n

New instances of QuicServerSession are created internally by the\nQuicSocket if it has been configured to listen for new connections\nusing the listen() method.

\n
const key = getTLSKeySomehow();\nconst cert = getTLSCertSomehow();\n\nsocket.listen({\n  key,\n  cert,\n  alpn: 'foo'\n});\n\nsocket.on('session', (session) => {\n  session.on('secure', () => {\n    // The QuicServerSession can now be used for application data\n  });\n});\n
\n

As with client QuicSession instances, the QuicServerSession cannot be\nused to exhange application data until the 'secure' event has been emitted.

", "type": "module", "displayName": "Client and Server QuicSessions" }, { "textRaw": "QuicSession and ALPN", "name": "quicsession_and_alpn", "desc": "

QUIC uses the TLS 1.3 ALPN (\"Application-Layer Protocol Negotiation\")\nextension to identify the application level protocol that is using the QUIC\nconnection. Every QuicSession instance has an ALPN identifier that must be\nspecified in either the connect() or listen() options. ALPN identifiers that\nare known to Node.js (such as the ALPN identifier for HTTP/3) will alter how the\nQuicSession and QuicStream objects operate internally, but the QUIC\nimplementation for Node.js has been designed to allow any ALPN to be specified\nand used.

", "type": "module", "displayName": "QuicSession and ALPN" }, { "textRaw": "QuicStream", "name": "quicstream", "desc": "

Once a QuicSession transitions to the Ready state, QuicStream instances\nmay be created and used to exchange application data. On a general level, all\nQuicStream instances are simply Node.js Duplex Streams that allow\nbidirectional data flow between the QUIC client and server. However, the\napplication protocol negotiated for the QuicSession may alter the semantics\nand operation of a QuicStream associated with the session. Specifically,\nsome features of the QuicStream (e.g. headers) are enabled only if the\napplication protocol selected is known by Node.js to support those features.

\n

Once the QuicSession is ready, a QuicStream may be created by either the\nclient or server, and may be unidirectional or bidirectional.

\n

The openStream() method is used to create a new QuicStream:

\n
// Create a new bidirectional stream\nconst stream1 = session.openStream();\n\n// Create a new unidirectional stream\nconst stream2 = session.openStream({ halfOpen: true });\n
\n

As suggested by the names, a bidirectional stream allows data to be sent on\na stream in both directions, by both client and server, regardless of which\npeer opened the stream. A unidirectional stream can be written to only by the\nQuicSession that opened it.

\n

The 'stream' event is emitted by the QuicSession when a new QuicStream\nhas been initated by the connected peer:

\n
session.on('stream', (stream) => {\n  if (stream.bidirectional) {\n    stream.write('Hello World');\n    stream.end();\n  }\n  stream.on('data', console.log);\n  stream.on('end', () => {});\n});\n
", "modules": [ { "textRaw": "QuicStream Headers", "name": "quicstream_headers", "desc": "

Some QUIC application protocols (like HTTP/3) make use of headers.

\n

There are four kinds of headers that the Node.js QUIC implementation\nis capable of handling dependent entirely on known application protocol\nsupport:

\n\n

These categories correlate exactly with the equivalent HTTP\nconcepts:

\n\n

If headers are supported by the application protocol in use for\na given QuicSession, the 'initialHeaders', 'informationalHeaders',\nand 'trailingHeaders' events will be emitted by the QuicStream\nobject when headers are received; and the submitInformationalHeaders(),\nsubmitInitialHeaders(), and submitTrailingHeaders() methods can be\nused to send headers.

", "type": "module", "displayName": "QuicStream Headers" } ], "type": "module", "displayName": "QuicStream" } ], "type": "module", "displayName": "QUIC Basics" }, { "textRaw": "QUIC and HTTP/3", "name": "quic_and_http/3", "desc": "

HTTP/3 is an application layer protocol that uses QUIC as the transport.

\n

TBD

", "type": "module", "displayName": "QUIC and HTTP/3" }, { "textRaw": "QUIC JavaScript API", "name": "quic_javascript_api", "methods": [ { "textRaw": "net.createQuicSocket([options])", "type": "method", "name": "createQuicSocket", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "signatures": [ { "params": [ { "textRaw": "`options` {Object}", "name": "options", "type": "Object", "options": [ { "textRaw": "`client` {Object} A default configuration for QUIC client sessions created using `quicsocket.connect()`.", "name": "client", "type": "Object", "desc": "A default configuration for QUIC client sessions created using `quicsocket.connect()`." }, { "textRaw": "`endpoint` {Object} An object describing the local address to bind to.", "name": "endpoint", "type": "Object", "desc": "An object describing the local address to bind to.", "options": [ { "textRaw": "`address` {string} The local address to bind to. This may be an IPv4 or IPv6 address or a host name. If a host name is given, it will be resolved to an IP address.", "name": "address", "type": "string", "desc": "The local address to bind to. This may be an IPv4 or IPv6 address or a host name. If a host name is given, it will be resolved to an IP address." }, { "textRaw": "`port` {number} The local port to bind to.", "name": "port", "type": "number", "desc": "The local port to bind to." }, { "textRaw": "`type` {string} Either `'udp4'` or `'upd6'` to use either IPv4 or IPv6, respectively. **Default**: `'udp4'`.", "name": "type", "type": "string", "desc": "Either `'udp4'` or `'upd6'` to use either IPv4 or IPv6, respectively. **Default**: `'udp4'`." }, { "textRaw": "`ipv6Only` {boolean} If `type` is `'udp6'`, then setting `ipv6Only` to `true` will disable dual-stack support on the UDP binding -- that is, binding to address `'::'` will not make `'0.0.0.0'` be bound. The option is ignored if `type` is `'udp4'`. **Default**: `false`.", "name": "ipv6Only", "type": "boolean", "desc": "If `type` is `'udp6'`, then setting `ipv6Only` to `true` will disable dual-stack support on the UDP binding -- that is, binding to address `'::'` will not make `'0.0.0.0'` be bound. The option is ignored if `type` is `'udp4'`. **Default**: `false`." } ] }, { "textRaw": "`lookup` {Function} A custom DNS lookup function. Default `dns.lookup()`.", "name": "lookup", "type": "Function", "desc": "A custom DNS lookup function. Default `dns.lookup()`." }, { "textRaw": "`maxConnections` {number} The maximum number of total active inbound connections.", "name": "maxConnections", "type": "number", "desc": "The maximum number of total active inbound connections." }, { "textRaw": "`maxConnectionsPerHost` {number} The maximum number of inbound connections allowed per remote host. Default: `100`.", "name": "maxConnectionsPerHost", "type": "number", "desc": "The maximum number of inbound connections allowed per remote host. Default: `100`." }, { "textRaw": "`maxStatelessResetsPerHost` {number} The maximum number of stateless resets that the `QuicSocket` is permitted to send per remote host. Default: `10`.", "name": "maxStatelessResetsPerHost", "type": "number", "desc": "The maximum number of stateless resets that the `QuicSocket` is permitted to send per remote host. Default: `10`." }, { "textRaw": "`qlog` {boolean} Whether to enable ['qlog'][] for incoming sessions. (For outgoing client sessions, set `client.qlog`.) Default: `false`.", "name": "qlog", "type": "boolean", "desc": "Whether to enable ['qlog'][] for incoming sessions. (For outgoing client sessions, set `client.qlog`.) Default: `false`." }, { "textRaw": "`retryTokenTimeout` {number} The maximum number of *seconds* for retry token validation. Default: `10` seconds.", "name": "retryTokenTimeout", "type": "number", "desc": "The maximum number of *seconds* for retry token validation. Default: `10` seconds." }, { "textRaw": "`server` {Object} A default configuration for QUIC server sessions.", "name": "server", "type": "Object", "desc": "A default configuration for QUIC server sessions." }, { "textRaw": "`validateAddress` {boolean} When `true`, the `QuicSocket` will use explicit address validation using a QUIC `RETRY` frame when listening for new server sessions. Default: `false`.", "name": "validateAddress", "type": "boolean", "desc": "When `true`, the `QuicSocket` will use explicit address validation using a QUIC `RETRY` frame when listening for new server sessions. Default: `false`." }, { "textRaw": "`validateAddressLRU` {boolean} When `true`, validation will be skipped if the address has been recently validated. Currently, only the 10 most recently validated addresses are remembered. Setting `validateAddressLRU` to `true`, will enable the `validateAddress` option as well. Default: `false`.", "name": "validateAddressLRU", "type": "boolean", "desc": "When `true`, validation will be skipped if the address has been recently validated. Currently, only the 10 most recently validated addresses are remembered. Setting `validateAddressLRU` to `true`, will enable the `validateAddress` option as well. Default: `false`." } ], "optional": true } ] } ], "desc": "

The net.createQuicSocket() function is used to create new QuicSocket\ninstances associated with a local UDP address.

" } ], "classes": [ { "textRaw": "Class: QuicEndpoint", "type": "class", "name": "QuicEndpoint", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

The QuicEndpoint wraps a local UDP binding used by a QuicSocket to send\nand receive data. A single QuicSocket may be bound to multiple\nQuicEndpoint instances at any given time.

\n

Users will not create instances of QuicEndpoint directly.

", "methods": [ { "textRaw": "quicendpoint.addMembership(address, iface)", "type": "method", "name": "addMembership", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "signatures": [ { "params": [ { "textRaw": "`address` {string}", "name": "address", "type": "string" }, { "textRaw": "`iface` {string}", "name": "iface", "type": "string" } ] } ], "desc": "

Tells the kernel to join a multicast group at the given multicastAddress and\nmulticastInterface using the IP_ADD_MEMBERSHIP socket option. If the\nmulticastInterface argument is not specified, the operating system will\nchoose one interface and will add membership to it. To add membership to every\navailable interface, call addMembership() multiple times, once per\ninterface.

" }, { "textRaw": "quicendpoint.destroy([error])", "type": "method", "name": "destroy", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "signatures": [ { "params": [ { "textRaw": "`error` {Object} An `Error` object.", "name": "error", "type": "Object", "desc": "An `Error` object.", "optional": true } ] } ], "desc": "

Closes and destroys the QuicEndpoint instance making it usuable.

" }, { "textRaw": "quicendpoint.dropMembership(address, iface)", "type": "method", "name": "dropMembership", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "signatures": [ { "params": [ { "textRaw": "`address` {string}", "name": "address", "type": "string" }, { "textRaw": "`iface` {string}", "name": "iface", "type": "string" } ] } ], "desc": "

Instructs the kernel to leave a multicast group at multicastAddress using the\nIP_DROP_MEMBERSHIP socket option. This method is automatically called by the\nkernel when the socket is closed or the process terminates, so most apps will\nnever have reason to call this.

\n

If multicastInterface is not specified, the operating system will attempt to\ndrop membership on all valid interfaces.

" }, { "textRaw": "quicendpoint.ref()", "type": "method", "name": "ref", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "signatures": [ { "params": [] } ] }, { "textRaw": "quicendpoint.setBroadcast([on])", "type": "method", "name": "setBroadcast", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "signatures": [ { "params": [ { "textRaw": "`on` {boolean}", "name": "on", "type": "boolean", "optional": true } ] } ], "desc": "

Sets or clears the SO_BROADCAST socket option. When set to true, UDP\npackets may be sent to a local interface's broadcast address.

" }, { "textRaw": "quicendpoint.setMulticastInterface(iface)", "type": "method", "name": "setMulticastInterface", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "signatures": [ { "params": [ { "textRaw": "`iface` {string}", "name": "iface", "type": "string" } ] } ], "desc": "

All references to scope in this section are referring to IPv6 Zone Indices,\nwhich are defined by RFC 4007. In string form, an IP with a scope index\nis written as 'IP%scope' where scope is an interface name or interface\nnumber.

\n

Sets the default outgoing multicast interface of the socket to a chosen\ninterface or back to system interface selection. The multicastInterface must\nbe a valid string representation of an IP from the socket's family.

\n

For IPv4 sockets, this should be the IP configured for the desired physical\ninterface. All packets sent to multicast on the socket will be sent on the\ninterface determined by the most recent successful use of this call.

\n

For IPv6 sockets, multicastInterface should include a scope to indicate the\ninterface as in the examples that follow. In IPv6, individual send calls can\nalso use explicit scope in addresses, so only packets sent to a multicast\naddress without specifying an explicit scope are affected by the most recent\nsuccessful use of this call.

\n
Examples: IPv6 Outgoing Multicast Interface
\n

On most systems, where scope format uses the interface name:

\n
const { createQuicSocket } = require('net');\nconst socket = createQuicSocket({ endpoint: { type: 'udp6', port: 1234 } });\n\nsocket.on('ready', () => {\n  socket.endpoints[0].setMulticastInterface('::%eth1');\n});\n
\n

On Windows, where scope format uses an interface number:

\n
const { createQuicSocket } = require('net');\nconst socket = createQuicSocket({ endpoint: { type: 'udp6', port: 1234 } });\n\nsocket.on('ready', () => {\n  socket.endpoints[0].setMulticastInterface('::%2');\n});\n
\n
Example: IPv4 Outgoing Multicast Interface
\n

All systems use an IP of the host on the desired physical interface:

\n
const { createQuicSocket } = require('net');\nconst socket = createQuicSocket({ endpoint: { type: 'udp4', port: 1234 } });\n\nsocket.on('ready', () => {\n  socket.endpoints[0].setMulticastInterface('10.0.0.2');\n});\n
", "modules": [ { "textRaw": "Call Results", "name": "call_results", "desc": "

A call on a socket that is not ready to send or no longer open may throw a\nNot running Error.

\n

If multicastInterface can not be parsed into an IP then an EINVAL System\nError is thrown.

\n

On IPv4, if multicastInterface is a valid address but does not match any\ninterface, or if the address does not match the family then a System Error\nsuch as EADDRNOTAVAIL or EPROTONOSUP is thrown.

\n

On IPv6, most errors with specifying or omitting scope will result in the\nsocket continuing to use (or returning to) the system's default interface\nselection.

\n

A socket's address family's ANY address (IPv4 '0.0.0.0' or IPv6 '::')\ncan be used to return control of the sockets default outgoing interface to\nthe system for future multicast packets.

", "type": "module", "displayName": "Call Results" } ] }, { "textRaw": "quicendpoint.setMulticastLoopback([on])", "type": "method", "name": "setMulticastLoopback", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "signatures": [ { "params": [ { "textRaw": "`on` {boolean}", "name": "on", "type": "boolean", "optional": true } ] } ], "desc": "

Sets or clears the IP_MULTICAST_LOOP socket option. When set to true,\nmulticast packets will also be received on the local interface.

" }, { "textRaw": "quicendpoint.setMulticastTTL(ttl)", "type": "method", "name": "setMulticastTTL", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "signatures": [ { "params": [ { "textRaw": "`ttl` {number}", "name": "ttl", "type": "number" } ] } ], "desc": "

Sets the IP_MULTICAST_TTL socket option. While TTL generally stands for\n\"Time to Live\", in this context it specifies the number of IP hops that a\npacket is allowed to travel through, specifically for multicast traffic. Each\nrouter or gateway that forwards a packet decrements the TTL. If the TTL is\ndecremented to 0 by a router, it will not be forwarded.

\n

The argument passed to setMulticastTTL() is a number of hops between\n0 and 255. The default on most systems is 1 but can vary.

" }, { "textRaw": "quicendpoint.setTTL(ttl)", "type": "method", "name": "setTTL", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "signatures": [ { "params": [ { "textRaw": "`ttl` {number}", "name": "ttl", "type": "number" } ] } ], "desc": "

Sets the IP_TTL socket option. While TTL generally stands for \"Time to Live\",\nin this context it specifies the number of IP hops that a packet is allowed to\ntravel through. Each router or gateway that forwards a packet decrements the\nTTL. If the TTL is decremented to 0 by a router, it will not be forwarded.\nChanging TTL values is typically done for network probes or when multicasting.

\n

The argument to setTTL() is a number of hops between 1 and 255.\nThe default on most systems is 64 but can vary.

" }, { "textRaw": "quicendpoint.unref()", "type": "method", "name": "unref", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "signatures": [ { "params": [] } ] } ], "properties": [ { "textRaw": "`address` Type: Address", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

An object containing the address information for a bound QuicEndpoint.

\n

The object will contain the properties:

\n\n

If the QuicEndpoint is not bound, quicendpoint.address is an empty object.

", "shortDesc": "Address" }, { "textRaw": "`bound` Type: {boolean}", "type": "boolean", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

Set to true if the QuicEndpoint is bound to the local UDP port.

" }, { "textRaw": "`closing` Type: {boolean}", "type": "boolean", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

Set to true if the QuicEndpoint is in the process of closing.

" }, { "textRaw": "`destroyed` Type: {boolean}", "type": "boolean", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

Set to true if the QuicEndpoint has been destroyed.

" }, { "textRaw": "`fd` Type: {integer}", "type": "integer", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

The system file descriptor the QuicEndpoint is bound to. This property\nis not set on Windows.

" }, { "textRaw": "`pending` Type: {boolean}", "type": "boolean", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

Set to true if the QuicEndpoint is in the process of binding to\nthe local UDP port.

" } ] }, { "textRaw": "Class: QuicSession extends EventEmitter", "type": "class", "name": "QuicSession", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "\n

The QuicSession is an abstract base class that defines events, methods, and\nproperties that are shared by both QuicClientSession and QuicServerSession.

\n

Users will not create instances of QuicSession directly.

", "events": [ { "textRaw": "Event: `'close'`", "type": "event", "name": "close", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "params": [], "desc": "

Emitted after the QuicSession has been destroyed and is no longer usable.

\n

The 'close' event will not be emitted more than once.

" }, { "textRaw": "Event: `'error'`", "type": "event", "name": "error", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "params": [], "desc": "

Emitted immediately before the 'close' event if the QuicSession was\ndestroyed with an error.

\n

The callback will be invoked with a single argument:

\n\n

The 'error' event will not be emitted more than once.

" }, { "textRaw": "Event: `'keylog'`", "type": "event", "name": "keylog", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "params": [], "desc": "

Emitted when key material is generated or received by a QuicSession\n(typically during or immediately following the handshake process). This keying\nmaterial can be stored for debugging, as it allows captured TLS traffic to be\ndecrypted. It may be emitted multiple times per QuicSession instance.

\n

The callback will be invoked with a single argument:

\n\n

A typical use case is to append received lines to a common text file, which is\nlater used by software (such as Wireshark) to decrypt the traffic:

\n
const log = fs.createWriteStream('/tmp/ssl-keys.log', { flags: 'a' });\n// ...\nsession.on('keylog', (line) => log.write(line));\n
\n

The 'keylog' event will be emitted multiple times.

" }, { "textRaw": "Event: `'pathValidation'`", "type": "event", "name": "pathValidation", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "params": [], "desc": "

Emitted when a path validation result has been determined. This event\nis strictly informational. When path validation is successful, the\nQuicSession will automatically update to use the new validated path.

\n

The callback will be invoked with three arguments:

\n\n

The 'pathValidation' event will be emitted multiple times.

" }, { "textRaw": "Event: `'secure'`", "type": "event", "name": "secure", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "params": [], "desc": "

Emitted after the TLS handshake has been completed.

\n

The callback will be invoked with two arguments:

\n\n

These will also be available using the quicsession.servername,\nquicsession.alpnProtocol, and quicsession.cipher properties.

\n

The 'secure' event will not be emitted more than once.

" }, { "textRaw": "Event: `'stream'`", "type": "event", "name": "stream", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "params": [], "desc": "

Emitted when a new QuicStream has been initiated by the connected peer.

\n

The 'stream' event may be emitted multiple times.

" } ], "properties": [ { "textRaw": "`ackDelayRetransmitCount` Type: {number}", "type": "number", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

The number of retransmissions caused by delayed acknowledgements.

" }, { "textRaw": "`address` Type: {Object}", "type": "Object", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "options": [ { "textRaw": "`address` {string} The local IPv4 or IPv6 address to which the `QuicSession` is bound.", "name": "address", "type": "string", "desc": "The local IPv4 or IPv6 address to which the `QuicSession` is bound." }, { "textRaw": "`family` {string} Either `'IPv4'` or `'IPv6'`.", "name": "family", "type": "string", "desc": "Either `'IPv4'` or `'IPv6'`." }, { "textRaw": "`port` {number} The local IP port to which the `QuicSocket` is bound.", "name": "port", "type": "number", "desc": "The local IP port to which the `QuicSocket` is bound." } ], "desc": "

An object containing the local address information for the QuicSocket to which\nthe QuicSession is currently associated.

" }, { "textRaw": "`alpnProtocol` Type: {string}", "type": "string", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

The ALPN protocol identifier negotiated for this session.

" }, { "textRaw": "quicsession.authenticated", "name": "authenticated", "desc": "\n\n

True if the certificate provided by the peer during the TLS 1.3\nhandshake has been verified.

" }, { "textRaw": "`authenticationError` Type: {Object} An error object", "type": "Object", "name": "Type", "desc": "

If quicsession.authenticated is false, returns an Error object\nrepresenting the reason the peer certificate verification failed.

", "shortDesc": "An error object" }, { "textRaw": "`bidiStreamCount` Type: {number}", "type": "number", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

The total number of bidirectional streams created for this QuicSession.

" }, { "textRaw": "`blockCount` Type: {number}", "type": "number", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

The total number of times the QuicSession has been blocked from sending\nstream data due to flow control.

\n

Such blocks indicate that transmitted stream data is not being consumed\nquickly enough by the connected peer.

" }, { "textRaw": "`bytesInFlight` Type: {number}", "type": "number", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

The total number of unacknowledged bytes this QUIC endpoint has transmitted\nto the connected peer.

" }, { "textRaw": "`bytesReceived` Type: {number}", "type": "number", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

The total number of bytes received from the peer.

" }, { "textRaw": "`bytesSent` Type: {number}", "type": "number", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

The total number of bytes sent to the peer.

" }, { "textRaw": "`cipher` Type: {Object}", "type": "Object", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "options": [ { "textRaw": "`name` {string} The cipher algorithm name.", "name": "name", "type": "string", "desc": "The cipher algorithm name." }, { "textRaw": "`type` {string} The TLS version (currently always `'TLSv1.3'`).", "name": "type", "type": "string", "desc": "The TLS version (currently always `'TLSv1.3'`)." } ], "desc": "

Information about the cipher algorithm selected for the session.

" }, { "textRaw": "`closeCode` Type: {Object}", "type": "Object", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "options": [ { "textRaw": "`code` {number} The error code reported when the `QuicSession` closed.", "name": "code", "type": "number", "desc": "The error code reported when the `QuicSession` closed." }, { "textRaw": "`family` {number} The type of error code reported (`0` indicates a QUIC protocol level error, `1` indicates a TLS error, `2` represents an application level error.)", "name": "family", "type": "number", "desc": "The type of error code reported (`0` indicates a QUIC protocol level error, `1` indicates a TLS error, `2` represents an application level error.)" } ], "desc": "

Set to true if the QuicSession is in the process of a graceful shutdown.

" }, { "textRaw": "`closing` Type: {boolean}", "type": "boolean", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

Set to true if the QuicSession is in the process of a graceful shutdown.

" }, { "textRaw": "`destroyed` Type: {boolean}", "type": "boolean", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

Set to true if the QuicSession has been destroyed.

" }, { "textRaw": "`duration` Type: {number}", "type": "number", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

The length of time the QuicSession was active.

" }, { "textRaw": "quicsession.handshakeAckHistogram", "name": "handshakeAckHistogram", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

TBD

" }, { "textRaw": "quicsession.handshakeContinuationHistogram", "name": "handshakeContinuationHistogram", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

TBD

" }, { "textRaw": "`handshakeComplete` Type: {boolean}", "type": "boolean", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

Set to true if the TLS handshake has completed.

" }, { "textRaw": "`handshakeConfirmed` Type: {boolean}", "type": "boolean", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

Set to true when the TLS handshake completion has been confirmed.

" }, { "textRaw": "`handshakeDuration` Type: {number}", "type": "number", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

The length of time taken to complete the TLS handshake.

" }, { "textRaw": "`idleTimeout` Type: {boolean}", "type": "boolean", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

Set to true if the QuicSession was closed due to an idle timeout.

" }, { "textRaw": "`keyUpdateCount` Type: {number}", "type": "number", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

The number of key update operations that have occured.

" }, { "textRaw": "`latestRTT` Type: {number}", "type": "number", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

The most recently recorded RTT for this QuicSession.

" }, { "textRaw": "`lossRetransmitCount` Type: {number}", "type": "number", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

The number of lost-packet retransmissions that have been performed on\nthis QuicSession.

" }, { "textRaw": "`maxDataLeft` Type: {number}", "type": "number", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

The total number of bytes the QuicSession is currently allowed to\nsend to the connected peer.

" }, { "textRaw": "`maxInFlightBytes` Type: {number}", "type": "number", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

The maximum number of in-flight bytes recorded for this QuicSession.

" }, { "textRaw": "`maxStreams` Type: {Object}", "type": "Object", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "options": [ { "textRaw": "`uni` {number} The maximum number of unidirectional streams.", "name": "uni", "type": "number", "desc": "The maximum number of unidirectional streams." }, { "textRaw": "`bidi` {number} The maximum number of bidirectional streams.", "name": "bidi", "type": "number", "desc": "The maximum number of bidirectional streams." } ], "desc": "

The highest cumulative number of bidirectional and unidirectional streams\nthat can currently be opened. The values are set initially by configuration\nparameters when the QuicSession is created, then updated over the lifespan\nof the QuicSession as the connected peer allows new streams to be created.

" }, { "textRaw": "`minRTT` Type: {number}", "type": "number", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

The minimum RTT recorded so far for this QuicSession.

" }, { "textRaw": "`peerInitiatedStreamCount` Type: {number}", "type": "number", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

The total number of QuicStreams initiated by the connected peer.

" }, { "textRaw": "`qlog` Type: {stream.Readable}", "type": "stream.Readable", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

If qlog support is enabled for QuicSession, the quicsession.qlog property\nprovides a stream.Readable that may be used to access the qlog event\ndata according to the qlog standard. For client QuicSessions, the\nquicsession.qlog property will be undefined untilt the 'qlog' event\nis emitted.

" }, { "textRaw": "`remoteAddress` Type: {Object}", "type": "Object", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "options": [ { "textRaw": "`address` {string} The local IPv4 or IPv6 address to which the `QuicSession` is connected.", "name": "address", "type": "string", "desc": "The local IPv4 or IPv6 address to which the `QuicSession` is connected." }, { "textRaw": "`family` {string} Either `'IPv4'` or `'IPv6'`.", "name": "family", "type": "string", "desc": "Either `'IPv4'` or `'IPv6'`." }, { "textRaw": "`port` {number} The local IP port to which the `QuicSocket` is bound.", "name": "port", "type": "number", "desc": "The local IP port to which the `QuicSocket` is bound." } ], "desc": "

An object containing the remote address information for the connected peer.

" }, { "textRaw": "`selfInitiatedStreamCount` Type: {number}", "type": "number", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

The total number of QuicStream instances initiated by this QuicSession.

" }, { "textRaw": "`servername` Type: {string}", "type": "string", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

The SNI servername requested for this session by the client.

" }, { "textRaw": "`smoothedRTT` Type: {number}", "type": "number", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

The modified RTT calculated for this QuicSession.

" }, { "textRaw": "`socket` Type: {QuicSocket}", "type": "QuicSocket", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

The QuicSocket the QuicSession is associated with.

" }, { "textRaw": "`statelessReset` Type: {boolean}", "type": "boolean", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

True if the QuicSession was closed due to QUIC stateless reset.

" }, { "textRaw": "`uniStreamCount` Type: {number}", "type": "number", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

The total number of unidirectional streams created on this QuicSession.

" }, { "textRaw": "`usingEarlyData` Type: {boolean}", "type": "boolean", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

On server QuicSession instances, set to true on completion of the TLS\nhandshake if early data is enabled. On client QuicSession instances,\nset to true on handshake completion if early data is enabled and was\naccepted by the server.

" } ], "methods": [ { "textRaw": "quicsession.close([callback])", "type": "method", "name": "close", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "signatures": [ { "params": [ { "textRaw": "`callback` {Function} Callback invoked when the close operation is completed", "name": "callback", "type": "Function", "desc": "Callback invoked when the close operation is completed", "optional": true } ] } ], "desc": "

Begins a graceful close of the QuicSession. Existing QuicStream instances\nwill be permitted to close naturally. New QuicStream instances will not be\npermitted. Once all QuicStream instances have closed, the QuicSession\ninstance will be destroyed.

" }, { "textRaw": "quicsession.destroy([error])", "type": "method", "name": "destroy", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "signatures": [ { "params": [ { "textRaw": "`error` {any}", "name": "error", "type": "any", "optional": true } ] } ], "desc": "

Destroys the QuicSession immediately causing the close event to be emitted.\nIf error is not undefined, the error event will be emitted immediately\nbefore the close event.

\n

Any QuicStream instances that are still opened will be abruptly closed.

" }, { "textRaw": "quicsession.getCertificate()", "type": "method", "name": "getCertificate", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "signatures": [ { "return": { "textRaw": "Returns: {Object} A [Certificate Object][].", "name": "return", "type": "Object", "desc": "A [Certificate Object][]." }, "params": [] } ], "desc": "

Returns an object representing the local certificate. The returned object has\nsome properties corresponding to the fields of the certificate.

\n

If there is no local certificate, or if the QuicSession has been destroyed,\nan empty object will be returned.

" }, { "textRaw": "quicsession.getPeerCertificate([detailed])", "type": "method", "name": "getPeerCertificate", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "signatures": [ { "return": { "textRaw": "Returns: {Object} A [Certificate Object][].", "name": "return", "type": "Object", "desc": "A [Certificate Object][]." }, "params": [ { "textRaw": "`detailed` {boolean} Include the full certificate chain if `true`, otherwise include just the peer's certificate. **Default**: `false`.", "name": "detailed", "type": "boolean", "desc": "Include the full certificate chain if `true`, otherwise include just the peer's certificate. **Default**: `false`.", "optional": true } ] } ], "desc": "

Returns an object representing the peer's certificate. If the peer does not\nprovide a certificate, or if the QuicSession has been destroyed, an empty\nobject will be returned.

\n

If the full certificate chain was requested (details equals true), each\ncertificate will include an issuerCertificate property containing an object\nrepresenting the issuer's certificate.

" }, { "textRaw": "quicsession.openStream([options])", "type": "method", "name": "openStream", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "signatures": [ { "return": { "textRaw": "Returns: {QuicStream}", "name": "return", "type": "QuicStream" }, "params": [ { "textRaw": "`options` {Object}", "name": "options", "type": "Object", "options": [ { "textRaw": "`halfOpen` {boolean} Set to `true` to open a unidirectional stream, `false` to open a bidirectional stream. **Default**: `true`.", "name": "halfOpen", "type": "boolean", "desc": "Set to `true` to open a unidirectional stream, `false` to open a bidirectional stream. **Default**: `true`." }, { "textRaw": "`highWaterMark` {number} Total number of bytes that the `QuicStream` may buffer internally before the `quicstream.write()` function starts returning `false`. Default: `16384`.", "name": "highWaterMark", "type": "number", "desc": "Total number of bytes that the `QuicStream` may buffer internally before the `quicstream.write()` function starts returning `false`. Default: `16384`." }, { "textRaw": "`defaultEncoding` {string} The default encoding that is used when no encoding is specified as an argument to `quicstream.write()`. Default: `'utf8'`.", "name": "defaultEncoding", "type": "string", "desc": "The default encoding that is used when no encoding is specified as an argument to `quicstream.write()`. Default: `'utf8'`." } ], "optional": true } ] } ], "desc": "

Returns a new QuicStream.

\n

An error will be thrown if the QuicSession has been destroyed or is in the\nprocess of a graceful shutdown.

" }, { "textRaw": "quicsession.ping()", "type": "method", "name": "ping", "signatures": [ { "params": [] } ], "desc": "\n

The ping() method will trigger the underlying QUIC connection to serialize\nany frames currently pending in the outbound queue if it is able to do so.\nThis has the effect of keeping the connection with the peer active and resets\nthe idle and retransmission timers. The ping() method is a best-effort\nthat ignores any errors that may occur during the serialization and send\noperations. There is no return value and there is no way to monitor the status\nof the ping() operation.

" }, { "textRaw": "quicsession.updateKey()", "type": "method", "name": "updateKey", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "signatures": [ { "return": { "textRaw": "Returns: {boolean} `true` if the key update operation is successfully initiated.", "name": "return", "type": "boolean", "desc": "`true` if the key update operation is successfully initiated." }, "params": [] } ], "desc": "

Initiates QuicSession key update.

\n

An error will be thrown if called before quicsession.handshakeConfirmed\nis equal to true.

" } ] }, { "textRaw": "Class: QuicClientSession extends QuicSession", "type": "class", "name": "QuicClientSession", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "\n

The QuicClientSession class implements the client side of a QUIC connection.\nInstances are created using the quicsocket.connect() method.

", "events": [ { "textRaw": "Event: `'OCSPResponse'`", "type": "event", "name": "OCSPResponse", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "params": [], "desc": "

Emitted when the QuicClientSession receives a requested OCSP certificate\nstatus response from the QUIC server peer.

\n

The callback is invoked with a single argument:

\n\n

Node.js does not perform any automatic validation or processing of the\nresponse.

\n

The 'OCSPResponse' event will not be emitted more than once.

" }, { "textRaw": "Event: `'sessionTicket'`", "type": "event", "name": "sessionTicket", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "params": [], "desc": "

The 'sessionTicket' event is emitted when a new TLS session ticket has been\ngenerated for the current QuicClientSession. The callback is invoked with\ntwo arguments:

\n\n

The sessionTicket and remoteTransportParams are useful when creating a new\nQuicClientSession to more quickly resume an existing session.

\n

The 'sessionTicket' event may be emitted multiple times.

" }, { "textRaw": "Event: `'qlog'`", "type": "event", "name": "qlog", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "params": [], "desc": "

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

\n" }, { "textRaw": "Event: `'usePreferredAddress'`", "type": "event", "name": "usePreferredAddress", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "params": [], "desc": "

The 'usePreferredAddress' event is emitted when the client QuicSession\nis updated to use the server-advertised preferred address. The callback is\ninvoked with a single address argument:

\n\n

This event is purely informational and will be emitted only when\npreferredAddressPolicy is set to 'accept'.

\n

The 'usePreferredAddress' event will not be emitted more than once.

" } ], "properties": [ { "textRaw": "`ephemeralKeyInfo` Type: {Object}", "type": "Object", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

An object representing the type, name, and size of parameter of an ephemeral\nkey exchange in Perfect Forward Secrecy on a client connection. It is an\nempty object when the key exchange is not ephemeral. The supported types are\n'DH' and 'ECDH'. The name property is available only when type is\n'ECDH'.

\n

For example: { type: 'ECDH', name: 'prime256v1', size: 256 }.

" }, { "textRaw": "`ready` Type: {boolean}", "type": "boolean", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

Set to true if the QuicClientSession is ready for use. False if the\nQuicSocket has not yet been bound.

" } ], "methods": [ { "textRaw": "quicclientsession.setSocket(socket, callback])", "type": "method", "name": "setSocket", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "signatures": [ { "params": [ { "textRaw": "`socket` {QuicSocket} A `QuicSocket` instance to move this session to.", "name": "socket", "type": "QuicSocket", "desc": "A `QuicSocket` instance to move this session to." }, { "textRaw": "`callback` {Function} A callback function that will be invoked once the migration to the new `QuicSocket` is complete.", "name": "callback", "type": "Function", "desc": "A callback function that will be invoked once the migration to the new `QuicSocket` is complete." } ] } ], "desc": "

Migrates the QuicClientSession to the given QuicSocket instance. If the new\nQuicSocket has not yet been bound to a local UDP port, it will be bound prior\nto attempting the migration. If the QuicClientSession is not yet ready to\nmigrate, the callback will be invoked with an Error using the code\nERR_OPERATION_FAILED.

" } ] }, { "textRaw": "Class: QuicServerSession extends QuicSession", "type": "class", "name": "QuicServerSession", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "\n

The QuicServerSession class implements the server side of a QUIC connection.\nInstances are created internally and are emitted using the QuicSocket\n'session' event.

", "events": [ { "textRaw": "Event: `'clientHello'`", "type": "event", "name": "clientHello", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "params": [], "desc": "

Emitted at the start of the TLS handshake when the QuicServerSession receives\nthe initial TLS Client Hello.

\n

The event handler is given a callback function that must be invoked for the\nhandshake to continue.

\n

The callback is invoked with four arguments:

\n\n

The 'clientHello' event will not be emitted more than once.

" }, { "textRaw": "Event: `'OCSPRequest'`", "type": "event", "name": "OCSPRequest", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "params": [], "desc": "

Emitted when the QuicServerSession has received a OCSP certificate status\nrequest as part of the TLS handshake.

\n

The callback is invoked with three arguments:

\n\n

The callback must be invoked in order for the TLS handshake to continue.

\n

The 'OCSPRequest' event will not be emitted more than once.

" } ], "methods": [ { "textRaw": "quicserversession.addContext(servername[, context])", "type": "method", "name": "addContext", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "signatures": [ { "params": [ { "textRaw": "`servername` {string} A DNS name to associate with the given context.", "name": "servername", "type": "string", "desc": "A DNS name to associate with the given context." }, { "textRaw": "`context` {tls.SecureContext} A TLS SecureContext to associate with the `servername`.", "name": "context", "type": "tls.SecureContext", "desc": "A TLS SecureContext to associate with the `servername`.", "optional": true } ] } ], "desc": "

TBD

" } ] }, { "textRaw": "Class: QuicSocket", "type": "class", "name": "QuicSocket", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

New instances of QuicSocket are created using the net.createQuicSocket()\nmethod, and can be used as both a client and a server.

", "events": [ { "textRaw": "Event: `'busy'`", "type": "event", "name": "busy", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "params": [], "desc": "

Emitted when the server busy state has been toggled using\nquicSocket.serverBusy = true | false. The callback is invoked with no\narguments. Use the quicsocket.serverBusy property to determine the\ncurrent status. This event is strictly informational.

\n
const { createQuicSocket } = require('net');\n\nconst socket = createQuicSocket();\n\nsocket.on('busy', () => {\n  if (socket.serverBusy)\n    console.log('Server is busy');\n  else\n    console.log('Server is not busy');\n});\n\nsocket.serverBusy = true;\nsocket.serverBusy = false;\n
\n

This 'busy' event may be emitted multiple times.

" }, { "textRaw": "Event: `'close'`", "type": "event", "name": "close", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "params": [], "desc": "

Emitted after the QuicSocket has been destroyed and is no longer usable.

\n

The 'close' event will not be emitted multiple times.

" }, { "textRaw": "Event: `'error'`", "type": "event", "name": "error", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "params": [], "desc": "

Emitted before the 'close' event if the QuicSocket was destroyed with an\nerror.

\n

The 'error' event will not be emitted multiple times.

" }, { "textRaw": "Event: `'listening'`", "type": "event", "name": "listening", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "params": [], "desc": "

Emitted after quicsocket.listen() is called and the QuicSocket has started\nlistening for incoming QuicServerSessions. The callback is invoked with\nno arguments.

\n

The 'listening' event will not be emitted multiple times.

" }, { "textRaw": "Event: `'ready'`", "type": "event", "name": "ready", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "params": [], "desc": "

Emitted once the QuicSocket has been bound to a local UDP port.

\n

The 'ready' event will not be emitted multiple times.

" }, { "textRaw": "Event: `'session'`", "type": "event", "name": "session", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "params": [], "desc": "

Emitted when a new QuicServerSession has been created. The callback is\ninvoked with a single argument providing the newly created QuicServerSession\nobject.

\n
const { createQuicSocket } = require('net');\n\nconst options = getOptionsSomehow();\nconst server = createQuicSocket({ server: options });\nserver.listen();\n\nserver.on('session', (session) => {\n  // Attach session event listeners.\n});\n
\n

The 'session' event will be emitted multiple times.

\n

The 'session' event handler may be an async function.

\n

If the 'session' event handler throws an error, or if it returns a Promise\nthat is rejected, the error will be handled by destroying the QuicServerSession\nautomatically and emitting a 'sessionError' event on the QuicSocket.

" }, { "textRaw": "Event: `'sessionError'`", "type": "event", "name": "sessionError", "params": [], "desc": "\n

Emitted when an error occurs processing an event related to a specific\nQuicSession instance. The callback is invoked with two arguments:

\n\n

The QuicSession instance will have been destroyed by the time the\n'sessionError' event is emitted.

\n
const { createQuicSocket } = require('net');\n\nconst options = getOptionsSomehow();\nconst server = createQuicSocket({ server: options });\nserver.listen();\n\nserver.on('session', (session) => {\n  throw new Error('boom');\n});\n\nserver.on('sessionError', (error, session) => {\n  console.log('error:', error.message);\n});\n
" } ], "methods": [ { "textRaw": "quicsocket.addEndpoint(options)", "type": "method", "name": "addEndpoint", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "signatures": [ { "return": { "textRaw": "Returns: {QuicEndpoint}", "name": "return", "type": "QuicEndpoint" }, "params": [ { "textRaw": "`options`: {Object} An object describing the local address to bind to.", "name": "options", "type": "Object", "desc": "An object describing the local address to bind to.", "options": [ { "textRaw": "`address` {string} The local address to bind to. This may be an IPv4 or IPv6 address or a host name. If a host name is given, it will be resolved to an IP address.", "name": "address", "type": "string", "desc": "The local address to bind to. This may be an IPv4 or IPv6 address or a host name. If a host name is given, it will be resolved to an IP address." }, { "textRaw": "`port` {number} The local port to bind to.", "name": "port", "type": "number", "desc": "The local port to bind to." }, { "textRaw": "`type` {string} Either `'udp4'` or `'upd6'` to use either IPv4 or IPv6, respectively. **Default**: `'udp4'`.", "name": "type", "type": "string", "desc": "Either `'udp4'` or `'upd6'` to use either IPv4 or IPv6, respectively. **Default**: `'udp4'`." }, { "textRaw": "`ipv6Only` {boolean} If `type` is `'udp6'`, then setting `ipv6Only` to `true` will disable dual-stack support on the UDP binding -- that is, binding to address `'::'` will not make `'0.0.0.0'` be bound. The option is ignored if `type` is `'udp4'`. **Default**: `false`.", "name": "ipv6Only", "type": "boolean", "desc": "If `type` is `'udp6'`, then setting `ipv6Only` to `true` will disable dual-stack support on the UDP binding -- that is, binding to address `'::'` will not make `'0.0.0.0'` be bound. The option is ignored if `type` is `'udp4'`. **Default**: `false`." } ] } ] } ], "desc": "

Creates and adds a new QuicEndpoint to the QuicSocket instance.

" }, { "textRaw": "quicsocket.close([callback])", "type": "method", "name": "close", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "signatures": [ { "params": [ { "textRaw": "`callback` {Function}", "name": "callback", "type": "Function", "optional": true } ] } ], "desc": "

Gracefully closes the QuicSocket. Existing QuicSession instances will be\npermitted to close naturally. New QuicClientSession and QuicServerSession\ninstances will not be allowed.

" }, { "textRaw": "quicsocket.connect([options])", "type": "method", "name": "connect", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "signatures": [ { "params": [ { "textRaw": "`options` {Object}", "name": "options", "type": "Object", "options": [ { "textRaw": "`address` {string} The domain name or IP address of the QUIC server endpoint.", "name": "address", "type": "string", "desc": "The domain name or IP address of the QUIC server endpoint." }, { "textRaw": "`alpn` {string} An ALPN protocol identifier.", "name": "alpn", "type": "string", "desc": "An ALPN protocol identifier." }, { "textRaw": "`ca` {string|string[]|Buffer|Buffer[]} Optionally override the trusted CA certificates. Default is to trust the well-known CAs curated by Mozilla. Mozilla's CAs are completely replaced when CAs are explicitly specified using this option. The value can be a string or `Buffer`, or an `Array` of strings and/or `Buffer`s. Any string or `Buffer` can contain multiple PEM CAs concatenated together. The peer's certificate must be chainable to a CA trusted by the server for the connection to be authenticated. When using certificates that are not chainable to a well-known CA, the certificate's CA must be explicitly specified as a trusted or the connection will fail to authenticate. If the peer uses a certificate that doesn't match or chain to one of the default CAs, use the `ca` option to provide a CA certificate that the peer's certificate can match or chain to. For self-signed certificates, the certificate is its own CA, and must be provided. For PEM encoded certificates, supported types are \"TRUSTED CERTIFICATE\", \"X509 CERTIFICATE\", and \"CERTIFICATE\".", "name": "ca", "type": "string|string[]|Buffer|Buffer[]", "desc": "Optionally override the trusted CA certificates. Default is to trust the well-known CAs curated by Mozilla. Mozilla's CAs are completely replaced when CAs are explicitly specified using this option. The value can be a string or `Buffer`, or an `Array` of strings and/or `Buffer`s. Any string or `Buffer` can contain multiple PEM CAs concatenated together. The peer's certificate must be chainable to a CA trusted by the server for the connection to be authenticated. When using certificates that are not chainable to a well-known CA, the certificate's CA must be explicitly specified as a trusted or the connection will fail to authenticate. If the peer uses a certificate that doesn't match or chain to one of the default CAs, use the `ca` option to provide a CA certificate that the peer's certificate can match or chain to. For self-signed certificates, the certificate is its own CA, and must be provided. For PEM encoded certificates, supported types are \"TRUSTED CERTIFICATE\", \"X509 CERTIFICATE\", and \"CERTIFICATE\"." }, { "textRaw": "`cert` {string|string[]|Buffer|Buffer[]} Cert chains in PEM format. One cert chain should be provided per private key. Each cert chain should consist of the PEM formatted certificate for a provided private `key`, followed by the PEM formatted intermediate certificates (if any), in order, and not including the root CA (the root CA must be pre-known to the peer, see `ca`). When providing multiple cert chains, they do not have to be in the same order as their private keys in `key`. If the intermediate certificates are not provided, the peer will not be able to validate the certificate, and the handshake will fail.", "name": "cert", "type": "string|string[]|Buffer|Buffer[]", "desc": "Cert chains in PEM format. One cert chain should be provided per private key. Each cert chain should consist of the PEM formatted certificate for a provided private `key`, followed by the PEM formatted intermediate certificates (if any), in order, and not including the root CA (the root CA must be pre-known to the peer, see `ca`). When providing multiple cert chains, they do not have to be in the same order as their private keys in `key`. If the intermediate certificates are not provided, the peer will not be able to validate the certificate, and the handshake will fail." }, { "textRaw": "`ciphers` {string} Cipher suite specification, replacing the default. For more information, see [modifying the default cipher suite][]. Permitted ciphers can be obtained via [`tls.getCiphers()`][]. Cipher names must be uppercased in order for OpenSSL to accept them.", "name": "ciphers", "type": "string", "desc": "Cipher suite specification, replacing the default. For more information, see [modifying the default cipher suite][]. Permitted ciphers can be obtained via [`tls.getCiphers()`][]. Cipher names must be uppercased in order for OpenSSL to accept them." }, { "textRaw": "`clientCertEngine` {string} Name of an OpenSSL engine which can provide the client certificate.", "name": "clientCertEngine", "type": "string", "desc": "Name of an OpenSSL engine which can provide the client certificate." }, { "textRaw": "`crl` {string|string[]|Buffer|Buffer[]} PEM formatted CRLs (Certificate Revocation Lists).", "name": "crl", "type": "string|string[]|Buffer|Buffer[]", "desc": "PEM formatted CRLs (Certificate Revocation Lists)." }, { "textRaw": "`defaultEncoding` {string} The default encoding that is used when no encoding is specified as an argument to `quicstream.write()`. Default: `'utf8'`.", "name": "defaultEncoding", "type": "string", "desc": "The default encoding that is used when no encoding is specified as an argument to `quicstream.write()`. Default: `'utf8'`." }, { "textRaw": "`dhparam` {string|Buffer} Diffie Hellman parameters, required for [Perfect Forward Secrecy][]. Use `openssl dhparam` to create the parameters. The key length must be greater than or equal to 1024 bits, otherwise an error will be thrown. It is strongly recommended to use 2048 bits or larger for stronger security. If omitted or invalid, the parameters are silently discarded and DHE ciphers will not be available.", "name": "dhparam", "type": "string|Buffer", "desc": "Diffie Hellman parameters, required for [Perfect Forward Secrecy][]. Use `openssl dhparam` to create the parameters. The key length must be greater than or equal to 1024 bits, otherwise an error will be thrown. It is strongly recommended to use 2048 bits or larger for stronger security. If omitted or invalid, the parameters are silently discarded and DHE ciphers will not be available." }, { "textRaw": "`ecdhCurve` {string} A string describing a named curve or a colon separated list of curve NIDs or names, for example `P-521:P-384:P-256`, to use for ECDH key agreement. Set to `auto` to select the curve automatically. Use [`crypto.getCurves()`][] to obtain a list of available curve names. On recent releases, `openssl ecparam -list_curves` will also display the name and description of each available elliptic curve. **Default:** [`tls.DEFAULT_ECDH_CURVE`][].", "name": "ecdhCurve", "type": "string", "default": "[`tls.DEFAULT_ECDH_CURVE`][]", "desc": "A string describing a named curve or a colon separated list of curve NIDs or names, for example `P-521:P-384:P-256`, to use for ECDH key agreement. Set to `auto` to select the curve automatically. Use [`crypto.getCurves()`][] to obtain a list of available curve names. On recent releases, `openssl ecparam -list_curves` will also display the name and description of each available elliptic curve." }, { "textRaw": "`highWaterMark` {number} Total number of bytes that the `QuicStream` may buffer internally before the `quicstream.write()` function starts returning `false`. Default: `16384`.", "name": "highWaterMark", "type": "number", "desc": "Total number of bytes that the `QuicStream` may buffer internally before the `quicstream.write()` function starts returning `false`. Default: `16384`." }, { "textRaw": "`honorCipherOrder` {boolean} Attempt to use the server's cipher suite preferences instead of the client's. When `true`, causes `SSL_OP_CIPHER_SERVER_PREFERENCE` to be set in `secureOptions`, see [OpenSSL Options][] for more information.", "name": "honorCipherOrder", "type": "boolean", "desc": "Attempt to use the server's cipher suite preferences instead of the client's. When `true`, causes `SSL_OP_CIPHER_SERVER_PREFERENCE` to be set in `secureOptions`, see [OpenSSL Options][] for more information." }, { "textRaw": "`idleTimeout` {number}", "name": "idleTimeout", "type": "number" }, { "textRaw": "`ipv6Only` {boolean} If `type` is `'udp6'`, then setting `ipv6Only` to `true` will disable dual-stack support on the UDP binding -- that is, binding to address `'::'` will not make `'0.0.0.0'` be bound. The option is ignored if `type` is `'udp4'`. **Default**: `false`.", "name": "ipv6Only", "type": "boolean", "desc": "If `type` is `'udp6'`, then setting `ipv6Only` to `true` will disable dual-stack support on the UDP binding -- that is, binding to address `'::'` will not make `'0.0.0.0'` be bound. The option is ignored if `type` is `'udp4'`. **Default**: `false`." }, { "textRaw": "`key` {string|string[]|Buffer|Buffer[]|Object[]} Private keys in PEM format. PEM allows the option of private keys being encrypted. Encrypted keys will be decrypted with `options.passphrase`. Multiple keys using different algorithms can be provided either as an array of unencrypted key strings or buffers, or an array of objects in the form `{pem: [, passphrase: ]}`. The object form can only occur in an array. `object.passphrase` is optional. Encrypted keys will be decrypted with `object.passphrase` if provided, or `options.passphrase` if it is not.", "name": "key", "type": "string|string[]|Buffer|Buffer[]|Object[]", "desc": "Private keys in PEM format. PEM allows the option of private keys being encrypted. Encrypted keys will be decrypted with `options.passphrase`. Multiple keys using different algorithms can be provided either as an array of unencrypted key strings or buffers, or an array of objects in the form `{pem: [, passphrase: ]}`. The object form can only occur in an array. `object.passphrase` is optional. Encrypted keys will be decrypted with `object.passphrase` if provided, or `options.passphrase` if it is not." }, { "textRaw": "`activeConnectionIdLimit` {number} Must be a value between `2` and `8` (inclusive). Default: `2`.", "name": "activeConnectionIdLimit", "type": "number", "desc": "Must be a value between `2` and `8` (inclusive). Default: `2`." }, { "textRaw": "`congestionAlgorithm` {string} Must be either `'reno'` or `'cubic'`. **Default**: `'reno'`.", "name": "congestionAlgorithm", "type": "string", "desc": "Must be either `'reno'` or `'cubic'`. **Default**: `'reno'`." }, { "textRaw": "`maxAckDelay` {number}", "name": "maxAckDelay", "type": "number" }, { "textRaw": "`maxData` {number}", "name": "maxData", "type": "number" }, { "textRaw": "`maxUdpPayloadSize` {number}", "name": "maxUdpPayloadSize", "type": "number" }, { "textRaw": "`maxStreamDataBidiLocal` {number}", "name": "maxStreamDataBidiLocal", "type": "number" }, { "textRaw": "`maxStreamDataBidiRemote` {number}", "name": "maxStreamDataBidiRemote", "type": "number" }, { "textRaw": "`maxStreamDataUni` {number}", "name": "maxStreamDataUni", "type": "number" }, { "textRaw": "`maxStreamsBidi` {number}", "name": "maxStreamsBidi", "type": "number" }, { "textRaw": "`maxStreamsUni` {number}", "name": "maxStreamsUni", "type": "number" }, { "textRaw": "`h3` {Object} HTTP/3 Specific Configuration Options", "name": "h3", "type": "Object", "desc": "HTTP/3 Specific Configuration Options", "options": [ { "textRaw": "`qpackMaxTableCapacity` {number}", "name": "qpackMaxTableCapacity", "type": "number" }, { "textRaw": "`qpackBlockedStreams` {number}", "name": "qpackBlockedStreams", "type": "number" }, { "textRaw": "`maxHeaderListSize` {number}", "name": "maxHeaderListSize", "type": "number" }, { "textRaw": "`maxPushes` {number}", "name": "maxPushes", "type": "number" } ] }, { "textRaw": "`passphrase` {string} Shared passphrase used for a single private key and/or a PFX.", "name": "passphrase", "type": "string", "desc": "Shared passphrase used for a single private key and/or a PFX." }, { "textRaw": "`pfx` {string|string[]|Buffer|Buffer[]|Object[]} PFX or PKCS12 encoded private key and certificate chain. `pfx` is an alternative to providing `key` and `cert` individually. PFX is usually encrypted, if it is, `passphrase` will be used to decrypt it. Multiple PFX can be provided either as an array of unencrypted PFX buffers, or an array of objects in the form `{buf: [, passphrase: ]}`. The object form can only occur in an array. `object.passphrase` is optional. Encrypted PFX will be decrypted with `object.passphrase` if provided, or `options.passphrase` if it is not.", "name": "pfx", "type": "string|string[]|Buffer|Buffer[]|Object[]", "desc": "PFX or PKCS12 encoded private key and certificate chain. `pfx` is an alternative to providing `key` and `cert` individually. PFX is usually encrypted, if it is, `passphrase` will be used to decrypt it. Multiple PFX can be provided either as an array of unencrypted PFX buffers, or an array of objects in the form `{buf: [, passphrase: ]}`. The object form can only occur in an array. `object.passphrase` is optional. Encrypted PFX will be decrypted with `object.passphrase` if provided, or `options.passphrase` if it is not." }, { "textRaw": "`port` {number} The IP port of the remote QUIC server.", "name": "port", "type": "number", "desc": "The IP port of the remote QUIC server." }, { "textRaw": "`preferredAddressPolicy` {string} `'accept'` or `'reject'`. When `'accept'`, indicates that the client will automatically use the preferred address advertised by the server.", "name": "preferredAddressPolicy", "type": "string", "desc": "`'accept'` or `'reject'`. When `'accept'`, indicates that the client will automatically use the preferred address advertised by the server." }, { "textRaw": "`remoteTransportParams` {Buffer|TypedArray|DataView} The serialized remote transport parameters from a previously established session. These would have been provided as part of the `'sessionTicket'` event on a previous `QuicClientSession` object.", "name": "remoteTransportParams", "type": "Buffer|TypedArray|DataView", "desc": "The serialized remote transport parameters from a previously established session. These would have been provided as part of the `'sessionTicket'` event on a previous `QuicClientSession` object." }, { "textRaw": "`qlog` {boolean} Whether to enable ['qlog'][] for this session. Default: `false`.", "name": "qlog", "type": "boolean", "desc": "Whether to enable ['qlog'][] for this session. Default: `false`." }, { "textRaw": "`requestOCSP` {boolean} If `true`, specifies that the OCSP status request extension will be added to the client hello and an `'OCSPResponse'` event will be emitted before establishing a secure communication.", "name": "requestOCSP", "type": "boolean", "desc": "If `true`, specifies that the OCSP status request extension will be added to the client hello and an `'OCSPResponse'` event will be emitted before establishing a secure communication." }, { "textRaw": "`secureOptions` {number} Optionally affect the OpenSSL protocol behavior, which is not usually necessary. This should be used carefully if at all! Value is a numeric bitmask of the `SSL_OP_*` options from [OpenSSL Options][].", "name": "secureOptions", "type": "number", "desc": "Optionally affect the OpenSSL protocol behavior, which is not usually necessary. This should be used carefully if at all! Value is a numeric bitmask of the `SSL_OP_*` options from [OpenSSL Options][]." }, { "textRaw": "`servername` {string} The SNI servername.", "name": "servername", "type": "string", "desc": "The SNI servername." }, { "textRaw": "`sessionTicket`: {Buffer|TypedArray|DataView} The serialized TLS Session Ticket from a previously established session. These would have been provided as part of the `'sessionTicket`' event on a previous `QuicClientSession` object.", "name": "sessionTicket", "type": "Buffer|TypedArray|DataView", "desc": "The serialized TLS Session Ticket from a previously established session. These would have been provided as part of the `'sessionTicket`' event on a previous `QuicClientSession` object." }, { "textRaw": "`type`: {string} Identifies the type of UDP socket. The value must either be `'udp4'`, indicating UDP over IPv4, or `'udp6'`, indicating UDP over IPv6. **Default**: `'udp4'`.", "name": "type", "type": "string", "desc": "Identifies the type of UDP socket. The value must either be `'udp4'`, indicating UDP over IPv4, or `'udp6'`, indicating UDP over IPv6. **Default**: `'udp4'`." } ], "optional": true } ] } ], "desc": "

Create a new QuicClientSession. This function can be called multiple times\nto create sessions associated with different endpoints on the same\nclient endpoint.

" }, { "textRaw": "quicsocket.destroy([error])", "type": "method", "name": "destroy", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "signatures": [ { "params": [ { "textRaw": "`error` {any}", "name": "error", "type": "any", "optional": true } ] } ], "desc": "

Destroys the QuicSocket then emits the 'close' event when done. The 'error'\nevent will be emitted after 'close' if the error is not undefined.

" }, { "textRaw": "quicsocket.listen([options][, callback])", "type": "method", "name": "listen", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "signatures": [ { "params": [ { "textRaw": "`options` {Object}", "name": "options", "type": "Object", "options": [ { "textRaw": "`alpn` {string} A required ALPN protocol identifier.", "name": "alpn", "type": "string", "desc": "A required ALPN protocol identifier." }, { "textRaw": "`ca` {string|string[]|Buffer|Buffer[]} Optionally override the trusted CA certificates. Default is to trust the well-known CAs curated by Mozilla. Mozilla's CAs are completely replaced when CAs are explicitly specified using this option. The value can be a string or `Buffer`, or an `Array` of strings and/or `Buffer`s. Any string or `Buffer` can contain multiple PEM CAs concatenated together. The peer's certificate must be chainable to a CA trusted by the server for the connection to be authenticated. When using certificates that are not chainable to a well-known CA, the certificate's CA must be explicitly specified as a trusted or the connection will fail to authenticate. If the peer uses a certificate that doesn't match or chain to one of the default CAs, use the `ca` option to provide a CA certificate that the peer's certificate can match or chain to. For self-signed certificates, the certificate is its own CA, and must be provided. For PEM encoded certificates, supported types are \"TRUSTED CERTIFICATE\", \"X509 CERTIFICATE\", and \"CERTIFICATE\".", "name": "ca", "type": "string|string[]|Buffer|Buffer[]", "desc": "Optionally override the trusted CA certificates. Default is to trust the well-known CAs curated by Mozilla. Mozilla's CAs are completely replaced when CAs are explicitly specified using this option. The value can be a string or `Buffer`, or an `Array` of strings and/or `Buffer`s. Any string or `Buffer` can contain multiple PEM CAs concatenated together. The peer's certificate must be chainable to a CA trusted by the server for the connection to be authenticated. When using certificates that are not chainable to a well-known CA, the certificate's CA must be explicitly specified as a trusted or the connection will fail to authenticate. If the peer uses a certificate that doesn't match or chain to one of the default CAs, use the `ca` option to provide a CA certificate that the peer's certificate can match or chain to. For self-signed certificates, the certificate is its own CA, and must be provided. For PEM encoded certificates, supported types are \"TRUSTED CERTIFICATE\", \"X509 CERTIFICATE\", and \"CERTIFICATE\"." }, { "textRaw": "`cert` {string|string[]|Buffer|Buffer[]} Cert chains in PEM format. One cert chain should be provided per private key. Each cert chain should consist of the PEM formatted certificate for a provided private `key`, followed by the PEM formatted intermediate certificates (if any), in order, and not including the root CA (the root CA must be pre-known to the peer, see `ca`). When providing multiple cert chains, they do not have to be in the same order as their private keys in `key`. If the intermediate certificates are not provided, the peer will not be able to validate the certificate, and the handshake will fail.", "name": "cert", "type": "string|string[]|Buffer|Buffer[]", "desc": "Cert chains in PEM format. One cert chain should be provided per private key. Each cert chain should consist of the PEM formatted certificate for a provided private `key`, followed by the PEM formatted intermediate certificates (if any), in order, and not including the root CA (the root CA must be pre-known to the peer, see `ca`). When providing multiple cert chains, they do not have to be in the same order as their private keys in `key`. If the intermediate certificates are not provided, the peer will not be able to validate the certificate, and the handshake will fail." }, { "textRaw": "`ciphers` {string} Cipher suite specification, replacing the default. For more information, see [modifying the default cipher suite][]. Permitted ciphers can be obtained via [`tls.getCiphers()`][]. Cipher names must be uppercased in order for OpenSSL to accept them.", "name": "ciphers", "type": "string", "desc": "Cipher suite specification, replacing the default. For more information, see [modifying the default cipher suite][]. Permitted ciphers can be obtained via [`tls.getCiphers()`][]. Cipher names must be uppercased in order for OpenSSL to accept them." }, { "textRaw": "`clientCertEngine` {string} Name of an OpenSSL engine which can provide the client certificate.", "name": "clientCertEngine", "type": "string", "desc": "Name of an OpenSSL engine which can provide the client certificate." }, { "textRaw": "`crl` {string|string[]|Buffer|Buffer[]} PEM formatted CRLs (Certificate Revocation Lists).", "name": "crl", "type": "string|string[]|Buffer|Buffer[]", "desc": "PEM formatted CRLs (Certificate Revocation Lists)." }, { "textRaw": "`defaultEncoding` {string} The default encoding that is used when no encoding is specified as an argument to `quicstream.write()`. Default: `'utf8'`.", "name": "defaultEncoding", "type": "string", "desc": "The default encoding that is used when no encoding is specified as an argument to `quicstream.write()`. Default: `'utf8'`." }, { "textRaw": "`dhparam` {string|Buffer} Diffie Hellman parameters, required for [Perfect Forward Secrecy][]. Use `openssl dhparam` to create the parameters. The key length must be greater than or equal to 1024 bits, otherwise an error will be thrown. It is strongly recommended to use 2048 bits or larger for stronger security. If omitted or invalid, the parameters are silently discarded and DHE ciphers will not be available.", "name": "dhparam", "type": "string|Buffer", "desc": "Diffie Hellman parameters, required for [Perfect Forward Secrecy][]. Use `openssl dhparam` to create the parameters. The key length must be greater than or equal to 1024 bits, otherwise an error will be thrown. It is strongly recommended to use 2048 bits or larger for stronger security. If omitted or invalid, the parameters are silently discarded and DHE ciphers will not be available." }, { "textRaw": "`earlyData` {boolean} Set to `false` to disable 0RTT early data. Default: `true`.", "name": "earlyData", "type": "boolean", "desc": "Set to `false` to disable 0RTT early data. Default: `true`." }, { "textRaw": "`ecdhCurve` {string} A string describing a named curve or a colon separated list of curve NIDs or names, for example `P-521:P-384:P-256`, to use for ECDH key agreement. Set to `auto` to select the curve automatically. Use [`crypto.getCurves()`][] to obtain a list of available curve names. On recent releases, `openssl ecparam -list_curves` will also display the name and description of each available elliptic curve. **Default:** [`tls.DEFAULT_ECDH_CURVE`][].", "name": "ecdhCurve", "type": "string", "default": "[`tls.DEFAULT_ECDH_CURVE`][]", "desc": "A string describing a named curve or a colon separated list of curve NIDs or names, for example `P-521:P-384:P-256`, to use for ECDH key agreement. Set to `auto` to select the curve automatically. Use [`crypto.getCurves()`][] to obtain a list of available curve names. On recent releases, `openssl ecparam -list_curves` will also display the name and description of each available elliptic curve." }, { "textRaw": "`highWaterMark` {number} Total number of bytes that `QuicStream` instances may buffer internally before the `quicstream.write()` function starts returning `false`. Default: `16384`.", "name": "highWaterMark", "type": "number", "desc": "Total number of bytes that `QuicStream` instances may buffer internally before the `quicstream.write()` function starts returning `false`. Default: `16384`." }, { "textRaw": "`honorCipherOrder` {boolean} Attempt to use the server's cipher suite references instead of the client's. When `true`, causes `SSL_OP_CIPHER_SERVER_PREFERENCE` to be set in `secureOptions`, see [OpenSSL Options][] for more information.", "name": "honorCipherOrder", "type": "boolean", "desc": "Attempt to use the server's cipher suite references instead of the client's. When `true`, causes `SSL_OP_CIPHER_SERVER_PREFERENCE` to be set in `secureOptions`, see [OpenSSL Options][] for more information." }, { "textRaw": "`idleTimeout` {number}", "name": "idleTimeout", "type": "number" }, { "textRaw": "`key` {string|string[]|Buffer|Buffer[]|Object[]} Private keys in PEM format. PEM allows the option of private keys being encrypted. Encrypted keys will be decrypted with `options.passphrase`. Multiple keys using different algorithms can be provided either as an array of unencrypted key strings or buffers, or an array of objects in the form `{pem: [, passphrase: ]}`. The object form can only occur in an array. `object.passphrase` is optional. Encrypted keys will be decrypted with `object.passphrase` if provided, or `options.passphrase` if it is not.", "name": "key", "type": "string|string[]|Buffer|Buffer[]|Object[]", "desc": "Private keys in PEM format. PEM allows the option of private keys being encrypted. Encrypted keys will be decrypted with `options.passphrase`. Multiple keys using different algorithms can be provided either as an array of unencrypted key strings or buffers, or an array of objects in the form `{pem: [, passphrase: ]}`. The object form can only occur in an array. `object.passphrase` is optional. Encrypted keys will be decrypted with `object.passphrase` if provided, or `options.passphrase` if it is not." }, { "textRaw": "`activeConnectionIdLimit` {number}", "name": "activeConnectionIdLimit", "type": "number" }, { "textRaw": "`congestionAlgorithm` {string} Must be either `'reno'` or `'cubic'`. **Default**: `'reno'`.", "name": "congestionAlgorithm", "type": "string", "desc": "Must be either `'reno'` or `'cubic'`. **Default**: `'reno'`." }, { "textRaw": "`maxAckDelay` {number}", "name": "maxAckDelay", "type": "number" }, { "textRaw": "`maxData` {number}", "name": "maxData", "type": "number" }, { "textRaw": "`maxUdpPayloadSize` {number}", "name": "maxUdpPayloadSize", "type": "number" }, { "textRaw": "`maxStreamsBidi` {number}", "name": "maxStreamsBidi", "type": "number" }, { "textRaw": "`maxStreamsUni` {number}", "name": "maxStreamsUni", "type": "number" }, { "textRaw": "`maxStreamDataBidiLocal` {number}", "name": "maxStreamDataBidiLocal", "type": "number" }, { "textRaw": "`maxStreamDataBidiRemote` {number}", "name": "maxStreamDataBidiRemote", "type": "number" }, { "textRaw": "`maxStreamDataUni` {number}", "name": "maxStreamDataUni", "type": "number" }, { "textRaw": "`passphrase` {string} Shared passphrase used for a single private key and/or a PFX.", "name": "passphrase", "type": "string", "desc": "Shared passphrase used for a single private key and/or a PFX." }, { "textRaw": "`pfx` {string|string[]|Buffer|Buffer[]|Object[]} PFX or PKCS12 encoded private key and certificate chain. `pfx` is an alternative to providing `key` and `cert` individually. PFX is usually encrypted, if it is, `passphrase` will be used to decrypt it. Multiple PFX can be provided either as an array of unencrypted PFX buffers, or an array of objects in the form `{buf: [, passphrase: ]}`. The object form can only occur in an array. `object.passphrase` is optional. Encrypted PFX will be decrypted with `object.passphrase` if provided, or `options.passphrase` if it is not.", "name": "pfx", "type": "string|string[]|Buffer|Buffer[]|Object[]", "desc": "PFX or PKCS12 encoded private key and certificate chain. `pfx` is an alternative to providing `key` and `cert` individually. PFX is usually encrypted, if it is, `passphrase` will be used to decrypt it. Multiple PFX can be provided either as an array of unencrypted PFX buffers, or an array of objects in the form `{buf: [, passphrase: ]}`. The object form can only occur in an array. `object.passphrase` is optional. Encrypted PFX will be decrypted with `object.passphrase` if provided, or `options.passphrase` if it is not." }, { "textRaw": "`preferredAddress` {Object}", "name": "preferredAddress", "type": "Object", "options": [ { "textRaw": "`address` {string}", "name": "address", "type": "string" }, { "textRaw": "`port` {number}", "name": "port", "type": "number" }, { "textRaw": "`type` {string} `'udp4'` or `'udp6'`.", "name": "type", "type": "string", "desc": "`'udp4'` or `'udp6'`." } ] }, { "textRaw": "`requestCert` {boolean} Request a certificate used to authenticate the client.", "name": "requestCert", "type": "boolean", "desc": "Request a certificate used to authenticate the client." }, { "textRaw": "`rejectUnauthorized` {boolean} If not `false` the server will reject any connection which is not authorized with the list of supplied CAs. This option only has an effect if `requestCert` is `true`. Default: `true`.", "name": "rejectUnauthorized", "type": "boolean", "desc": "If not `false` the server will reject any connection which is not authorized with the list of supplied CAs. This option only has an effect if `requestCert` is `true`. Default: `true`." }, { "textRaw": "`secureOptions` {number} Optionally affect the OpenSSL protocol behavior, which is not usually necessary. This should be used carefully if at all! Value is a numeric bitmask of the `SSL_OP_*` options from [OpenSSL Options][].", "name": "secureOptions", "type": "number", "desc": "Optionally affect the OpenSSL protocol behavior, which is not usually necessary. This should be used carefully if at all! Value is a numeric bitmask of the `SSL_OP_*` options from [OpenSSL Options][]." }, { "textRaw": "`sessionIdContext` {string} Opaque identifier used by servers to ensure session state is not shared between applications. Unused by clients.", "name": "sessionIdContext", "type": "string", "desc": "Opaque identifier used by servers to ensure session state is not shared between applications. Unused by clients." } ], "optional": true }, { "textRaw": "`callback` {Function}", "name": "callback", "type": "Function", "optional": true } ] } ], "desc": "

Listen for new peer-initiated sessions.

\n

If a callback is given, it is registered as a handler for the\n'session' event.

" }, { "textRaw": "quicsocket.ref()", "type": "method", "name": "ref", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "signatures": [ { "params": [] } ] }, { "textRaw": "quicsocket.setDiagnosticPacketLoss(options)", "type": "method", "name": "setDiagnosticPacketLoss", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "signatures": [ { "params": [ { "textRaw": "`options` {Object}", "name": "options", "type": "Object", "options": [ { "textRaw": "`rx` {number} A value in the range `0.0` to `1.0` that specifies the probability of received packet loss.", "name": "rx", "type": "number", "desc": "A value in the range `0.0` to `1.0` that specifies the probability of received packet loss." }, { "textRaw": "`tx` {number} A value in the range `0.0` to `1.0` that specifies the probability of transmitted packet loss.", "name": "tx", "type": "number", "desc": "A value in the range `0.0` to `1.0` that specifies the probability of transmitted packet loss." } ] } ] } ], "desc": "

The quicsocket.setDiagnosticPacketLoss() method is a diagnostic only tool\nthat can be used to simulate packet loss conditions for this QuicSocket\nby artificially dropping received or transmitted packets.

\n

This method is not to be used in production applications.

" }, { "textRaw": "quicsocket.toggleStatelessReset()", "type": "method", "name": "toggleStatelessReset", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "signatures": [ { "return": { "textRaw": "Returns {boolean} `true` if stateless reset processing is enabled; `false` if disabled.", "name": "return", "type": "boolean", "desc": "`true` if stateless reset processing is enabled; `false` if disabled." }, "params": [] } ], "desc": "

By default, a listening QuicSocket will generate stateless reset tokens when\nappropriate. The disableStatelessReset option may be set when the\nQuicSocket is created to disable generation of stateless resets. The\ntoggleStatelessReset() function allows stateless reset to be turned on and\noff dynamically through the lifetime of the QuicSocket.

" } ], "properties": [ { "textRaw": "`bound` Type: {boolean}", "type": "boolean", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

Will be true if the QuicSocket has been successfully bound to a local UDP\nport. Initially the value is false.

\n

QuicSocket instances are not bound to a local UDP port until the first time\neithe quicsocket.listen() or quicsocket.connect() is called. The 'ready'\nevent will be emitted once the QuicSocket has been bound and the value of\nquicsocket.bound will become true.

\n

Read-only.

" }, { "textRaw": "`boundDuration` Type: {number}", "type": "number", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

The length of time this QuicSocket has been bound to a local port.

\n

Read-only.

" }, { "textRaw": "`bytesReceived` Type: {number}", "type": "number", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

The number of bytes received by this QuicSocket.

\n

Read-only.

" }, { "textRaw": "`bytesSent` Type: {number}", "type": "number", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

The number of bytes sent by this QuicSocket.

\n

Read-only.

" }, { "textRaw": "`clientSessions` Type: {number}", "type": "number", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

The number of client QuicSession instances that have been associated\nwith this QuicSocket.

\n

Read-only.

" }, { "textRaw": "`destroyed` Type: {boolean}", "type": "boolean", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

Will be true if the QuicSocket has been destroyed.

" }, { "textRaw": "`duration` Type: {number}", "type": "number", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

The length of time this QuicSocket has been active,

\n

Read-only.

" }, { "textRaw": "`endpoints` Type: {QuicEndpoint[]}", "type": "QuicEndpoint[]", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

An array of QuicEndpoint instances associated with the QuicSocket.

" }, { "textRaw": "`listenDuration` Type: {number}", "type": "number", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

The length of time this QuicSocket has been listening for connections.

\n

Read-only

" }, { "textRaw": "`listening` Type: {boolean}", "type": "boolean", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

Set to true if the QuicSocket is listening for new connections.

" }, { "textRaw": "`packetsIgnored` Type: {number}", "type": "number", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

The number of packets received by this QuicSocket that have been ignored.

\n

Read-only.

" }, { "textRaw": "`packetsReceived` Type: {number}", "type": "number", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

The number of packets successfully received by this QuicSocket.

\n

Read-only

" }, { "textRaw": "`packetsSent` Type: {number}", "type": "number", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

The number of packets sent by this QuicSocket.

\n

Read-only

" }, { "textRaw": "`pending` Type: {boolean}", "type": "boolean", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

Set to true if the socket is not yet bound to the local UDP port.

" }, { "textRaw": "`serverBusy` Type: {boolean} When `true`, the `QuicSocket` will reject new connections.", "type": "boolean", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

Setting quicsocket.serverBusy to true will tell the QuicSocket\nto reject all new incoming connection requests using the SERVER_BUSY QUIC\nerror code. To begin receiving connections again, disable busy mode by setting\nquicsocket.serverBusy = false.

", "shortDesc": "When `true`, the `QuicSocket` will reject new connections." }, { "textRaw": "`serverBusyCount` Type: {number}", "type": "number", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

The number of QuicSession instances rejected due to server busy status.

\n

Read-only.

" }, { "textRaw": "`serverSessions` Type: {number}", "type": "number", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

The number of server QuicSession instances that have been associated with\nthis QuicSocket.

\n

Read-only.

" }, { "textRaw": "`statelessResetCount` Type: {number}", "type": "number", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

The number of stateless resets that have been sent.

\n

Read-only.

" } ], "modules": [ { "textRaw": "quicsocket.unref();", "name": "quicsocket.unref();", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "type": "module", "displayName": "quicsocket.unref();" } ] }, { "textRaw": "Class: QuicStream extends stream.Duplex", "type": "class", "name": "QuicStream", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "", "events": [ { "textRaw": "Event: `'blocked'`", "type": "event", "name": "blocked", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "params": [], "desc": "

Emitted when the QuicStream has been prevented from sending queued data for\nthe QuicStream due to congestion control.

" }, { "textRaw": "Event: `'close'`", "type": "event", "name": "close", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "params": [], "desc": "

Emitted when the QuicStream has is completely closed and the underlying\nresources have been freed.

" }, { "textRaw": "Event: `'data'`", "type": "event", "name": "data", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "params": [] }, { "textRaw": "Event: `'end'`", "type": "event", "name": "end", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "params": [] }, { "textRaw": "Event: `'error'`", "type": "event", "name": "error", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "params": [] }, { "textRaw": "Event: `'informationalHeaders'`", "type": "event", "name": "informationalHeaders", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "params": [], "desc": "

Emitted when the QuicStream has received a block of informational headers.

\n

Support for headers depends entirely on the QUIC Application used as identified\nby the alpn configuration option. In QUIC Applications that support headers,\ninformational header blocks typically come before initial headers.

\n

The event handler is invoked with a single argument representing the block of\nHeaders as an object.

\n
stream('informationalHeaders', (headers) => {\n  // Use headers\n});\n
" }, { "textRaw": "Event: `'initialHeaders'`", "type": "event", "name": "initialHeaders", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "params": [], "desc": "

Emitted when the QuicStream has received a block of initial headers.

\n

Support for headers depends entirely on the QUIC Application used as identified\nby the alpn configuration option. HTTP/3, for instance, supports two kinds of\ninitial headers: request headers for HTTP request messages and response headers\nfor HTTP response messages. For HTTP/3 QUIC streams, request and response\nheaders are each emitted using the 'initialHeaders' event.

\n

The event handler is invoked with a single argument representing the block of\nHeaders as an object.

\n
stream('initialHeaders', (headers) => {\n  // Use headers\n});\n
" }, { "textRaw": "Event: `'ready'`", "type": "event", "name": "ready", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "params": [], "desc": "

Emitted when the underlying QuicSession has emitted its secure event\nthis stream has received its id, which is accessible as stream.id once this\nevent is emitted.

" }, { "textRaw": "Event: `'trailingHeaders'`", "type": "event", "name": "trailingHeaders", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "params": [], "desc": "

Emitted when the QuicStream has received a block of trailing headers.

\n

Support for headers depends entirely on the QUIC Application used as identified\nby the alpn configuration option. Trailing headers typically follow any data\ntransmitted on the QuicStream, and therefore typically emit sometime after the\nlast 'data' event but before the 'close' event. The precise timing may\nvary from one QUIC application to another.

\n

The event handler is invoked with a single argument representing the block of\nHeaders as an object.

\n
stream('trailingHeaders', (headers) => {\n  // Use headers\n});\n
" }, { "textRaw": "Event: `'readable'`", "type": "event", "name": "readable", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "params": [] } ], "properties": [ { "textRaw": "`aborted` Type: {boolean}", "type": "boolean", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

True if dataflow on the QuicStream was prematurely terminated.

" }, { "textRaw": "quicstream.bidirectional", "name": "bidirectional", "desc": "\n\n

Set to true if the QuicStream is bidirectional.

" }, { "textRaw": "`bytesReceived` Type: {number}", "type": "number", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

The total number of bytes received for this QuicStream.

" }, { "textRaw": "`bytesSent` Type: {number}", "type": "number", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

The total number of bytes sent by this QuicStream.

" }, { "textRaw": "`clientInitiated` Type: {boolean}", "type": "boolean", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

Set to true if the QuicStream was initiated by a QuicClientSession\ninstance.

" }, { "textRaw": "quicstream.dataAckHistogram", "name": "dataAckHistogram", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

TBD

" }, { "textRaw": "quicstream.dataRateHistogram", "name": "dataRateHistogram", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

TBD

" }, { "textRaw": "quicstream.dataSizeHistogram", "name": "dataSizeHistogram", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

TBD

" }, { "textRaw": "`duration` Type: {number}", "type": "number", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

The length of time the QuicStream has been active.

" }, { "textRaw": "`finalSize` Type: {number}", "type": "number", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

The total number of bytes successfully received by the QuicStream.

" }, { "textRaw": "`id` Type: {number}", "type": "number", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

The numeric identifier of the QuicStream.

" }, { "textRaw": "`maxAcknowledgedOffset` Type: {number}", "type": "number", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

The highest acknowledged data offset received for this QuicStream.

" }, { "textRaw": "`maxExtendedOffset` Type: {number}", "type": "number", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

The maximum extended data offset that has been reported to the connected peer.

" }, { "textRaw": "`maxReceivedOffset` Type: {number}", "type": "number", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

The maximum received offset for this QuicStream.

" }, { "textRaw": "`pending` {boolean}", "type": "boolean", "name": "pending", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

This property is true if the underlying session is not finished yet,\ni.e. before the 'ready' event is emitted.

" }, { "textRaw": "`serverInitiated` Type: {boolean}", "type": "boolean", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

Set to true if the QuicStream was initiated by a QuicServerSession\ninstance.

" }, { "textRaw": "`session` Type: {QuicSession}", "type": "QuicSession", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

The QuicServerSession or QuicClientSession.

" }, { "textRaw": "`unidirectional` Type: {boolean}", "type": "boolean", "name": "Type", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "desc": "

Set to true if the QuicStream is unidirectional.

" } ], "methods": [ { "textRaw": "quicstream.close(code)", "type": "method", "name": "close", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "signatures": [ { "params": [ { "textRaw": "`code` {number}", "name": "code", "type": "number" } ] } ], "desc": "

Closes the QuicStream.

" }, { "textRaw": "quicstream.pushStream(headers[, options])", "type": "method", "name": "pushStream", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "signatures": [ { "return": { "textRaw": "Returns: {QuicStream}", "name": "return", "type": "QuicStream" }, "params": [ { "textRaw": "`headers` {Object} An object representing a block of headers to be transmitted with the push promise.", "name": "headers", "type": "Object", "desc": "An object representing a block of headers to be transmitted with the push promise." }, { "textRaw": "`options` {Object}", "name": "options", "type": "Object", "options": [ { "textRaw": "`highWaterMark` {number} Total number of bytes that the `QuicStream` may buffer internally before the `quicstream.write()` function starts returning `false`. Default: `16384`.", "name": "highWaterMark", "type": "number", "desc": "Total number of bytes that the `QuicStream` may buffer internally before the `quicstream.write()` function starts returning `false`. Default: `16384`." }, { "textRaw": "`defaultEncoding` {string} The default encoding that is used when no encoding is specified as an argument to `quicstream.write()`. Default: `'utf8'`.", "name": "defaultEncoding", "type": "string", "desc": "The default encoding that is used when no encoding is specified as an argument to `quicstream.write()`. Default: `'utf8'`." } ], "optional": true } ] } ], "desc": "

If the selected QUIC application protocol supports push streams, then the\npushStream() method will initiate a new push promise and create a new\nunidirectional QuicStream object used to fulfill that push.

\n

Currently only HTTP/3 supports the use of pushStream().

\n

If the selected QUIC application protocol does not support push streams, an\nerror will be thrown.

" }, { "textRaw": "quicstream.sendFD(fd[, options])", "type": "method", "name": "sendFD", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "signatures": [ { "params": [ { "textRaw": "`fd` {number|FileHandle} A readable file descriptor.", "name": "fd", "type": "number|FileHandle", "desc": "A readable file descriptor." }, { "textRaw": "`options` {Object}", "name": "options", "type": "Object", "options": [ { "textRaw": "`offset` {number} The offset position at which to begin reading. Default: `-1`.", "name": "offset", "type": "number", "desc": "The offset position at which to begin reading. Default: `-1`." }, { "textRaw": "`length` {number} The amount of data from the fd to send. Default: `-1`.", "name": "length", "type": "number", "desc": "The amount of data from the fd to send. Default: `-1`." } ], "optional": true } ] } ], "desc": "

Instead of using a Quicstream as a writable stream, send data from a given\nfile descriptor.

\n

If offset is set to a non-negative number, reading starts from that position\nand the file offset will not be advanced.\nIf length is set to a non-negative number, it gives the maximum number of\nbytes that are read from the file.

\n

The file descriptor or FileHandle is not closed when the stream is closed,\nso it will need to be closed manually once it is no longer needed.\nUsing the same file descriptor concurrently for multiple streams\nis not supported and may result in data loss. Re-using a file descriptor\nafter a stream has finished is supported.

" }, { "textRaw": "quicstream.sendFile(path[, options])", "type": "method", "name": "sendFile", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "signatures": [ { "params": [ { "textRaw": "`path` {string|Buffer|URL}", "name": "path", "type": "string|Buffer|URL" }, { "textRaw": "`options` {Object}", "name": "options", "type": "Object", "options": [ { "textRaw": "`onError` {Function} Callback function invoked in the case of an error before send.", "name": "onError", "type": "Function", "desc": "Callback function invoked in the case of an error before send." }, { "textRaw": "`offset` {number} The offset position at which to begin reading. Default: `-1`.", "name": "offset", "type": "number", "desc": "The offset position at which to begin reading. Default: `-1`." }, { "textRaw": "`length` {number} The amount of data from the fd to send. Default: `-1`.", "name": "length", "type": "number", "desc": "The amount of data from the fd to send. Default: `-1`." } ], "optional": true } ] } ], "desc": "

Instead of using a QuicStream as a writable stream, send data from a given\nfile path.

\n

The options.onError callback will be called if the file could not be opened.\nIf offset is set to a non-negative number, reading starts from that position.\nIf length is set to a non-negative number, it gives the maximum number of\nbytes that are read from the file.

" }, { "textRaw": "quicstream.submitInformationalHeaders(headers)", "type": "method", "name": "submitInformationalHeaders", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "signatures": [ { "params": [ { "textRaw": "`headers` {Object}", "name": "headers", "type": "Object" } ] } ], "desc": "

TBD

" }, { "textRaw": "quicstream.submitInitialHeaders(headers)", "type": "method", "name": "submitInitialHeaders", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "signatures": [ { "params": [ { "textRaw": "`headers` {Object}", "name": "headers", "type": "Object" } ] } ], "desc": "

TBD

" }, { "textRaw": "quicstream.submitTrailingHeaders(headers)", "type": "method", "name": "submitTrailingHeaders", "meta": { "added": [ "REPLACEME" ], "changes": [] }, "signatures": [ { "params": [ { "textRaw": "`headers` {Object}", "name": "headers", "type": "Object" } ] } ], "desc": "

TBD

" } ] } ], "type": "module", "displayName": "QUIC JavaScript API" } ], "type": "module", "displayName": "QUIC" } ] }