Skip to content
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
merged 1 commit into from
May 15, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions jvm/src/main/scala/async/JvmAsyncOperations.scala
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 =
Copy link
Contributor

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 named interruptible?
on unsupported platform, which can be just a noop.

Copy link
Contributor Author

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 under JvmAsyncOperations, but I think it might be confused with the uninterruptible function that we do have outside.
They also take the same argument types, to add to the fire :)

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))
Loading