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

refactor(iroh-net): More renaming of endpoint to direct address #2515

Merged
merged 4 commits into from
Jul 18, 2024

Conversation

flub
Copy link
Contributor

@flub flub commented Jul 16, 2024

Description

The name "endpoint" is overloaded and we decided a while ago to not
use it for things other than iroh_net::Endpoint. This further
renames more places that were called endpoint with the new name we
already introduced for them: direct address. The direct address
naming is already used consistently on public APIs, this is only for
internal consistency.

Breaking Changes

metric changed: magicsock::metrics::Metrics::update_endpoints -> Metrics::update_direct_addrs.

Notes & open questions

Change checklist

  • Self-review.
  • Documentation updates following the style guide, if relevant.
  • Tests if relevant.
  • All breaking changes documented.

The name "endpoint" is overloaded and we decided a while ago to not
use it for things other than `iroh_net::Endpoint`.  This further
renames more places that were called endpoint with the new name we
already introduced for them: direct address.  The direct address
naming is already used consistently on public APIs, this is only for
internal consistency.
@flub flub added refactor a change that neither fixes a bug nor adds a feature c-iroh-net labels Jul 16, 2024
Copy link
Contributor

@matheus23 matheus23 left a comment

Choose a reason for hiding this comment

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

Only small nits ✌️

Copy link
Contributor

@divagant-martian divagant-martian left a comment

Choose a reason for hiding this comment

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

minor things. LGTM and I find it easier to read

iroh-net/src/magicsock.rs Outdated Show resolved Hide resolved
iroh-net/src/magicsock.rs Outdated Show resolved Hide resolved
iroh-net/src/magicsock.rs Outdated Show resolved Hide resolved
iroh-net/src/magicsock.rs Outdated Show resolved Hide resolved
@dignifiedquire dignifiedquire added this to the v0.21.0 milestone Jul 17, 2024
Some more re-namings and docs tweaks

Co-authored-by: Divma <[email protected]>
Co-authored-by: Philipp Krüger <[email protected]>
@flub
Copy link
Contributor Author

flub commented Jul 18, 2024

thanks for all the additional suggestions!

@flub flub enabled auto-merge July 18, 2024 10:08
@flub flub added this pull request to the merge queue Jul 18, 2024
Merged via the queue into main with commit 0c03f6e Jul 18, 2024
25 of 26 checks passed
@flub flub deleted the flub/direct-addr-no-endpoint branch July 18, 2024 11:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c-iroh-net refactor a change that neither fixes a bug nor adds a feature
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants