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.

Sign up for GitHub

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

Jump to bottom

Inconsistent documentation on platform availability of local_ip #1864

Closed
Pixelstormer opened this issue May 16, 2024 · 3 comments · Fixed by #1868
Closed

Inconsistent documentation on platform availability of local_ip #1864

Pixelstormer opened this issue May 16, 2024 · 3 comments · Fixed by #1868

Comments

@Pixelstormer
Copy link
Contributor

Of the three local_ip methods that exist on quinn_proto::Connection, quinn::Connection, and quinn::Connecting, they each list a different set of platforms on which the method is supposedly available.

The proto Connection lists Linux and Windows, the quinn Connection lists only Linux, and Connecting lists Linux, FreeBSD and macOS. The documentation of all three of these functions should be reconciled to whatever the true set of supported platforms is.
@Ralith
Copy link
Collaborator

Ralith commented May 16, 2024

Thanks for the report! We should probably list this information in one place and link to it from elsewhere to avoid drift in the future.

@djc
Copy link
Collaborator

djc commented May 16, 2024

I think perhaps quinn-proto should not document platform support, because availability seems fully dependent on the caller?

@djc
Copy link
Collaborator

djc commented May 16, 2024

So I think the current list is:

  • Windows
  • Linux
  • Android
  • FreeBSD
  • macOS
  • iOS

For implementations that use an AsyncUdpSocket based on quinn-udp.

@Ralith Ralith mentioned this issue May 17, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Centralize and update local_ip platform support documentation quinn-rs/quinn
3 participants
@Ralith @djc @Pixelstormer