feat(iroh): make Endpoint::cancel_token public #3098
Closed
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
It's used inside the Router to automatically shut down if the Endpoint is shut down, but this is a privilege uniquely granted to Router since it's part of Iroh proper. End-user code with a custom accept loop is not able to see this cancel_token method, and thus is not able to automatically shut down should the Endpoint shut down. To bring end-user accept loops into feature parity with Iroh's internals, this method must be `pub`. Closes n0-computer#3096
4 tasks
github-merge-queue bot
pushed a commit
that referenced
this pull request
Jan 8, 2025
## 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 - [x] Self-review. - [x] Documentation updates following the [style guide](https://rust-lang.github.io/rfcs/1574-more-api-documentation-conventions.html#appendix-a-full-conventions-text), if relevant. - [x] 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.
It's used inside the Router to automatically shut down if the Endpoint is shut down, but this is a privilege uniquely granted to Router since it's part of Iroh proper.
End-user code with a custom accept loop is not able to see this cancel_token method, and thus is not able to automatically shut down should the Endpoint shut down.
To bring end-user accept loops into feature parity with Iroh's internals, this method must be
pub.Closes #3096