AndroidUiDispatcher

Artifact: androidx.compose.ui:ui

View Source

Added in 1.0.0

Common/AllAndroid/JVM

• android

  class AndroidUiDispatcher : CoroutineDispatcher

kotlin.Any
↳	kotlin.coroutines.AbstractCoroutineContextElement
	↳	kotlinx.coroutines.CoroutineDispatcher
		↳	androidx.compose.ui.platform.AndroidUiDispatcher

---

A CoroutineDispatcher that will perform dispatch during a handler callback or choreographer's animation frame stage, whichever comes first. Use Main to obtain a dispatcher for the process's main thread (i.e. the activity thread) or CurrentThread to obtain a dispatcher for the current thread.

Summary

Public companion properties
CoroutineContext	CurrentThread The canonical CoroutineContext containing the AndroidUiDispatcher and its frameClock for the calling thread.	android
CoroutineContext	Main The CoroutineContext containing the AndroidUiDispatcher and its frameClock for the process's main thread.	android

Public functions
open Unit	dispatch(context: CoroutineContext, block: Runnable)	android

Public properties
Choreographer	choreographer	android
MonotonicFrameClock	frameClock A MonotonicFrameClock associated with this AndroidUiDispatcher's choreographer that may be used to await Choreographer frame dispatch.	android

Inherited functions
From kotlin.coroutines.CoroutineContext open operator CoroutineContext plus(context: CoroutineContext) android
From kotlin.coroutines.CoroutineContext.Element open R <R : Any?> fold(initial: R, operation: (CoroutineContext.Element, R) -> R) android open operator E? <E : CoroutineContext.Element> get(key: CoroutineContext.Key<E>) android open CoroutineContext minusKey(key: CoroutineContext.Key<*>) android
From kotlinx.coroutines.CoroutineDispatcher open Unit @InternalCoroutinesApi dispatchYield(context: CoroutineContext, block: Runnable) android final Continuation<T> <T : Any?> interceptContinuation(continuation: Continuation<T>) android open Boolean isDispatchNeeded(context: CoroutineContext) android open CoroutineDispatcher @ExperimentalCoroutinesApi limitedParallelism(parallelism: Int) android operator CoroutineDispatcher plus(other: CoroutineDispatcher) This function is deprecated. Operator '+' on two CoroutineDispatcher objects is meaningless. android final Unit releaseInterceptedContinuation(continuation: Continuation<*>) android open String toString() android

Inherited properties
From kotlin.coroutines.AbstractCoroutineContextElement open CoroutineContext.Key<*> key android

Public companion properties

CurrentThread

android

Added in 1.0.0

val CurrentThread: CoroutineContext

The canonical CoroutineContext containing the AndroidUiDispatcher and its frameClock for the calling thread. Returns Main if accessed from the process's main thread.

Throws IllegalStateException if the calling thread does not have both a Choreographer and an active Looper.

Main

android

Added in 1.0.0

val Main: CoroutineContext

The CoroutineContext containing the AndroidUiDispatcher and its frameClock for the process's main thread.

Public functions

dispatch

android

Added in 1.0.0

open fun dispatch(context: CoroutineContext, block: Runnable): Unit

Public properties

choreographer

android

Added in 1.0.0

val choreographer: Choreographer

frameClock

android

Added in 1.0.0

val frameClock: MonotonicFrameClock

A MonotonicFrameClock associated with this AndroidUiDispatcher's choreographer that may be used to await Choreographer frame dispatch.