From 59eecbfb77063ed39d3b821736ad6f3201377e9a Mon Sep 17 00:00:00 2001 From: Sameer Vijaykar <194338+sam-vi@users.noreply.github.com> Date: Mon, 18 Dec 2023 17:23:43 +0100 Subject: [PATCH] Link to the definition of freeing candidates. --- index.html | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/index.html b/index.html index a971057..52bd3fb 100644 --- a/index.html +++ b/index.html @@ -82,6 +82,9 @@
+ The process of freeing a candidate is defined in [[RFC8445]] Section 8.3. +
- When the [= ICE agent =] has picked a candidate pair to remove, the [= user agent =] MUST [= queue a task =] to remove a candidate pair: + When the [= ICE agent =] has picked a candidate pair to remove, the [= user agent =] MUST [= queue a task =] to remove a candidate pair:
- Let |cancelable:boolean| be true
if the candidate pair is being removed in order to free an unused candidate, and
+ Let |cancelable:boolean| be true
if the candidate pair is being removed in order to [= free =] an unused
+ candidate, and
false
otherwise.
- 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.
When this method is invoked, the [= user agent =] MUST run the following steps: