Skip to content

Commit

Permalink
rename ufrag to usernameFragment (#1479)
Browse files Browse the repository at this point in the history 
* rename ufrag to usernameFragment

renames the ICE ufrag to usernameFragment for consistency.
Fixes #1210
  • Loading branch information
@fippo @taylor-b
fippo authored and taylor-b committed Jul 27, 2017
1 parent 721d0b3 commit 2bbef96
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions webrtc.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2647,7 +2647,7 @@ <h2>Methods</h2>
"RTCIceCandidate">candidate</a></code>, <code><a data-for=
"RTCIceCandidate">sdpMid</a></code>, <code><a data-for=
"RTCIceCandidate">sdpMLineIndex</a></code>, and
<code><a data-for="RTCIceCandidate">ufrag</a></code>; the rest
<code><a data-for="RTCIceCandidate">usernameFragment</a></code>; the rest
are ignored. When the method is invoked, the user agent MUST
run the following steps:</p>
<ol>
Expand Down Expand Up @@ -2713,9 +2713,9 @@ <h2>Methods</h2>
</ol>
</li>
<li>
<p>If <code><var>candidate</var>.ufrag</code> is neither
<p>If <code><var>candidate</var>.usernameFragment</code> is neither
<code>undefined</code> nor <code>null</code>, and is not
equal to any ufrag present in the corresponding
equal to any username fragment present in the corresponding
<a>media description</a> of an applied remote
description, reject <var>p</var> with a newly
<a data-link-for="exception" data-lt="create">created
Expand All @@ -2726,8 +2726,8 @@ <h2>Methods</h2>
<p>In parallel, add the ICE candidate
<var>candidate</var> as described in <span data-jsep=
"addicecandidate">[[!JSEP]]</span>. Use
<code><var>candidate</var>.ufrag</code> to identify the
ICE <a>generation</a>; if the ufrag is null, process the
<code><var>candidate</var>.usernameFragment</code> to identify the
ICE <a>generation</a>; if <code>usernameFragment</code> is null, process the
<var>candidate</var> for the most recent ICE
<a>generation</a>. If
<code><var>candidate</var>.candidate</code> is an empty
Expand Down Expand Up @@ -3901,7 +3901,7 @@ <h4><dfn>RTCIceCandidate</dfn> Interface</h4>
<p>This interface describes an ICE candidate, described in
[[!ICE]] Section 2. Other than
<code>candidate</code>, <code>sdpMid</code>,
<code>sdpMLineIndex</code>, and <code>ufrag</code>,
<code>sdpMLineIndex</code>, and <code>usernameFragment</code>,
the remaining attributes are derived from parsing the
<code>candidate</code> member in <var>candidateInitDict</var>,
if it is well formed.</p>
Expand All @@ -3922,7 +3922,7 @@ <h4><dfn>RTCIceCandidate</dfn> Interface</h4>
readonly attribute RTCIceTcpCandidateType? tcpType;
readonly attribute DOMString? relatedAddress;
readonly attribute unsigned short? relatedPort;
readonly attribute DOMString? ufrag;
readonly attribute DOMString? usernameFragment;
RTCIceCandidateInit toJSON();
};</pre>
<section>
Expand Down Expand Up @@ -3952,7 +3952,7 @@ <h2>Constructor</h2>
<a><code>tcpType</code></a>, <a><code>relatedAddress</code></a>,
and <a><code>relatedPort</code></a>.</li>
<li>Set the <a><code>candidate</code></a>, <a><code>sdpMid</code></a>,
<a><code>sdpMLineIndex</code></a>, <a><code>ufrag</code></a> attributes
<a><code>sdpMLineIndex</code></a>, <a><code>usernameFragment</code></a> attributes
of <var>iceCandidate</var> with the corresponding dictionary member values
of <var>candidateInitDict</var>.</li>
<li>Let <var>candidate</var> be the <code>
Expand All @@ -3976,7 +3976,7 @@ <h2>Constructor</h2>
parsing and type checking for the dictionary members in
<var>candidateInitDict</var>. Detailed validation on the well-formedness
of <code>candidate</code>, <code>sdpMid</code>, <code>sdpMLineIndex</code>,
<code>ufrag</code> with the corresponding session description is done
<code>usernameFragment</code> with the corresponding session description is done
when passing the <code>RTCIceCandidate</code> object to <a>
<code>addIceCandidate()</code></a>.</p>

Expand Down Expand Up @@ -4117,7 +4117,7 @@ <h2>Attributes</h2>
the candidate that it is derived from. For host candidates, the
<code>relatedPort</code> is <code>null</code>. This corresponds to
the <code>rel-port</code> field in <a><code>candidate-attribute</code></a>.</dd>
<dt><code><dfn>ufrag</dfn></code> of type <span class=
<dt><code><dfn>usernameFragment</dfn></code> of type <span class=
"idlAttrType"><a>DOMString</a></span>, readonly, nullable</dt>
<dd>This carries the <code>ufrag</code> as defined in section
15.4 of [[!ICE]].</dd>
Expand Down Expand Up @@ -4146,7 +4146,7 @@ <h2>Methods</h2>
DOMString candidate = "";
DOMString? sdpMid = null;
unsigned short? sdpMLineIndex = null;
DOMString ufrag;
DOMString usernameFragment;
};</pre>
<section>
<h2>Dictionary <dfn>RTCIceCandidateInit</dfn>
Expand All @@ -4172,7 +4172,7 @@ <h2>Dictionary <dfn>RTCIceCandidateInit</dfn>
<dd>If not <code>null</code>, this indicates the index (starting at
zero) of the <a>media description</a> in the SDP this candidate
is associated with.</dd>
<dt><dfn><code>ufrag</code></dfn> of type <span class=
<dt><dfn><code>usernameFragment</code></dfn> of type <span class=
"idlMemberType"><a>DOMString</a></span></dt>
<dd>This carries the <code>ufrag</code> as defined in section
15.4 of [[!ICE]].</dd>
Expand Down Expand Up @@ -7796,7 +7796,7 @@ <h3><dfn>RTCIceTransport</dfn> Interface</h3>
<code><a data-for="RTCIceCandidate">sdpMLineIndex</a></code>
set to the values associated with this
<code><a>RTCIceTransport</a></code>, with
<code><a data-for="RTCIceCandidate">ufrag</a></code> set to the ufrag
<code><a data-for="RTCIceCandidate">usernameFragment</a></code> set to the username fragment
of the <a>generation</a> of candidates for which gathering finished, with
<code><a data-for="RTCIceCandidate">candidate</a></code> set to an
empty string, and with all other nullable members set to null.</p>
Expand Down

0 comments on commit 2bbef96

Please sign in to comment.