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

The canonical CoroutineContext containing the AndroidUiDispatcher and its frameClock for the calling thread.

android
CoroutineContext

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
android
MonotonicFrameClock

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
android
From kotlin.coroutines.CoroutineContext.Element
open R
<R : Any?> fold(initial: R, operation: (CoroutineContext.Element, R) -> R)
android
open operator E?
android
open CoroutineContext
android
From kotlinx.coroutines.CoroutineDispatcher
open Unit
android
final Continuation<T>
<T : Any?> interceptContinuation(continuation: Continuation<T>)
android
open Boolean
android
open CoroutineDispatcher
android
operator CoroutineDispatcher

This function is deprecated. Operator '+' on two CoroutineDispatcher objects is meaningless.

android
final Unit
android
open String
android

Public companion properties

CurrentThread

val CurrentThreadCoroutineContext

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

val MainCoroutineContext

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

Public functions

dispatch

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

Public properties

choreographer

val choreographerChoreographer

frameClock

val frameClockMonotonicFrameClock

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