refactor(iroh): Remove CancellationToken from Endpoint #3101
Conversation
This file contains hidden or 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
The internal CancellationToke was used to know by other parts of the code when the endpoint is shut down. But those bits of code already have mechanisms to do so. This bit of API makes is a bit of extra complexity that is not needed. Closes #3096
|
cc @arilotter |
|
Documentation for this PR has been generated and is available at: https://n0-computer.github.io/iroh/pr/3101/docs/iroh/ Last updated: 2025-01-07T13:55:40Z |
| @@ -289,7 +288,7 @@ impl RouterBuilder { | |||
| // handle incoming p2p connections. | |||
| incoming = endpoint.accept() => { | |||
| let Some(incoming) = incoming else { | |||
| break; | |||
| break; // Endpoint is closed. | |||
There was a problem hiding this comment.
do we need to cancel the token here?
There was a problem hiding this comment.
Good point, but we should probably cancel the token around the shutdown(&endpoint, protocols).await line.
There was a problem hiding this comment.
Line 257 above makes a drop guard from the cancel_token. Isn't that sufficient? Or do we think this is being dropped too late?
dignifiedquire
approved these changes
Jan 8, 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
The internal CancellationToke was used to know by other parts of the
code when the endpoint is shut down. But those bits of code already
have mechanisms to do so. This bit of API makes is a bit of extra
complexity that is not needed.
Breaking Changes
None, this is internal.
Notes & open questions
Closes #3096.
Closes #3098 (replaces).
Maybe not directly but now there's an example of how to write an
accept loop without having to rely on the CancellationToken.
Change checklist