Constructors

1. Let transport be the first argument.
2. If transport is in the "closed" state, throw an InvalidStateError and abort these steps.
3. If transport has been used to construct another RTCQuicTransport whose [[\QuicTransportState]] slot is not "closed", throw an InvalidStateError and abort these steps.
4. Let certificates be the second argument if provided, null otherwise.
5. If certificates is non-null and is non-empty, check that the expires attribute of each RTCCertificate object is in the future. If a certificate has expired, throw an InvalidAccessError and abort these steps.
6. Let quictransport be a newly constructed RTCQuicTransport object.
7. Let quictransport have a [[\QuicTransportWritableStreams]] internal slot representing a sequence of RTCQuicWritableStream objects, initialized to empty.
8. Let quictransport have a [[\QuicTransportReadableStreams]] internal slot representing a sequence of RTCQuicReadableStream objects, initialized to empty.
9. Let quictransport have a [[\QuicTransportState]] internal slot, initialized to "new".
10. Let quictransport have a [[\Certificates]] internal slot.
11. If certificates is non-null and is non-empty, initialize the [[\Certificates]] internal slot to certificates.
12. If certificates is null or is empty, generate a certificate using the default key generation algorithm and store it in the [[\Certificates]] internal slot.
13. Return quictransport.

RTCQuicTransport

Parameter	Type	Nullable	Optional	Description
transport	RTCIceTransport	✘	✘
certificates	sequence<RTCCertificate>	✘	✔

Attributes

transport of type RTCIceTransport, readonly

The associated RTCIceTransport instance.

state of type RTCQuicTransportState, readonly

The current state of the QUIC transport. On getting, it MUST return the value of the [[\QuicTransportState]] internal slot.

onstatechange of type EventHandler

This event handler, of event handler event type statechange, MUST be fired any time the [[\QuicTransportState]] slot changes.

onerror of type EventHandler

This event handler, of event handler event type error, MUST be fired on reception of a QUIC error; an implementation SHOULD include QUIC error information in error.message (defined in [[!HTML51]] Section 7.1.3.8.2).

onreceivestream of type EventHandler

This event handler, of event handler event type receivestream, MUST be fired on when data is received from a newly created remote RTCQuicSendStream for the first time.

onbidirectionalstream of type EventHandler

This event handler, of event handler event type bidirectionalstream, MUST be fired when data is received from a newly created remote RTCQuicBidirectionalStream for the first time.

Methods

getLocalParameters

getLocalParameters() obtains the QUIC parameters of the local RTCQuicTransport upon construction. If multiple certificates were provided in the constructor, then multiple fingerprints will be returned, one for each certificate. getLocalParameters().role always returns the default role of a newly constructed RTCQuicTransport; for a browser this will be auto.

No parameters.

Return type: RTCQuicParameters

getRemoteParameters

getRemoteParameters() obtains the remote QUIC parameters passed in the start() method. Prior to calling start(), null is returned.

No parameters.

Return type: RTCQuicParameters, nullable

getCertificates

getCertificates() returns the value of the RTCQuicTransport's [[\Certificates]]> internal slot.

No parameters.

Return type: sequence<RTCCertificate>

getRemoteCertificates

getRemoteCertificates() returns the certificate chain in use by the remote side, with each certificate encoded in binary Distinguished Encoding Rules (DER) [[!X690]]. getRemoteCertificates() returns an empty list prior to selection of the remote certificate, which is completed once RTCQuicTransportState transitions to connected.

No parameters.

Return type: sequence<ArrayBuffer>

start

Start QUIC transport negotiation with the parameters of the remote QUIC transport, including verification of the remote fingerprint. Only a single QUIC transport can be multiplexed over an ICE transport. Therefore if a RTCQuicTransport object quicTransportB is constructed with an RTCIceTransport object iceTransport previously used to construct another RTCQuicTransport object quicTransportA, then if quicTransportB.start() is called prior to having called quicTransportA.stop(), then throw an InvalidStateError.

If start is called after a previous start call, or if state is closed, throw an InvalidStateError.

If all of the values of remoteParameters.fingerprints[j].algorithm are unsupported, where j goes from 0 to the number of fingerprints, throw a NotSupportedError.

Parameter	Type	Nullable	Optional	Description
remoteParameters	RTCQuicParameters	✘	✘

Return type: void

stop

Stops and closes the RTCQuicTransport object. This triggers an Immediate Close as described in [[QUIC-TRANSPORT]] section 10.3.

When stop is called, the user agent MUST run the following steps:

1. Let transport be the RTCQuicTransport on which stop is invoked.
2. If transport's [[\QuicTransportState]] is "closed" then abort these steps.
3. Set transport's [[\QuicTransportState]] to "closed".
4. Let stopInfo be the first argument.
5. Start the Immediate Close procedure by sending an CONNECTION_CLOSE frame with its error code value set to the value of stopInfo.errorCode and its reason value set to the value of stopInfo.reason.

No parameters.

Return type: void

Parameter	Type	Nullable	Optional	Description
stopInfo	RTCQuicTransportStopInfo	✘	✘

createBidirectionalStream

Creates an RTCQuicBidirectionalStream object.

When createBidectionalStream is called, the user agent MUST run the following steps:

1. Let transport be the RTCQuicTransport on which createBidectionalStream is invoked.

2. If transport's state is not connected throw an InvalidStateError and abort these steps.

3. Let stream be a newly created RTCQuicBidirectionalStream object.

4. Add stream to transport's [[\QuicTransportWritableStreams]] internal slot.

5. Add stream to transport's [[\QuicTransportReadableStreams]] internal slot.

6. Return stream and continue the following steps in the background.

7. Create stream's associated underlying data transport.

No parameters.

Return type: RTCQuicBidirectionalStream

createSendStream

Creates an RTCQuicSendStream object.

When createSendStream is called, the user agent MUST run the following steps:

1. Let transport be the RTCQuicTransport on which createSendStream is invoked.

2. If transport's state is not connected throw an InvalidStateError and abort these steps.

3. Let stream be a newly created RTCQuicSendStream object.

4. Add stream to transport's [[\QuicTransportWritableStreams]] internal slot.

5. Return stream and continue the following steps in the background.

6. Create stream's associated underlying data transport.

No parameters.

Return type: RTCQuicSendStream

Dictionary RTCQuicParameters Members

role of type RTCQuicRole, defaulting to "auto"

The QUIC role, with a default of auto.

fingerprints of type sequence<RTCDtlsFingerprint>

Sequence of fingerprints, at least one fingerprint for each certificate (with one computed with the digest algorithm used in the certificate signature).

Dictionary RTCQuicStreamParameters Members

disableRetransmissions of type bool, defaulting to false

disableRetransmissions, with a default of false. If true, the stream will be sent without retransmissions. If false, the stream will be sent with retransmissions.

Constructors

ReceiveStreamEvent

Parameter	Type	Nullable	Optional	Description
type	DOMString	✘	✘
eventInitDict	ReceiveStreamEventInit	✘	✘

Attributes

stream of type RTCQuicReceiveStream, readonly

The stream attribute represents the RTCQuicReceiveStream object associated with the event.

Dictionary ReceiveStreamEventInit Members

stream of type RTCQuicReceiveStream

The RTCQuicReceiveStream object associated with the event.

Constructors

BidirectionalStreamEvent

Parameter	Type	Nullable	Optional	Description
type	DOMString	✘	✘
eventInitDict	BidirectionalStreamEventInit	✘	✘

Attributes

stream of type RTCQuicBidirectionalStream, readonly

The stream attribute represents the RTCQuicBidirectionalStream object associated with the event.

Dictionary BidirectionalStreamEventInit Members

stream of type RTCQuicBidirectionalStream

The RTCQuicBidirectionalStream object associated with the event.

Dictionary RTCQuicTransportStopInfo Members

errorCode of type unsigned short, defaulting to 0.

The error code used in CONNECTION_CLOSE frame.

reason of type DOMString, defaulting to ""

The reason for stopping the RTCQuicTransport

Overview

The RTCQuicWritableStream will initialize with the following:

1. Let stream be the RTCQuicWritableStream.
2. Let stream have a [[\Writable]] internal slot initialized to true.
3. Let stream have a [[\WriteBufferedAmount]] internal slot initialized to zero.

Attributes

writable of type boolean readonly

The writable attribute represents whether data can be written to the RTCQuicWritableStream. On getting it MUST return the value of the [[\Writable]] slot.

writeBufferedAmount of type unsigned long, readonly

The writeBufferedAmount attribute represents the number of bytes of application data that have been queued using write but that, as of the last time the event loop started executing a task, had not yet been transmitted to the network. This includes any data sent during the execution of the current task, regardless of whether the user agent is able to transmit text asynchronously with script execution. This does not include framing overhead incurred by the protocol, or buffering done by the operating system or network hardware. On getting, it MUST return the value of the RTCQuicWritableStream's [[\WriteBufferedAmount]] internal slot.

writingAborted of type RTCQuicStreamAbortInfo readonly

The writingAborted attribute represents a promise that resolves when the STOP_SENDING frame is received from the RTCQuicReadableStream. When the stream receives a STOP_SENDING frame from its corresponding RTCQuicReadableStream, the user agent MUST run the following:

