refactor(iroh-net)!: Rename endpoint for nodes to node_state #2222
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
We still have many things named "endpoint", this targets cleaning up the naming of the state for each node that is stored in the NodeMap. This is now called NodeState instead of Endpoint. All related APIs now talk about nodes and node states instead of endpoints. Another minor cleanup is in the NodeState we had private fields with accessor functions, except for one field which was directly accessible. This is migrated to accessor functions for consistency as well.
This visibility was already implicitly so, making it explicit makes this much easier to work with.
flub
changed the title
dignifiedquire
approved these changes
Apr 23, 2024
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
We still have too many things named "endpoint", this targets cleaning
up the naming of the state for each node that is stored in the NodeMap.
This is now called
NodeStateinstead ofEndpoint. All related APIsnow talk about nodes and node states instead of endpoints.
Another minor cleanup is in the
NodeStatewe had private fields withaccessor functions, except for one field which was directly
accessible. This is migrated to accessor functions for consistency as
well.
Finally it marks the visibility of some functions more explicitly, the
visibility of those was already as such. This makes it easier to work
and realise the impact changes have however.
Breaking Changes
MagicSock::tracked_endpoints->MagicSock::connection_infosMagicSock::tracked_endpoint->MagicSock::connection_infomagicsock::EndpointInfo->magicsock::ConnectionInfoNotes & open questions
Finally had to courage to change this, it's much less worse than I
feared and to me it really helps calling this
NodeState. I findit a noticeable improvement.
Change checklist