refactor(iroh-net)!: Rename Endpoint::local_addr to bound_sockets #2366
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This renames Endpoint::local_addr to Endpoint::bound_sockets. We have a lot of different meanings for "addr" and also don't really have a notion of "local_" prefix, since the endpoint is not 1:1 connected with a peer. The "local_" naming comes from connected sockets which have local_addr and peer_addr, which is not applicable for the Endpoint.
matheus23
approved these changes
Jun 17, 2024
divagant-martian
approved these changes
Jun 17, 2024
ppodolsky
pushed a commit
to izihawa/iroh
that referenced
this pull request
Jun 22, 2024
…-computer#2366) ## Description This renames Endpoint::local_addr to Endpoint::bound_sockets. We have a lot of different meanings for "addr" and also don't really have a notion of "local_" prefix, since the endpoint is not 1:1 connected with a peer. The "local_" naming comes from connected sockets which have local_addr and peer_addr, which is not applicable for the Endpoint. ## Breaking Changes - Endpoint::local_addr -> Endpoint::bound_sockets ## Notes & open questions <!-- Any notes, remarks or open questions you have to make about the PR. --> ## Change checklist - [x] Self-review. - [x] Documentation updates if relevant. - ~~[ ] Tests if relevant.~~ - [x] All breaking changes documented.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This renames Endpoint::local_addr to Endpoint::bound_sockets. We have
a lot of different meanings for "addr" and also don't really have a
notion of "local_" prefix, since the endpoint is not 1:1 connected
with a peer. The "local_" naming comes from connected sockets which
have local_addr and peer_addr, which is not applicable for the
Endpoint.
Breaking Changes
Notes & open questions
Change checklist
[ ] Tests if relevant.