1. Let stream be the RTCQuicWritableStream object.
2. Set stream's [[\Writable]] slot to false.
3. Clear the stream's write buffer.
4. Let transport be the RTCQuicTransport, which the stream was created from.
5. Remove the stream from the transport's [[\QuicTransportWritableStreams]] internal slot.
6. resolve the promise with the resulting RTCQuicStreamAbortInfo with the errorCode set to the value from the STOP_SENDING frame.

Methods

write

Writes data to the stream. When the remote RTCQuicTransport receives the STREAM frame from this stream for the first time, it will trigger the creation of the corresponding remote stream. When the write method is called, the user agent MUST run the following steps:

1. Let data be the first argument.
2. Let stream be the RTCQuicWritableStream object on which data is to be sent.
3. if length of data.data is 0 and data.finished is false, throw a NotSupportedError and abort these steps.
4. If stream's [[\Writable]] slot is false, throw an InvalidStateError and abort these steps.
5. Increase the value of stream's [[\WriteBufferedAmount]] slot by the length of data.data in bytes.
6. Queue data.data for transmission on stream's underlying data transport.
7. if data.finish is set to true, run the following:
1. Queue a STREAM frame with the FIN bit set.
2. Set stream's [[\Writable]] slot to false.
3. Let transport be the RTCQuicTransport, which the stream was created from.
4. Remove the stream from the transport's [[\QuicTransportWritableStreams]] internal slot.
The actual transmission of data occurs in parallel. If sending data leads to a QUIC-level error, the application will be notified asynchronously through the RTCQuicTransport's onerror EventHandler.

Parameter	Type	Nullable	Optional	Description
data	RTCQuicStreamWriteParameters	✘	✘

Return type: void

abortWriting

A hard shutdown of the RTCQuicWritableStream. It may be called regardless of whether the RTCQuicWritableStream was created by the local or remote peer. When the abortWriting() method is called, the user agent MUST run the following steps:

1. Let stream be the RTCQuicWritableStream object which is about to abort writing.
2. If stream's [[\Writable]] slot is false, throw an InvalidStateError and abort these steps.
3. Set stream's [[\Writable]] slot to false.
4. Clear the stream's write buffer.
5. Let transport be the RTCQuicTransport, which the stream was created from.
6. Remove the stream from the transport's [[\QuicTransportWritableStreams]] internal slot.
7. Let abortInfo be the first argument.
8. Start the closing procedure by sending a RST_STREAM frame with its error code set to the value of abortInfo.errorCode.

Parameter	Type	Nullable	Optional	Description
abortInfo	RTCQuicStreamAbortInfo	✘	✘

Return type: void

waitForWriteBufferedAmountBelow

waitForWriteBufferedAmountBelow resolves the promise when the data queued in the write buffer falls below the given threshold. If waitForWriteBufferedAmountBelow is called multiple times, multiple promises could be resolved when the write buffer falls below the threshold for each promise. The Promise will be rejected with a newly created InvalidStateError if the stream's [[\Writable]] slot transitions from true to false and the promise isn't settled. When the waitForWriteBufferedAmountBelow method is called, the user agent MUST run the following steps:

1. Let stream be the RTCQuicWritableStream object on which waitForWriteBufferedAmountBelow was invoked.
2. Let p be a new promise.
3. If stream's [[\Writable]] slot is false, reject p with a newly created InvalidStateError and abort these steps.
4. Let threshold be the first argument.
5. When stream's [[\WriteBufferedAmount]]] slot decreases from above threshold to less than or equal to it, resolve p with undefined.

Parameter	Type	Nullable	Optional	Description
threshold	unsigned long	✘	✘

Return type: Promise<void>

Overview

The RTCQuicReadableStream will initialize with the following:

1. Let stream be the RTCQuicReadableStream.
2. Let stream have a [[\Readable]] internal slot initialized to true.
3. Let stream have a [[\ReadableAmount]] internal slot initialized to zero.

Attributes

readable of type boolean, readonly

The readable attribute represents whether data can be read from the RTCQuicReadableStream. On getting, it MUST return the value of the RTCQuicReadableStream's [[\Readable]] slot.

readableAmount of type unsigned long, readonly

The readableAmount attribute represents the number of bytes buffered for access by readInto but that, as of the last time the event loop started executing a task, had not yet been read. This does not include framing overhead incurred by the protocol, or buffers associated with the network hardware. On getting, it MUST return the value of the RTCQuicReadableStream's [[\ReadableAmount]] internal slot.

readingAborted of type RTCQuicStreamAbortInfo readonly

