-
Notifications
You must be signed in to change notification settings - Fork 25
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Make jvmInterruptible
public
#73
Merged
natsukagami
merged 1 commit into
lampepfl:main
from
natsukagami:make-jvmInterruptible-public
May 15, 2024
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,17 @@ | ||
package gears.async | ||
|
||
object JvmAsyncOperations extends AsyncOperations: | ||
override def sleep(millis: Long)(using Async): Unit = | ||
jvmInterruptible(Thread.sleep(millis)) | ||
|
||
private def jvmInterruptible[T](fn: => T)(using Async): T = | ||
/** Runs `fn` in a [[cancellationScope]] where it will be interrupted (as a Java thread) upon cancellation. | ||
* | ||
* Note that `fn` will need to handle both [[java.util.concurrent.CancellationException]] (when performing Gears | ||
* operations such as `.await`) *and* [[java.lang.InterruptedException]], so the intended use case is usually to wrap | ||
* interruptible Java operations, containing `fn` to a narrow scope. | ||
*/ | ||
def jvmInterruptible[T](fn: => T)(using Async): T = | ||
val th = Thread.currentThread() | ||
cancellationScope(() => th.interrupt()): | ||
try fn | ||
catch case _: InterruptedException => throw new CancellationException() | ||
|
||
override def sleep(millis: Long)(using Async): Unit = | ||
jvmInterruptible(Thread.sleep(millis)) |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
as this method is alread inside the
JvmAsyncOperations
, why it's not been namedinterruptible
?on unsupported platform, which can be just a noop.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We already don't compile this function on an unsupported platform. I usually don't like the idea that we expose a function that sounds like it does something but is actually a no-op underneath 😓
We could call this function
interruptible
since it's already underJvmAsyncOperations
, but I think it might be confused with theuninterruptible
function that we do have outside.They also take the same argument types, to add to the fire :)