oskit-kmp/com.outsidesource.oskitkmp.concurrency

Package-level declarations

Types

class CancellableTimeout(timeoutMillis: Int, scope: CoroutineScope = CoroutineScope(Dispatchers.Default + Job()), onTimeout: suspend () -> Unit)

Debouncer

class Debouncer(timeoutMillis: Int, maxWaitMillis: Int = -1, scope: CoroutineScope = CoroutineScope(Dispatchers.Default + Job()))

A coroutine based debouncer

FlowTimeoutCancellationException

class FlowTimeoutCancellationException(timeout: Long) : CancellationException

KmpDispatchers

actual object KmpDispatchers

expect object KmpDispatchers

actual object KmpDispatchers

KmpJsException

data class KmpJsException(val error: JsAny) : Throwable

KotlinNativeFlowWrapper

class KotlinNativeFlowWrapper<T : Any>(flow: Flow<T>)

Queue

class Queue

Throttler

class Throttler(timeoutMillis: Int, scope: CoroutineScope = CoroutineScope(Dispatchers.Default + Job()))

A coroutine-based throttler

WorkerPool

class WorkerPool(workerCount: Int = 10, scope: CoroutineScope = CoroutineScope(KmpDispatchers.IO + SupervisorJob()))

Creates a worker pool for running a set number of concurrent tasks at a time

Functions

asyncOutcome

fun <T> CoroutineScope.asyncOutcome(block: suspend CoroutineScope.() -> Outcome<T, Any>): Deferred<Outcome<T, Any>>

Creates a deferred result that does not cancel the parent upon failure but instead returns an Outcome. Best used with awaitOutcome.

awaitOutcome

suspend fun <T> Deferred<T>.awaitOutcome(): Outcome<T, Any>

Awaits a deferred and returns an outcome instead of throwing an error on cancellation.

@JvmName(name = "awaitDeferredOutcome")

suspend fun <T> Deferred<Outcome<T, Any>>.awaitOutcome(): Outcome<T, Any>

Awaits a deferred and returns an outcome instead of throwing an error on cancellation. Best used with asyncOutcome.

filterIsInstance

inline fun <R> Flow<*>.filterIsInstance(crossinline predicate: suspend (R) -> Boolean): Flow<R>

Filters flow elements that don't match a given instance along with a provided predicate

flowIn

fun <T> Flow<T>.flowIn(scope: CoroutineScope): Flow<T>

Runs a flow in a given coroutine scope. If the scope is cancelled, the flow will complete.

kmpAwait

suspend fun <T : JsAny?> Promise<T>.kmpAwait(): T

kmpAwaitOutcome

suspend fun <T : JsAny?> Promise<T>.kmpAwaitOutcome(): Outcome<T, KmpJsException>

throttle

fun <T> Flow<T>.throttle(periodMillis: Long): Flow<T>

Throttles a flow at a specific interval. This will only return one emission during the specified period.

withDelay

suspend fun withDelay(delayInMillis: Long, block: suspend () -> Any): Job

Run a block after a timeout/delay

withTimeout

fun <T> Flow<T>.withTimeout(timeout: Long, throwOnTimeout: Boolean = false): Flow<T>

Stops the flow when the time elapsed since collect start >= timeout Throws a FlowTimeoutCancellationException if throwOnTimeout == true

withTimeoutOrOutcome

suspend fun <T> withTimeoutOrOutcome(timeoutMillis: Long, block: suspend CoroutineScope.() -> Outcome<T, Any>): Outcome<T, Any>

suspend fun <T, E> withTimeoutOrOutcome(timeoutMillis: Long, timeoutError: E, block: suspend CoroutineScope.() -> Outcome<T, E>): Outcome<T, E>