The readingAborted attribute represents a promise that resolves when the RST_STREAM frame is received from the RTCQuicWritableStream. When the stream receives a RST_STREAM frame from its corresponding RTCQuicWritableStream, the user agent MUST run the following:

1. Let stream be the RTCQuicReadableStream object
2. Set stream's [[\Readable]] slot to false.
3. Clear the stream's read buffer.
4. Let transport be the RTCQuicTransport, which the stream was created from.
5. Remove the stream from the transport's [[\QuicTransportReadableStreams]] internal slot.
6. resolve the promise with the resulting RTCQuicStreamAbortInfo with errorCode set to the value of the errror code from the RST_STREAM frame.

Methods

readInto

Reads from the RTCQuicReadableStream into the buffer specified by the first argument and returns RTCQuicStreamReadResult. When the readInto method is called, the user agent MUST run the following steps:

1. Let stream be the RTCQuicReadableStream object on which readInto is invoked.
2. If stream's [[\Readable]] slot is false, throw an InvalidStateError, then abort these steps.
3. Let data be the first argument.
4. Let result be the RTCQuicStreamReadResult to be returned.
5. If stream has finished reading, return result with amount set to 0 and finished set to true and abort these steps.
6. Transfer data from the read buffer into data.
7. Decrease the value of stream's [[\ReadableAmount]] slot by the length of data in bytes.
8. Set result's amount to the size of data in bytes.
9. If the data includes up to the FIN bit being read, then run the following steps:
1. Set result's finished to true.
2. Set the stream's [[\Readable]] slot to false.
3. Let transport be the RTCQuicTransport, which the stream was created from.
4. Remove the stream from the transport's [[\QuicTransportReadableStreams]] internal slot.
10. Else, set result's finished to false.
11. Return result.

Parameter	Type	Nullable	Optional	Description
data	Uint8Array	✘	✘

Return type: RTCQuicStreamReadResult

abortReading

A hard shutdown of the RTCQuicReadableStream. It may be called regardless of whether the RTCQuicReadableStream object was created by the local or remote peer. When the abortReading() method is called, the user agent MUST run the following steps:

1. Let stream be the RTCQuicReadableStream object which is about to abort reading.
2. If stream's [[\Readable]] slot is false, throw an InvalidStateError and abort these steps.
3. Set stream's [[\Readable]] slot to false.
4. Clear the stream's read buffer.
5. Let transport be the RTCQuicTransport, which the stream was created from.
6. Remove the stream from the transport's [[\QuicTransportReadableStreams]] internal slot.
7. Let abortInfo be the first argument.
8. Start the closing procedure by sending a STOP_SENDING frame with its error code set to the value of abortInfo.errorCode.

Parameter	Type	Nullable	Optional	Description
abortInfo	RTCQuicStreamAbortInfo	✘	✘

Return type: void

waitForReadable

waitForReadable waits for data to become available, or for the RTCQuicReadableStream to be finished reading. It resolves the promise when the data queued in the read buffer increases above the amount provided as an argument or when a STREAM frame with the FIN bit set has been received. If waitForReadable is called multiple times, multiple promises could be resolved. The Promise will be rejected with a newly created InvalidStateError if the stream's [[\Readable]] slot transitions from true to false and the promise isn't settled. When the waitForReadable method is called, the user agent MUST run the following steps:

1. Let stream be the RTCQuicReadableStream on which waitForReadable is invoked.
2. Let p be a new promise.
3. If stream's [[\Readable]] slot is false, reject p with a newly created InvalidStateError and abort these steps.
4. Let amount be the first argument.
5. Resolve p with undefined when any of the following conditions are met:
   1. The [[\ReadableAmount]] increases from below the value of amount to greater than or equal to it.
   2. stream receives a STREAM frame with the FIN bit set and [[\ReadableAmount]] is less than amount.

Parameter	Type	Nullable	Optional	Description
amount	unsigned long	✘	✘

Return type: Promise<void>

Attributes

streamId of type unsigned long long, readonly

The readonly attribute referring to the ID of the RTCQuicStream object.

transport of type RTCQuicTransport, readonly

The readonly attribute referring to the related RTCQuicTransport object.

Dictionary RTCQuicStreamWriteParameters Members

data of type Uint8Array.

The data to be written.

finished of type boolean.

Set to true if this is the last data to be written. This will result in a STREAM frame with the FIN bit set.

Dictionary RTCQuicStreamReadResult Members

amount of type unsigned long.

The amount of data read in bytes.

finished of type boolean.

Set to true if the RTCQuicReadableStream has finished reading.

Dictionary RTCQuicStreamAbortInfo Members

errorCode of type unsigned short.

The error code used in the RST_STREAM or STOP_SENDING frame. The default value of 0 means "STOPPING."