From 1dc86be6bd3b22dc69eff38aeba4c4786951c0f4 Mon Sep 17 00:00:00 2001 From: Will Law <2762250+wilaw@users.noreply.github.com> Date: Mon, 21 Oct 2024 15:52:36 +0200 Subject: [PATCH 1/2] Add notes on receiver-side stream availability Fixes #618 --- index.bs | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/index.bs b/index.bs index 659c22bf..45d192d7 100644 --- a/index.bs +++ b/index.bs @@ -994,11 +994,17 @@ these steps. : incomingBidirectionalStreams :: Returns a {{ReadableStream}} of {{WebTransportBidirectionalStream}}s that have been received from the server. + + Note: whether the incoming streams already have data on them will depend on server behavior. + The getter steps for the `incomingBidirectionalStreams` attribute SHALL be: 1. Return [=this=]'s {{[[IncomingBidirectionalStreams]]}}. : incomingUnidirectionalStreams :: A {{ReadableStream}} of unidirectional streams, each represented by a {{WebTransportReceiveStream}}, that have been received from the server. + + Note: whether the incoming streams already have data on them will depend on server behavior. + The getter steps for `incomingUnidirectionalStreams` are: 1. Return [=this=].{{[[IncomingUnidirectionalStreams]]}}. @@ -1110,6 +1116,8 @@ the application will receive the number of streams it anticipates. stream. Note that the mere creation of a stream is not immediately visible to the peer until it is used to send data. + Note: there is no expectation that the server will be aware of the stream until data is sent on it. + When `createBidirectionalStream` is called, the user agent MUST run the following steps: @@ -1148,6 +1156,8 @@ the application will receive the number of streams it anticipates. that the mere creation of a stream is not immediately visible to the server until it is used to send data. + Note: there is no expectation that the server will be aware of the stream until data is sent on it. + When `createUnidirectionalStream()` method is called, the user agent MUST run the following steps: 1. Let |transport| be [=this=]. From 898287e136c717d906d1d5103a5ce1fb2e5793e8 Mon Sep 17 00:00:00 2001 From: Will Law <2762250+wilaw@users.noreply.github.com> Date: Mon, 21 Oct 2024 16:00:06 +0200 Subject: [PATCH 2/2] Apply suggestions from code review --- index.bs | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/index.bs b/index.bs index 45d192d7..46c69712 100644 --- a/index.bs +++ b/index.bs @@ -995,7 +995,7 @@ these steps. :: Returns a {{ReadableStream}} of {{WebTransportBidirectionalStream}}s that have been received from the server. - Note: whether the incoming streams already have data on them will depend on server behavior. + Note: Whether the incoming streams already have data on them will depend on server behavior. The getter steps for the `incomingBidirectionalStreams` attribute SHALL be: 1. Return [=this=]'s {{[[IncomingBidirectionalStreams]]}}. @@ -1003,7 +1003,7 @@ these steps. :: A {{ReadableStream}} of unidirectional streams, each represented by a {{WebTransportReceiveStream}}, that have been received from the server. - Note: whether the incoming streams already have data on them will depend on server behavior. + Note: Whether the incoming streams already have data on them will depend on server behavior. The getter steps for `incomingUnidirectionalStreams` are: 1. Return [=this=].{{[[IncomingUnidirectionalStreams]]}}. @@ -1116,7 +1116,7 @@ the application will receive the number of streams it anticipates. stream. Note that the mere creation of a stream is not immediately visible to the peer until it is used to send data. - Note: there is no expectation that the server will be aware of the stream until data is sent on it. + Note: There is no expectation that the server will be aware of the stream until data is sent on it. When `createBidirectionalStream` is called, the user agent MUST run the following steps: @@ -1156,7 +1156,7 @@ the application will receive the number of streams it anticipates. that the mere creation of a stream is not immediately visible to the server until it is used to send data. - Note: there is no expectation that the server will be aware of the stream until data is sent on it. + Note: There is no expectation that the server will be aware of the stream until data is sent on it. When `createUnidirectionalStream()` method is called, the user agent MUST run the following steps: