Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support BYOB Readers for Datagrams #487

Merged
merged 8 commits into from
May 11, 2023
Merged

Support BYOB Readers for Datagrams #487

Changes from 7 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
dbcf7ce
support byob readers for datagrams
nidhijaju Mar 3, 2023
27e6db1
address review comments
nidhijaju Mar 6, 2023
33d7c2a
replace bytes with datagram
nidhijaju Apr 20, 2023
c085fbb
bail when erroring stream
nidhijaju Apr 21, 2023
ce5ad74
fix algorithm
nidhijaju Apr 21, 2023
386a6ba
use pull from bytes
nidhijaju Apr 21, 2023
a51c407
fix
nidhijaju Apr 21, 2023
3ffe59d
remove erroring stream
nidhijaju Apr 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 29 additions & 5 deletions index.bs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@ urlPrefix: http://www.ecma-international.org/ecma-262/6.0/index.html; spec: ECMA
text: pending; url: sec-promise-objects
text: resolved; url: sec-promise-objects
text: settled; url: sec-promise-objects
text: the typed array constructors table; url: #table-49
urlPrefix: https://heycam.github.io/webidl/; spec: WEBIDL
type: dfn
text: created; for:DOMException; url: dfn-create-exception
Expand Down Expand Up @@ -478,9 +479,25 @@ To <dfn>pullDatagrams</dfn>, given a {{WebTransport}} object |transport|, run th
1. If |queue| is empty, then:
1. Set |datagrams|.{{[[IncomingDatagramsPullPromise]]}} to a new promise.
1. Return |datagrams|.{{[[IncomingDatagramsPullPromise]]}}.
1. Let |bytes| and |timestamp| be the result of [=dequeuing=] |queue|.
1. Let |chunk| be a new {{Uint8Array}} object representing |bytes|.
1. [=ReadableStream/Enqueue=] |chunk| to |transport|.{{[[Datagrams]]}}.{{WebTransportDatagramDuplexStream/[[Readable]]}}.
1. Let |datagram| and |timestamp| be the result of [=dequeuing=] |queue|.
1. If |datagrams|.{{WebTransportDatagramDuplexStream/[[Readable]]}}'s
[=ReadableStream/current BYOB request view=] is not null, then:
1. Let |view| be |datagrams|.{{WebTransportDatagramDuplexStream/[[Readable]]}}'s
[=ReadableStream/current BYOB request view=].
1. If |view|'s [=BufferSource/byte length=] is less than the size of |datagram|, then:
1. Let |error| be a new {{RangeError}} exception.
1. [=ReadableStream/Error=] |datagrams|.{{WebTransportDatagramDuplexStream/[[Readable]]}}
with |error|.
1. Return [=a promise rejected with=] |error|.
nidhijaju marked this conversation as resolved.
Show resolved Hide resolved
1. Let |elementSize| be the element size specified in [=the typed array constructors table=] for
|view|.\[[TypedArrayName]]. If |view| does not have a \[[TypedArrayName]] internal slot
(i.e. it is a {{DataView}}), let |elementSize| be 0.
1. If |elementSize| is not 1, then:
1. Let |error| be a new {{TypeError}} exception.
1. [=ReadableStream/Error=] |datagrams|.{{WebTransportDatagramDuplexStream/[[Readable]]}}
with |error|.
1. Return [=a promise rejected with=] |error|.
nidhijaju marked this conversation as resolved.
Show resolved Hide resolved
1. [=ReadableStream/Pull from bytes=] |datagram| into |datagrams|.{{WebTransportDatagramDuplexStream/[[Readable]]}}.
1. Return [=a promise resolved with=] undefined.

To <dfn>receiveDatagrams</dfn>, given a {{WebTransport}} object |transport|, run these steps:
Expand Down Expand Up @@ -743,8 +760,15 @@ agent MUST run the following steps:
:: null
1. Let |pullDatagramsAlgorithm| be an action that runs [=pullDatagrams=] with |transport|.
1. Let |writeDatagramsAlgorithm| be an action that runs [=writeDatagrams=] with |transport|.
1. [=ReadableStream/Set up=] |incomingDatagrams| with [=ReadableStream/set up/pullAlgorithm=]
set to |pullDatagramsAlgorithm|, and [=ReadableStream/set up/highWaterMark=] set to 0.

Note: Using 64kB buffers with datagrams is recommended because the effective
maximum WebTransport datagram frame size has an upper bound of the QUIC maximum datagram frame size
which is recommended to be 64kB (See [[!QUIC-DATAGRAM]] [Section 3](https://datatracker.ietf.org/doc/html/rfc9221#section-3)).
nidhijaju marked this conversation as resolved.
Show resolved Hide resolved
This will ensure the stream is not errored due to a datagram being larger than the buffer.

1. [=ReadableStream/Set up with byte reading support=] |incomingDatagrams| with
[=ReadableStream/set up with byte reading support/pullAlgorithm=] set to
|pullDatagramsAlgorithm|, and [=ReadableStream/set up/highWaterMark=] set to 0.
1. [=WritableStream/Set up=] |outgoingDatagrams| with [=WritableStream/set up/writeAlgorithm=]
set to |writeDatagramsAlgorithm|.
1. Let |pullBidirectionalStreamAlgorithm| be an action that runs [=pullBidirectionalStream=]
Expand Down