From 6d8a75a22fe62b6ff68f6f485e275fa86f6ea671 Mon Sep 17 00:00:00 2001 From: Sameer Vijaykar <194338+sam-vi@users.noreply.github.com> Date: Thu, 18 Apr 2024 15:37:06 +0200 Subject: [PATCH 1/3] Use RTCIceCandidatePair interface in RTCIceTransport. Addresses: w3c/webrtc-pc#2930. As an interface, RTCIceCandidatePair can be used as an attribute of other interfaces. So simplify RTCIceCandidatePairEvent by having a single candidatePair attribute instead of individual local and remote candidates. --- index.html | 58 +++++++++++++++++------------------------------------- 1 file changed, 18 insertions(+), 40 deletions(-) diff --git a/index.html b/index.html index 81b3bc1..5e292e8 100644 --- a/index.html +++ b/index.html @@ -593,10 +593,9 @@

  • - Let |candidatePair:RTCIceCandidatePair| be a new {{RTCIceCandidatePair}} dictionary - with its {{RTCIceCandidatePair/local}} and {{RTCIceCandidatePair/remote}} members - initialized to new {{RTCIceCandidate}}s representing the local and remote part of the - [= formed =] pair respectively. + Let |candidatePair:RTCIceCandidatePair| be the result of [= creating an RTCIceCandidatePair =] with + |local:RTCIceCandidate| and |remote:RTCIceCandidate|, representing the local and remote candidates of the [= formed =] + pair respectively.

  • @@ -619,8 +618,8 @@

    [= Fire an event =] named {{RTCIceTransport/icecandidatepairadd}} at |transport|, using {{RTCIceCandidatePairEvent}}, - with the {{RTCIceCandidatePairEvent/local}} and {{RTCIceCandidatePairEvent/remote}} attributes - initialized to the local and remote candidates, respectively, of |candidatePair|. + with the {{RTCIceCandidatePairEvent/candidatePair}} attribute + initialized to |candidatePair|.

    • @@ -661,9 +660,8 @@

    Let |accepted:boolean| be the result of [= fire an event | firing an event =] named {{RTCIceTransport/icecandidatepairnominate}} at |transport|, using {{RTCIceCandidatePairEvent}}, with the - {{Event/cancelable}} attribute initialized to true, and the {{RTCIceCandidatePairEvent/local}} and - {{RTCIceCandidatePairEvent/remote}} attributes initialized to the local and remote candidates, respectively, of - |candidatePair|. + {{Event/cancelable}} attribute initialized to true, and the {{RTCIceCandidatePairEvent/candidatePair}} attribute + initialized to |candidatePair|.

  • @@ -727,9 +725,8 @@

    Let |accepted:boolean| be the result of [= fire an event | firing an event =] named {{RTCIceTransport/icecandidatepairremove}} at |transport|, using {{RTCIceCandidatePairEvent}}, with the - {{Event/cancelable}} attribute initialized to cancelable, and the {{RTCIceCandidatePairEvent/local}} - and {{RTCIceCandidatePairEvent/remote}} attributes initialized to the local and remote candidates, respectively, - of |candidatePair|. + {{Event/cancelable}} attribute initialized to cancelable, and the {{RTCIceCandidatePairEvent/candidatePair}} attribute + initialized to |candidatePair|.

  • @@ -979,7 +976,7 @@

    Methods

    1. - [= Fire an event =] named {{RTCIceTransport/icecandidatepairremove}} at |transport|, using {{RTCIceCandidatePairEvent}}, with the {{Event/cancelable}} attribute initialized to false, and the {{RTCIceCandidatePairEvent/local}} and {{RTCIceCandidatePairEvent/remote}} attributes initialized to the {{RTCIceCandidatePair/local}} and {{RTCIceCandidatePair/remote}} candidates, respectively, of candidatePair. + [= Fire an event =] named {{RTCIceTransport/icecandidatepairremove}} at |transport|, using {{RTCIceCandidatePairEvent}}, with the {{Event/cancelable}} attribute initialized to false, and the {{RTCIceCandidatePairEvent/candidatePair}} attribute initialized to |candidatePair|.

    2. @@ -1005,15 +1002,15 @@

      RTCIceCandidatePairEvent

      - The {{RTCIceTransport/icecandidatepairadd}} and {{RTCIceTransport/icecandidatepairremove}} events use the + The {{RTCIceTransport/icecandidatepairadd}}, {{RTCIceTransport/icecandidatepairnominate}} and + {{RTCIceTransport/icecandidatepairremove}} events use the {{RTCIceCandidatePairEvent}} interface. 

      [Exposed=Window]
   interface RTCIceCandidatePairEvent : Event {
     constructor(DOMString type, RTCIceCandidatePairEventInit eventInitDict);
-    readonly attribute RTCIceCandidate local;
-    readonly attribute RTCIceCandidate remote;
+    readonly attribute RTCIceCandidatePair candidatePair;
   };

      Constructors

      @@ -1026,21 +1023,11 @@

      Constructors

      Attributes

      - local of type {{RTCIceCandidate}}, readonly + candidatePair of type {{RTCIceCandidatePair}}, readonly

      - The {{local}} attribute represents the local {{RTCIceCandidate}} of the candidate pair associated with the - event. -

      -
      -
      - remote of type {{RTCIceCandidate}}, readonly -
      -
      -

      - The {{remote}} attribute represents the remote {{RTCIceCandidate}} of the candidate pair associated with - the event. + The {{candidatePair}} attribute represents the candidate pair associated with the event.

      @@ -1049,27 +1036,18 @@

      Attributes

         dictionary RTCIceCandidatePairEventInit : EventInit {
-    required RTCIceCandidate local;
-    required RTCIceCandidate remote;
+    required RTCIceCandidatePair candidatePair;
   };

      Dictionary RTCIceCandidatePairEventInit Members

      - local of type {{RTCIceCandidate}}, required -
      -
      -

      - The local {{RTCIceCandidate}} of the candidate pair announced by the event. -

      -
      -
      - remote of type {{RTCIceCandidate}}, required + candidatePair of type {{RTCIceCandidatePair}}, required

      - The remote {{RTCIceCandidate}} of the candidate pair announced by the event. + The candidate pair announced by the event.

      From 1f840b8c38f236f556b648ef323a120c626a82bb Mon Sep 17 00:00:00 2001 From: Sameer Vijaykar <194338+sam-vi@users.noreply.github.com> Date: Thu, 18 Apr 2024 16:08:33 +0200 Subject: [PATCH 2/3] Compare RTCIceCandidatePair identity instead of match algo. An application only acquires objects of RTCIceCandidatePair through RTCIceTransport events and getSelectedCandidatePair(). So simplify input validation where RTCIceCandidatePair is used as an argument by directly comparing object identity instead of using the candidate pair match algorithm. --- index.html | 36 ++++++------------------------------ 1 file changed, 6 insertions(+), 30 deletions(-) diff --git a/index.html b/index.html index 5e292e8..f08122c 100644 --- a/index.html +++ b/index.html @@ -605,8 +605,7 @@

    3. - [=Assert=]: |candidatePair| does not [= candidate pair match | match =] any - item in |transport|.{{RTCIceTransport/[[CandidatePairs]]}} + [=Assert=]: |transport|.{{RTCIceTransport/[[CandidatePairs]]}} does not [= list/contain =] |candidatePair|.

    4. @@ -858,8 +857,7 @@

      Methods

    5. - If |candidatePair| does not [= candidate pair match | match =] any item in [=this=]. - {{RTCIceTransport/[[CandidatePairs]]}}, [= exception/throw =] a {{NotFoundError}}. + If [=this=].{{RTCIceTransport/[[CandidatePairs]]}} does not [= list/contain =] |candidatePair|, [= exception/throw =] a {{NotFoundError}}.

    6. @@ -948,15 +946,13 @@

      Methods

    7. - If |candidatePair| does not [= candidate pair match | match =] any item in [=this=]. - {{RTCIceTransport/[[CandidatePairs]]}}, [= exception/throw =] a {{NotFoundError}}. + If [=this=].{{RTCIceTransport/[[CandidatePairs]]}} does not [= list/contain =] |candidatePair|, [= exception/throw =] a {{NotFoundError}}.

    8. - [= list/Remove =] the item in - [=this=].{{RTCIceTransport/[[CandidatePairs]]}} that - [= candidate pair match | matches =] |candidatePair|. + [= list/Remove =] |candidatePair| from + [=this=].{{RTCIceTransport/[[CandidatePairs]]}}.

    9. @@ -1055,7 +1051,7 @@

      Dictionary RTCIceCandidatePairEventInit Members

      - The candidate match algorithm given two {{RTCIceCandidate}} |first:RTCIceCandidate| and + The candidate match algorithm given two {{RTCIceCandidate}} |first:RTCIceCandidate| and |second:RTCIceCandidate| is as follows:

        @@ -1106,26 +1102,6 @@

        Dictionary RTCIceCandidatePairEventInit Members

      -

      - The candidate pair match algorithm given two {{RTCIceCandidatePair}} |first:RTCIceCandidatePair| and |second:RTCIceCandidatePair| is as follows: -

      -
        -
      1. -

        - If |first|.{{RTCIceCandidatePair/local}} does not [= candidate match | match =] |second|.{{RTCIceCandidatePair/local}}, return false. -

        -
        2. -
      2. -

        - If |first|.{{RTCIceCandidatePair/remote}} does not [= candidate match | match =] |second|.{{RTCIceCandidatePair/remote}}, return false. -

        -
        3. -
      3. -

        - Return true. -

        -
        4. -

      From d73eaa8f907312c05b1647fced3d883527e4b487 Mon Sep 17 00:00:00 2001 From: Sameer Vijaykar <194338+sam-vi@users.noreply.github.com> Date: Thu, 18 Apr 2024 16:28:13 +0200 Subject: [PATCH 3/3] Modify the change of selected pair algo in RTCIceTransport. This ensures that each candidate pair has a unique identity, simplifying the validation of RTCIceCandidatePair arguments to RTCIceTransport methods. --- index.html | 115 +++++++++++++++++++++++++++++------------------------ 1 file changed, 63 insertions(+), 52 deletions(-) diff --git a/index.html b/index.html index f08122c..3c6b00c 100644 --- a/index.html +++ b/index.html @@ -1050,58 +1050,69 @@

      Dictionary RTCIceCandidatePairEventInit Members

      -

      - The candidate match algorithm given two {{RTCIceCandidate}} |first:RTCIceCandidate| and - |second:RTCIceCandidate| is as follows: -

      -
        -
      1. -

        - If |first|.{{RTCIceCandidate/candidate}} is not [= string/identical to =] |second|.{{RTCIceCandidate/candidate}}, return false. -

        -
        2. -
      2. -

        - If either (but not both) of |first|.{{RTCIceCandidate/sdpMid}} and |second|.{{RTCIceCandidate/sdpMid}} is - null, return false. -

        -
        3. -
      3. -

        - If neither of |first|.{{RTCIceCandidate/sdpMid}} and |second|.{{RTCIceCandidate/sdpMid}} is null, and |first|.{{RTCIceCandidate/sdpMid}} is not [= string/identical to =] - |second|.{{RTCIceCandidate/sdpMid}}, return false. -

        -
        4. -
      4. -

        - If either (but not both) of |first|.{{RTCIceCandidate/sdpMLineIndex}} and |second|.{{RTCIceCandidate/sdpMLineIndex}} is - null, return false. -

        -
        5. -
      5. -

        - If neither of |first|.{{RTCIceCandidate/sdpMLineIndex}} and |second|.{{RTCIceCandidate/sdpMLineIndex}} is null and |first|.{{RTCIceCandidate/sdpMLineIndex}} is not equal to - |second|.{{RTCIceCandidate/sdpMLineIndex}}, return false. -

        -
        6. -
      6. -

        - If either (but not both) of |first|.{{RTCIceCandidate/usernameFragment}} and |second|.{{RTCIceCandidate/usernameFragment}} is - null, return false. -

        -
        7. -
      7. -

        - If neither of |first|.{{RTCIceCandidate/usernameFragment}} and |second|.{{RTCIceCandidate/usernameFragment}} is null and |first|.{{RTCIceCandidate/usernameFragment}} is not [= string/identical to =] - |second|.{{RTCIceCandidate/usernameFragment}}, return false. -

        -
        8. -
      8. -

        - Return true. -

        -
        9. -
      +
      +

      Modifications to existing procedures

      +

      + In the steps to [=RTCIceTransport/change the selected candidate pair and state=], if the selected candidate pair was changed, modify the first step to the following: +

      +
        +
      1. + Let newCandidatePair be the [= list/item =] [= list/contained =] in |this|.{{RTCIceTransport/[[CandidatePairs]]}} whose {{RTCIceCandidatePair/local}} and {{RTCIceCandidatePair/remote}} attributes respectively [= candidate match | match =] the local and remote candidates of the indicated pair if one is selected, and null otherwise. +
        2. +
      +

      + The candidate match algorithm given two {{RTCIceCandidate}} |first:RTCIceCandidate| and + |second:RTCIceCandidate| is as follows: +

      +
        +
      1. +

        + If |first|.{{RTCIceCandidate/candidate}} is not [= string/identical to =] |second|.{{RTCIceCandidate/candidate}}, return false. +

        +
        2. +
      2. +

        + If either (but not both) of |first|.{{RTCIceCandidate/sdpMid}} and |second|.{{RTCIceCandidate/sdpMid}} is + null, return false. +

        +
        3. +
      3. +

        + If neither of |first|.{{RTCIceCandidate/sdpMid}} and |second|.{{RTCIceCandidate/sdpMid}} is null, and |first|.{{RTCIceCandidate/sdpMid}} is not [= string/identical to =] + |second|.{{RTCIceCandidate/sdpMid}}, return false. +

        +
        4. +
      4. +

        + If either (but not both) of |first|.{{RTCIceCandidate/sdpMLineIndex}} and |second|.{{RTCIceCandidate/sdpMLineIndex}} is + null, return false. +

        +
        5. +
      5. +

        + If neither of |first|.{{RTCIceCandidate/sdpMLineIndex}} and |second|.{{RTCIceCandidate/sdpMLineIndex}} is null and |first|.{{RTCIceCandidate/sdpMLineIndex}} is not equal to + |second|.{{RTCIceCandidate/sdpMLineIndex}}, return false. +

        +
        6. +
      6. +

        + If either (but not both) of |first|.{{RTCIceCandidate/usernameFragment}} and |second|.{{RTCIceCandidate/usernameFragment}} is + null, return false. +

        +
        7. +
      7. +

        + If neither of |first|.{{RTCIceCandidate/usernameFragment}} and |second|.{{RTCIceCandidate/usernameFragment}} is null and |first|.{{RTCIceCandidate/usernameFragment}} is not [= string/identical to =] + |second|.{{RTCIceCandidate/usernameFragment}}, return false. +

        +
        8. +
      8. +

        + Return true. +

        +
        9. +
      +