Skip to content

Commit

Permalink
Link to the definition of freeing candidates.
Browse files Browse the repository at this point in the history
  • Loading branch information
sam-vi committed Dec 18, 2023
1 parent c9aa0dc commit 59eecbf
Showing 1 changed file with 12 additions and 3 deletions.
15 changes: 12 additions & 3 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,9 @@ <h2>Terminology</h2>
The process of <dfn data-lt="nominate|nominated|nomination">nominating</dfn> a candidate pair is defined in
[[RFC8445]] Section 8.1.1.
</p>
<p>
The process of <dfn data-lt="free|freed|freeing">freeing</dfn> a candidate is defined in [[RFC8445]] Section 8.3.
</p>
</section>
<section id="ice-csp">
<h3>
Expand Down Expand Up @@ -818,7 +821,8 @@ <h3>
The [= ICE agent =] will continue to send data using |candidatePair| until instructed to use another candidate pair with {{RTCIceTransport/selectCandidatePair}}.
</p>
<p>
When the [= ICE agent =] has picked a candidate pair to remove, the [= user agent =] MUST [= queue a task =] to <dfn data-lt="candidate pair removed" id="rtcicetransport-remove">remove a candidate pair</dfn>:
When the [= ICE agent =] has picked a candidate pair to remove, the [= user agent =] MUST [= queue a task =] to <dfn
id="rtcicetransport-remove">remove a candidate pair</dfn>:
</p>
<ol class="algorithm">
<li>
Expand All @@ -844,7 +848,8 @@ <h3>
</li>
<li>
<p>
Let |cancelable:boolean| be <code>true</code> if the candidate pair is being removed in order to free an unused candidate, and
Let |cancelable:boolean| be <code>true</code> if the candidate pair is being removed in order to [= free =] an unused
candidate, and
<code>false</code> otherwise.
</p>
</li>
Expand Down Expand Up @@ -1027,7 +1032,11 @@ <h2>Methods</h2>
</dt>
<dd>
<p>
The {{removeCandidatePair}} method removes the provided candidate pair. The [= ICE agent =] will stop sending and responding to ICE connectivity checks on the removed candidate pair, and it can no longer be used to send data for this transport. This method is meant to be called when the application wants to free resources allocated for candidates that it no longer needs. The application cannot call {{RTCIceTransport/selectCandidatePair}}() with a candidate pair removed with this method.
The {{removeCandidatePair}} method removes the provided candidate pair. The [= ICE agent =] will stop sending and
responding to ICE connectivity checks on the removed candidate pair, and it can no longer be used to send data for this
transport. This method is meant to be called when the application wants to allow the [= ICE agent =] to [= free =]
candidates that it no longer needs. The application cannot call {{RTCIceTransport/selectCandidatePair}}() with a
candidate pair removed with this method.
</p>
<p>
When this method is invoked, the [= user agent =] MUST run the following steps:
Expand Down

0 comments on commit 59eecbf

Please sign in to comment.