Add flatScheduledTask() methods to EventLoop #1497
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
…EventLoop.
Motivation:
Currently the best, or at least simplest, way to schedule a delayed asynchronous task and wait on its complete result is something like `eventLoop.scheduleTask(in: ...) { return somethingAsync(...) }.futureResult.flatMap { $0 }`. This is not only unobvious but also a bit ugly.
Modifications:
I have added methods which correspond to scheduleTask() in the same way flatSubmit() does to submit(). The returned Scheduled<T> object allows cancellation of the asynchronous task's execution in the same way that is possible for synchronous scheduled tasks, and the futureResult does not complete until the entire asynchronous task does. Callers wishing to wait only for submission of the delayed task, rather than its overall completion, may continue to use the existing scheduleTask() APIs to do so. Tests have been added to verify that the behavior of the new methods is as expected.
These changes are purely additive.
weissi
requested changes
Apr 29, 2020
glbrntt
requested changes
Apr 29, 2020
…they can actually be used, too!
…y to precisely control time. For good measure, retrofit the existing tests that were copy/pasted to create the new ones.
… XCTest features.
Lukasa
requested changes
Apr 30, 2020
Co-Authored-By: Cory Benfield <lukasa@apple.com>
…seconds(0))`, thus redundant. Fix new tests, original tests, and the bad example in the repeated async task test.
Lukasa
requested changes
Apr 30, 2020
…t-scheduling tasks.
pull bot
pushed a commit
to scope-demo/swift-nio
that referenced
this pull request
May 11, 2020
Motivation:
Currently the best, or at least simplest, way to schedule a delayed asynchronous task and wait on its complete result is something like `eventLoop.scheduleTask(in: ...) { return somethingAsync(...) }.futureResult.flatMap { $0 }`. This is not only unobvious but also a bit ugly.
Modifications:
I have added methods which correspond to scheduleTask() in the same way flatSubmit() does to submit(). The returned Scheduled<T> object allows cancellation of the asynchronous task's execution in the same way that is possible for synchronous scheduled tasks, and the futureResult does not complete until the entire asynchronous task does. Callers wishing to wait only for submission of the delayed task, rather than its overall completion, may continue to use the existing scheduleTask() APIs to do so. Tests have been added to verify that the behavior of the new methods is as expected.
These changes are purely additive.
Co-authored-by: Cory Benfield <lukasa@apple.com>
Co-authored-by: Johannes Weiss <johannesweiss@apple.com>
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
Add
flatScheduleTask(deadline:)andflatScheduleTask(in:)methods toEventLoop.Motivation:
Currently the best, or at least simplest, way to schedule a delayed asynchronous task and wait on its complete result is something like
eventLoop.scheduleTask(in: ...) { return somethingAsync(...) }.futureResult.flatMap { $0 }. This is not only unobvious but also a bit ugly.Modifications:
I have added methods which correspond to scheduleTask() in the same way flatSubmit() does to submit(). The returned Scheduled object allows cancellation of the asynchronous task's execution in the same way that is possible for synchronous scheduled tasks, and the futureResult does not complete until the entire asynchronous task does. Callers wishing to wait only for submission of the delayed task, rather than its overall completion, may continue to use the existing scheduleTask() APIs to do so. Tests have been added to verify that the behavior of the new methods is as expected.
I also made a few very minor corrections to a couple of documentation comments which suffered from copy-pasta.
Result:
These changes are purely additive.