DefaultDispatcherProvider

Production DispatcherProvider backed by the real Dispatchers.

main is resolved on every access and never at construction, so using this provider on platforms without a main dispatcher (plain JVM) only fails if main is actually read. io uses ioCompat, which is safe in common code.

Example:

val repo = UserRepository(DefaultDispatcherProvider)

Rules: DISPATCH_005, KMP_001, TEST_005. See docs/BEST_PRACTICES_COROUTINES.md.

Requires opting in to ExperimentalStructuredCoroutines. Stateless and thread-safe.

See also

Properties

Link copied to clipboard
open override val default: CoroutineDispatcher

Dispatcher for CPU-bound work.

Link copied to clipboard
open override val io: CoroutineDispatcher

Dispatcher for blocking IO. The default implementation resolves it through ioCompat.

Link copied to clipboard
open override val main: CoroutineDispatcher

UI dispatcher. May be unavailable on platforms without a main dispatcher (for example a plain JVM process without a UI toolkit); in that case accessing it fails the way Dispatchers.Main does.

Link copied to clipboard
open override val unconfined: CoroutineDispatcher

Unconfined dispatcher. Runs in the caller thread until the first suspension; avoid for work that needs thread affinity.

Functions

Link copied to clipboard

Wraps this provider's main, io and default dispatchers in InstrumentedDispatchers with those labels; unconfined is returned as is (see InstrumentedDispatcherProvider). Wrapping is lazy: nothing (including Dispatchers.Main) is read until the corresponding property is accessed.

Link copied to clipboard

Wraps this provider's main, io and default dispatchers in TracingDispatchers labeled "main", "io" and "default" that report to sink. unconfined is returned as is.