tokio: wake localset on spawn_local #3369
Merged
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
Wake the `tokio::task::LocalSet` after `tokio::task::LocalSet::spawn_local` is called. Note this side effect in the `tokio::task::LocalSet::spawn_local` docs. Add test for spawn_local being woke in `task_local_set.rs` Fixes: tokio-rs#3117
Darksonn
approved these changes
Jan 3, 2021
tokio/src/task/local.rs
Outdated
Comment on lines
245
to
246
| /// Calls to this function will result in waking the current localset. | ||
| /// |
There was a problem hiding this comment.
I'm not sure this is necessary to have in the doc?
There was a problem hiding this comment.
Happy to remove it if you don't think it is necessary. I added it because a side effect that changes program behavior is worth noting imo.
There was a problem hiding this comment.
I don't think it is necessary. The "wake" is an implementation detail.
There was a problem hiding this comment.
Besides, notes about changes in behavior go in the changelog instead. (You don't have to put it in this PR, we do them together when making the release.)
There was a problem hiding this comment.
Makes sense - Thanks for the review! Pushed the suggested changes.
Merged
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.
Wake the
tokio::task::LocalSetaftertokio::task::LocalSet::spawn_localis called.Note this side effect in the
tokio::task::LocalSet::spawn_localdocs.Add test for spawn_local being woke in
task_local_set.rsFixes: #3117
Motivation
Fixes #3117
Solution
Add call to shared waker in localset after adding future to localset task queue.