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.

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

RTCTransportStats - updates #37158

Open
wants to merge 12 commits into
base: main
Choose a base branch
from

Conversation

hamishwillee
Copy link
Collaborator

@hamishwillee hamishwillee commented Dec 10, 2024

This updates RTCTransportStats to match BCD as part of mdn/mdn#384

The main reason for this was consistency - most of the other stats/API docs document properties individually. This one had everything in the top level stats docs.
In many cases this adds nothing extra over the original. Though in some cases it does allow the top level to be simpler, making it easier to scan.

@github-actions github-actions bot added the Content:WebAPI Web API docs label Dec 10, 2024
@github-actions github-actions bot added the size/m [PR only] 51-500 LoC changed label Dec 10, 2024
Copy link
Contributor

github-actions bot commented Dec 10, 2024

Comment on lines 33 to 35
- {{domxref("RTCTransportStats.iceLocalUsernameFragment", "iceLocalUsernameFragment")}} {{optional_inline}} {{experimental_inline}}
- : A string indicating the local username fragment that uniquely identifies the ICE interaction session managed by this transport.
This is the same value as the local {{domxref("RTCIceCandidate.usernameFragment")}}, and will change if the connection is renegotiated.
Copy link
Collaborator Author

@hamishwillee hamishwillee Dec 13, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note, the spec says

Set to the current value of the local username fragment used in message validation procedures [RFC5245] for this RTCIceTransport. It may be updated on setLocalDescription() and on ICE restart.

it is not clear if that validation is something the browser does or the developer does (to me). I THINK that the fragment is used to associate the transport to the messages on it, so at this point the validation has already happened. i.e. that is of interest to browser developers, not end users.

I am not sure what a developer would do with this stat, though presumably they can map it to other stats that are part of the same session.

## Value

A string that will be one of the following values: `new`, `connecting`, `connected`, `closed`, `failed`.

Copy link
Collaborator Author

@hamishwillee hamishwillee Dec 17, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FYI I have followed this pattern for values that are effectively copies of other properties - a link up top explaining it has the same values, and then a flat list in the Value section. There is no point duplicating this information here so I am maintaining it in one place.

@github-actions github-actions bot added size/l [PR only] 501-1000 LoC changed and removed size/m [PR only] 51-500 LoC changed labels Dec 17, 2024
@hamishwillee hamishwillee force-pushed the RTCTransportStats_update branch from df2f790 to 4e630e7 Compare December 17, 2024 05:55
@hamishwillee hamishwillee marked this pull request as ready for review December 17, 2024 05:55
@hamishwillee hamishwillee requested a review from a team as a code owner December 17, 2024 05:55
@hamishwillee hamishwillee requested review from wbamberg and removed request for a team December 17, 2024 05:55
@hamishwillee hamishwillee force-pushed the RTCTransportStats_update branch from 4e630e7 to 45d294a Compare January 20, 2025 03:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:WebAPI Web API docs size/l [PR only] 501-1000 LoC changed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants