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

Queue two tasks upon finishing ICE gathering, and fire gatheringstatechange & icegatheringstatechange in same task #2894

Merged
merged 11 commits into from
Mar 29, 2024
Merged

Queue two tasks upon finishing ICE gathering, and fire gatheringstatechange & icegatheringstatechange in same task #2894

Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
21d59fe
Fire icecandidate, gatheringstatechange, icegatheringstatechange & ic…
jan-ivar Aug 21, 2023
e975f6c
Queue two tasks upon finishing ICE gathering.
jan-ivar Aug 21, 2023
8a9fdfc
Remove 4.4.1.4 Update the ICE gathering state
jan-ivar Aug 23, 2023
e12f616
Only queue second task if no other generations are being gathered.
jan-ivar Aug 23, 2023
b44be93
Add amendments
jan-ivar Aug 23, 2023
489998f
remove spurious comma
jan-ivar Aug 23, 2023
5dbb2b3
Add a=end-of-candidates to description(s).
jan-ivar Aug 25, 2023
afeb7fb
Merge branch 'main' into syncgathering
jan-ivar Mar 28, 2024
c6b0331
Add testUpdates to amendments.json
jan-ivar Mar 28, 2024
00f15e5
fix link typo in amendments.json
jan-ivar Mar 28, 2024
40cc420
Add <div id=rtcicetransport-gathering>
jan-ivar Mar 29, 2024
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
15 changes: 15 additions & 0 deletions amendments.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -734,6 +734,21 @@
"id": 36
}
],
"rtcicetransport": [
{
"description": "Queue two tasks upon finishing ICE gathering, and fire gatheringstatechange & icegatheringstatechange in same task",
"pr": 2894,
"tests": [
"webrtc/RTCPeerConnection-iceGatheringState.html"
],
"testUpdates": [
"web-platform-tests/wpt#44687"
],
"type": "correction",
"status": "candidate",
"id": 37
}
],
"closing-procedure": [
{
"description": "Prevent GC of non-closed RTCDataChannels",
Expand Down
188 changes: 94 additions & 94 deletions webrtc.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1611,63 +1611,6 @@ <h4>
</li>
</ol>
</section>
<section>
<h4>
Update the ICE gathering state
</h4>
<p>
To <dfn class="abstract-op" id="update-ice-gathering-state">update the ICE
gathering state</dfn> of an {{RTCPeerConnection}} instance
<var>connection</var>, the user agent MUST queue a task that runs
the following steps:
</p>
<ol class=algorithm>
<li>
<p>
If <var>connection</var>.{{RTCPeerConnection/[[IsClosed]]}} is
<code>true</code>, abort these steps.
</p>
</li>
<li>
<p>
Let <var>newState</var> be the value of deriving a new state
value as described by the {{RTCIceGatheringState}} enum.
</p>
</li>
<li>
<p>
If <var>connection</var>.{{RTCPeerConnection/[[IceGatheringState]]}} is equal
to <var>newState</var>, abort these steps.
</p>
</li>
<li>
<p>
Set <var>connection</var>.{{RTCPeerConnection/[[IceGatheringState]]}} to
<var>newState</var>.
</p>
</li>
<li data-tests="protocol/candidate-exchange.https.html">
<p>
[= Fire an event =] named {{RTCPeerConnection/icegatheringstatechange}} at
<var>connection</var>.
</p>
</li>
<li data-tests="RTCPeerConnection-iceGatheringState.html">
<p>
If <var>newState</var> is
{{RTCIceGatheringState/"complete"}}, [= fire an event =]
named {{RTCPeerConnection/icecandidate}} using the
{{RTCPeerConnectionIceEvent}} interface with the candidate
attribute set to <code>null</code> at <var>connection</var>.
</p>
<div class="note">
The null candidate event is fired to ensure legacy
compatibility. New code should monitor the gathering state of
{{RTCIceTransport}} and/or {{RTCPeerConnection}}.
</div>
</li>
</ol>
</section>
<section>
<h4>
Set the session description
Expand Down Expand Up @@ -11915,119 +11858,176 @@ <h3>
</div>
<p>
When the [= ICE Agent =] indicates that it began gathering a [=
generation =] of candidates for an {{RTCIceTransport}}, the user
generation =] of candidates for an {{RTCIceTransport}} <var>transport</var>
associated with an {{RTCPeerConnection}} <var>connection</var>, the user
agent MUST queue a task that runs the following steps:
</p>
<ol class=algorithm>
<li class="no-test-needed">
<li>
<p>
Let <var>connection</var> be the {{RTCPeerConnection}} object
associated with this [= ICE Agent =].
If <var>connection</var>.{{RTCPeerConnection/[[IsClosed]]}} is
<code>true</code>, abort these steps.
</p>
</li>
<li>
<p>
If <var>connection</var>.{{RTCPeerConnection/[[IsClosed]]}} is
<code>true</code>, abort these steps.
Set <var>transport</var>.{{RTCIceTransport/[[IceGathererState]]}} to
{{RTCIceGathererState/gathering}}.
</p>
</li>
<li class="no-test-needed">
<li>
<p>
Let <var>transport</var> be the {{RTCIceTransport}} for which
candidate gathering began.
Set <var>connection</var>.{{RTCPeerConnection/[[IceGatheringState]]}}
to the value of deriving a new state value as described by the
{{RTCIceGatheringState}} enum.
</p>
</li>
<li>
<p>
Set <var>transport</var>.{{RTCIceTransport/[[IceGathererState]]}} to
{{RTCIceGathererState/gathering}}.
Let <var>connectionIceGatheringStateChanged</var> be
<code>true</code> if
<var>connection</var>.{{RTCPeerConnection/[[IceGatheringState]]}}
changed in the previous step, otherwise <code>false</code>.
</p>
</li>
<li>
<p>Do not read or modify state beyond this point.</p>
</li>
<li>
<p>
[= Fire an event =] named {{RTCIceTransport/gatheringstatechange}} at
<var>transport</var>.
</p>
</li>
<li class="needs-test">
<li data-tests="protocol/candidate-exchange.https.html">
<p>
<a>Update the ICE gathering state</a> of <var>connection</var>.
If <var>connectionIceGatheringStateChanged</var> is
<code>true</code>, [= fire an event =] named
{{RTCPeerConnection/icegatheringstatechange}} at <var>connection</var>.
</p>
</li>
</ol>
<p>
When the [= ICE Agent =] is finished gathering a [= generation =] of
candidates for an {{RTCIceTransport}}, and those candidates have been
surfaced to the application, the user agent MUST queue a task that
runs the following steps:
candidates for an {{RTCIceTransport}} <var>transport</var> associated
with an {{RTCPeerConnection}} <var>connection</var>, and those candidates have been
surfaced to the application, the user agent MUST queue a task to run the following
steps:
</p>
<ol class=algorithm>
<li class="no-test-needed">
<p>
Let <var>connection</var> be the {{RTCPeerConnection}} object
associated with this [= ICE Agent =].
</p>
</li>
<li>
<p>
If <var>connection</var>.{{RTCPeerConnection/[[IsClosed]]}} is
<code>true</code>, abort these steps.
</p>
</li>
<li class="no-test-needed">
<li data-tests=
"RTCPeerConnection-candidate-in-sdp.https.html">
<p>
Let <var>transport</var> be the {{RTCIceTransport}} for which
candidate gathering finished.
If <var>connection</var>.{{RTCPeerConnection/[[PendingLocalDescription]]}} is
not <code>null</code>, and represents the ICE [= generation =]
for which gathering finished, add
`a=end-of-candidates` to
<var>connection</var>.{{RTCPeerConnection/[[PendingLocalDescription]]}}.sdp.
</p>
</li>
<li>
<p>
Let <var>newCandidate</var> be the result of [= creating an
If <var>connection</var>.{{RTCPeerConnection/[[CurrentLocalDescription]]}} is
not <code>null</code>, and represents the ICE [= generation =]
for which gathering finished, add
`a=end-of-candidates` to
<var>connection</var>.{{RTCPeerConnection/[[CurrentLocalDescription]]}}.sdp.
</p>
</li>
<li>
<p>
Let <var>endOfGatheringCandidate</var> be the result of [= creating an
RTCIceCandidate =] with a new dictionary whose
{{RTCIceCandidateInit/sdpMid}} and
{{RTCIceCandidateInit/sdpMLineIndex}} are set to the values
associated with this {{RTCIceTransport}},
{{RTCIceCandidateInit/usernameFragment}} is set to the username
fragment of the [= generation =] of candidates for which
gathering finished, and {{RTCIceCandidateInit/candidate}} is set
to an empty string.
gathering finished, and {{RTCIceCandidateInit/candidate}} is set to `""`.
</p>
</li>
<li>
<p>
[= Fire an event =] named {{RTCPeerConnection/icecandidate}} using the
{{RTCPeerConnectionIceEvent}} interface with the candidate
attribute set to <var>newCandidate</var> at
attribute set to <var>endOfGatheringCandidate</var> at
<var>connection</var>.
</p>
</li>
</ol>
<p>
When the [= ICE Agent =] has queued the above task, and no other
[= generation | generations =] of candidates is being gathered, the user agent
MUST also queue a second task to run the following steps:
</p>
<div class="note">
Other [= generation | generations =] of candidates might still be gathering
if an ICE restart was initiated while the ICE agent is still gathering the
previous [= generation =] of candidates.
</div>
<ol class=algorithm>
<li>
<p>
If another [= generation =] of candidates is still being
gathered, abort these steps.
If <var>connection</var>.{{RTCPeerConnection/[[IsClosed]]}} is
<code>true</code>, abort these steps.
</p>
<div class="note">
This may occur if an ICE restart is initiated while the ICE agent
is still gathering the previous [= generation =] of candidates.
</div>
</li>
<li>
<p>
Set <var>transport</var>.{{RTCIceTransport/[[IceGathererState]]}} to
{{RTCIceGathererState/complete}}.
</p>
</li>
<li>
<p>
Set <var>connection</var>.{{RTCPeerConnection/[[IceGatheringState]]}}
to the value of deriving a new state value as described by the
{{RTCIceGatheringState}} enum.
</p>
</li>
<li>
<p>
Let <var>connectionIceGatheringStateChanged</var> be
<code>true</code> if
<var>connection</var>.{{RTCPeerConnection/[[IceGatheringState]]}}
changed in the previous step, otherwise <code>false</code>.
</p>
</li>
<li>
<p>Do not read or modify state beyond this point.</p>
</li>
<li>
<p>
[= Fire an event =] named {{RTCIceTransport/gatheringstatechange}} at
<var>transport</var>.
</p>
</li>
<li>
<li data-tests="protocol/candidate-exchange.https.html">
<p>
<a>Update the ICE gathering state</a> of <var>connection</var>.
If <var>connectionIceGatheringStateChanged</var> is
<code>true</code>, [= fire an event =] named
{{RTCPeerConnection/icegatheringstatechange}} at <var>connection</var>.
</p>
</li>
<li data-tests="RTCPeerConnection-iceGatheringState.html">
<p>
[= Fire an event =]
named {{RTCPeerConnection/icecandidate}} using the
{{RTCPeerConnectionIceEvent}} interface with the candidate
attribute set to <code>null</code> at <var>connection</var>.
</p>
<div class="note">
The null candidate event is fired to ensure legacy
compatibility. New code should monitor the gathering state of
{{RTCIceTransport}} and/or {{RTCPeerConnection}}.
</div>
</li>
</ol>
<p>
When the [= ICE Agent =] indicates that a new ICE candidate is
Expand Down
Loading