-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
427a1fd
commit 473b226
Showing
3 changed files
with
149 additions
and
261 deletions.
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
126 changes: 126 additions & 0 deletions
126
kotlinx-coroutines-core/jsAndWasmShared/src/internal/JSDispatcher.kt
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 |
---|---|---|
@@ -0,0 +1,126 @@ | ||
/* | ||
* Copyright 2016-2023 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license. | ||
*/ | ||
|
||
package kotlinx.coroutines | ||
|
||
import kotlinx.coroutines.internal.* | ||
import org.w3c.dom.* | ||
import kotlin.coroutines.* | ||
|
||
private const val MAX_DELAY = Int.MAX_VALUE.toLong() | ||
|
||
private fun delayToInt(timeMillis: Long): Int = | ||
timeMillis.coerceIn(0, MAX_DELAY).toInt() | ||
|
||
internal sealed class SetTimeoutBasedDispatcher: CoroutineDispatcher(), Delay { | ||
val messageQueue = ScheduledMessageQueue(this) | ||
|
||
abstract fun scheduleQueueProcessing() | ||
|
||
override fun limitedParallelism(parallelism: Int): CoroutineDispatcher { | ||
parallelism.checkParallelism() | ||
return this | ||
} | ||
|
||
override fun dispatch(context: CoroutineContext, block: Runnable) { | ||
messageQueue.enqueue(block) | ||
} | ||
|
||
override fun invokeOnTimeout(timeMillis: Long, block: Runnable, context: CoroutineContext): DisposableHandle { | ||
val handle = setTimeout({ block.run() }, delayToInt(timeMillis)) | ||
return ClearTimeout(handle) | ||
} | ||
|
||
override fun scheduleResumeAfterDelay(timeMillis: Long, continuation: CancellableContinuation<Unit>) { | ||
val handle = setTimeout({ with(continuation) { resumeUndispatched(Unit) } }, delayToInt(timeMillis)) | ||
continuation.invokeOnCancellation(handler = ClearTimeout(handle).asHandler) | ||
} | ||
} | ||
|
||
internal class WindowDispatcher(private val window: Window) : CoroutineDispatcher(), Delay { | ||
private val queue = WindowMessageQueue(window) | ||
|
||
override fun dispatch(context: CoroutineContext, block: Runnable) = queue.enqueue(block) | ||
|
||
override fun scheduleResumeAfterDelay(timeMillis: Long, continuation: CancellableContinuation<Unit>) { | ||
val handle = setTimeout(window, { with(continuation) { resumeUndispatched(Unit) } }, delayToInt(timeMillis)) | ||
continuation.invokeOnCancellation(handler = WindowClearTimeout(handle).asHandler) | ||
} | ||
|
||
override fun invokeOnTimeout(timeMillis: Long, block: Runnable, context: CoroutineContext): DisposableHandle { | ||
val handle = setTimeout(window, block::run, delayToInt(timeMillis)) | ||
return WindowClearTimeout(handle) | ||
} | ||
|
||
private inner class WindowClearTimeout(handle: Int) : ClearTimeout(handle) { | ||
override fun dispose() { | ||
window.clearTimeout(handle) | ||
} | ||
} | ||
} | ||
|
||
internal object SetTimeoutDispatcher : SetTimeoutBasedDispatcher() { | ||
override fun scheduleQueueProcessing() { | ||
setTimeout(messageQueue.processQueue, 0) | ||
} | ||
} | ||
|
||
private open class ClearTimeout(protected val handle: Int) : CancelHandler(), DisposableHandle { | ||
|
||
override fun dispose() { | ||
clearTimeout(handle) | ||
} | ||
|
||
override fun invoke(cause: Throwable?) { | ||
dispose() | ||
} | ||
|
||
override fun toString(): String = "ClearTimeout[$handle]" | ||
} | ||
|
||
|
||
/** | ||
* An abstraction over JS scheduling mechanism that leverages micro-batching of dispatched blocks without | ||
* paying the cost of JS callbacks scheduling on every dispatch. | ||
* | ||
* Queue uses two scheduling mechanisms: | ||
* 1) [schedule] is used to schedule the initial processing of the message queue. | ||
* JS engine-specific microtask mechanism is used in order to boost performance on short runs and a dispatch batch | ||
* 2) [reschedule] is used to schedule processing of the queue after yield to the JS event loop. | ||
* JS engine-specific macrotask mechanism is used not to starve animations and non-coroutines macrotasks. | ||
* | ||
* Yet there could be a long tail of "slow" reschedules, but it should be amortized by the queue size. | ||
*/ | ||
internal abstract class MessageQueue : MutableList<Runnable> by ArrayDeque() { | ||
val yieldEvery = 16 // yield to JS macrotask event loop after this many processed messages | ||
private var scheduled = false | ||
|
||
abstract fun schedule() | ||
|
||
abstract fun reschedule() | ||
|
||
fun enqueue(element: Runnable) { | ||
add(element) | ||
if (!scheduled) { | ||
scheduled = true | ||
schedule() | ||
} | ||
} | ||
|
||
fun process() { | ||
try { | ||
// limit number of processed messages | ||
repeat(yieldEvery) { | ||
val element = removeFirstOrNull() ?: return@process | ||
element.run() | ||
} | ||
} finally { | ||
if (isEmpty()) { | ||
scheduled = false | ||
} else { | ||
reschedule() | ||
} | ||
} | ||
} | ||
} |
Oops, something went wrong.