Skip to content

Add name parameter to Handler.asCoroutineDispatcher #615

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Sep 25, 2018
Merged

Add name parameter to Handler.asCoroutineDispatcher #615

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions binary-compatibility-validator/reference-public-api/kotlinx-coroutines-android.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ public abstract class kotlinx/coroutines/experimental/android/HandlerDispatcher
public final class kotlinx/coroutines/experimental/android/HandlerDispatcherKt {
public static final fun awaitFrame (Lkotlin/coroutines/experimental/Continuation;)Ljava/lang/Object;
public static final fun from (Landroid/os/Handler;)Lkotlinx/coroutines/experimental/android/HandlerDispatcher;
public static final fun from (Landroid/os/Handler;Ljava/lang/String;)Lkotlinx/coroutines/experimental/android/HandlerDispatcher;
public static synthetic fun from$default (Landroid/os/Handler;Ljava/lang/String;ILjava/lang/Object;)Lkotlinx/coroutines/experimental/android/HandlerDispatcher;
public static final fun getMain (Lkotlinx/coroutines/experimental/Dispatchers;)Lkotlinx/coroutines/experimental/android/HandlerDispatcher;
}

15 changes: 11 additions & 4 deletions ui/kotlinx-coroutines-android/src/HandlerDispatcher.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,13 @@ public sealed class HandlerDispatcher : CoroutineDispatcher(), Delay {
}

/**
* Represents an arbitrary [Handler] as a implementation of [CoroutineDispatcher].
* Represents an arbitrary [Handler] as a implementation of [CoroutineDispatcher]
* with an optional [name] for nicer debugging
*/
@JvmName("from") // this is for a nice Java API, see issue #255
public fun Handler.asCoroutineDispatcher(): HandlerDispatcher =
HandlerContext(this)
@JvmOverloads
public fun Handler.asCoroutineDispatcher(name: String? = null): HandlerDispatcher =
HandlerContext(this, name)

private const val MAX_DELAY = Long.MAX_VALUE / 2 // cannot delay for too long on Android

Expand Down Expand Up @@ -139,7 +141,12 @@ public class HandlerContext private constructor(
public suspend fun awaitFrame(): Long =
kotlinx.coroutines.experimental.android.awaitFrame()

override fun toString() = name ?: handler.toString()
override fun toString(): String =
if (name != null) {
if (invokeImmediately) "$name [immediate]" else name
} else {
handler.toString()
}

override fun equals(other: Any?): Boolean = other is HandlerContext && other.handler === handler
override fun hashCode(): Int = System.identityHashCode(handler)
Expand Down
9 changes: 9 additions & 0 deletions ui/kotlinx-coroutines-android/test/HandlerDispatcherTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,15 @@ class HandlerDispatcherTest : TestBase() {
job.join(mainLooper)
}

@Test
fun testToString() {
ReflectionHelpers.setStaticField(Build.VERSION::class.java, "SDK_INT", 28)
val main = Looper.getMainLooper().asHandler(async = true).asCoroutineDispatcher("testName")
assertEquals("testName", main.toString())
assertEquals("testName [immediate]", main.immediate.toString())
assertEquals("testName [immediate]", main.immediate.immediate.toString())
}

private suspend fun Job.join(mainLooper: ShadowLooper) {
expect(1)
mainLooper.unPause()
Expand Down