feat(iroh)!: Wrap the Connection struct so we own the type #3110
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 makes iroh own the Connection type. This is desireable because: - Some: upstream APIs don't work well for us, e.g. Connection::remote_address is not that meaningful. This allows us to remove those and replace them with more appropriate APIs. This has not yet been done in this PR however. - The connection type and changes are currently on the Endpoint, they also belong on the Connection. - Connection information, like which pats are used, the latencies of those paths etc, also belong on the Connection. - It is generally not great to expose types which you have no control over in your public API. For the 1.0 we do not want to have any such structs. This takes an important step in that direction. As part of this change Connection::remote_node_id replaces the get_remote_node_id function. Also Connection::alpn now exists.
3 tasks
|
Documentation for this PR has been generated and is available at: https://n0-computer.github.io/iroh/pr/3110/docs/iroh/ Last updated: 2025-01-09T11:05:55Z |
matheus23
reviewed
Jan 9, 2025
| /// connection. | ||
| /// | ||
| /// [`PublicKey`]: iroh_base::PublicKey | ||
| // TODO: Would be nice if this could be infallible. |
There was a problem hiding this comment.
Are there cases where we expect this to be fallible?
Why not make this infallible by using self.peer_identity().unwrap()?
Is returning an error here a boneheaded exception?
matheus23
approved these changes
Jan 9, 2025
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 makes iroh own the Connection type. This is desireable because:
Some: upstream APIs don't work well for us,
e.g. Connection::remote_address is not that meaningful. This allows
us to remove those and replace them with more appropriate APIs. This
has not yet been done in this PR however.
The connection type and changes are currently on the Endpoint, they
also belong on the Connection.
Connection information, like which pats are used, the latencies of
those paths etc, also belong on the Connection.
It is generally not great to expose types which you have no control
over in your public API. For the 1.0 we do not want to have any
such structs. This takes an important step in that direction.
As part of this change Connection::remote_node_id replaces the
get_remote_node_id function. Also Connection::alpn now exists.
Breaking Changes
iroh
iroh::endpoint::get_remote_node_idhas been removed. Useiroh::endpoint::Connection::remote_node_idinstead.Notes & open questions
This does not yet clean up the existing methods in the Connection,
preserving most of them as-is. It is easier to handle those
separately as each one involves careful decisions about the API.
Replaces #2768
Change checklist