Package kotlinx.coroutines.experimental

General-purpose coroutine builders, contexts, and helper functions.

See: Description

Interface Summary

Interface	Description
BlockingChecker	Extension point which determines whether invoking BuildersKt.runBlocking in the current thread is allowed. BuildersKt.runBlocking discovers all checkers via ServiceLoader and invokes BlockingChecker.checkRunBlocking on each attempt to invoke BuildersKt.runBlocking.
CancellableContinuation<T>	Cancellable continuation. It is completed when it is resumed or cancelled. When CancellableContinuation.cancel function is explicitly invoked, this continuation immediately resumes with CancellationException or with the specified cancel cause.
CompletableDeferred<T>	A interface Deferred that can be completed via public functions CompletableDeferred.complete, CompletableDeferred.completeExceptionally, and cancel.
CoroutineExceptionHandler	An optional element on the coroutine context to handle uncaught exceptions.
CoroutineScope	Receiver interface for generic coroutine builders, so that the code inside coroutine has a convenient and fast access to its own cancellation status via CoroutineScope.isActive.
Deferred<T>	Deferred value is a non-blocking cancellable future.
Delay	This dispatcher feature is implemented by class CoroutineDispatcher implementations that natively support scheduled execution of tasks.
DisposableHandle	A handle to an allocated object that can be disposed to make it eligible for garbage collection.
EventLoop	Implemented by class CoroutineDispatcher implementations that have event loop inside and can be asked to process next event from their event queue.
Job	A background job. Conceptually, a job is a cancellable thing with a simple life-cycle that culminates in its completion. Jobs can be arranged into parent-child hierarchies where cancellation or completion of parent immediately cancels all its Job.getChildren.

Class Summary

Class	Description
AbstractContinuationKt
AbstractCoroutine<T>	Abstract base class for implementation of coroutines in coroutine builders.
AwaitKt
BuildersKt
CancellableContinuationKt
CloseableCoroutineDispatcher	class CoroutineDispatcher that implements Closeable
CommonPool	Represents common pool of shared threads as coroutine dispatcher for compute-intensive tasks.
CompletableDeferredKt
CompletionHandlerKt
CompletionHandler_commonKt
CoroutineContextKt
CoroutineDispatcher	Base class that shall be extended by all coroutine dispatcher implementations.
CoroutineExceptionHandlerImplKt
CoroutineExceptionHandlerKt
CoroutineName	User-specified name of coroutine. This name is used in debugging mode. See newCoroutineContext for the description of coroutine debugging facilities.
DebugKt
DefaultExecutorKt
DeferredKt
DelayKt
DispatchedKt
EventLoopKt
ExceptionsKt
ExecutorsKt
JobKt
JobSupportKt
LazyDeferredKt
NonCancellable	A non-cancelable job that is always NonCancellable.isActive. It is designed for BuildersKt.withContext function to prevent cancellation of code blocks that need to be executed without cancellation.
NonDisposableHandle	No-op implementation of interface DisposableHandle.
ResumeModeKt
RunnableKt
ScheduledKt
ThreadPoolDispatcher	Dispatches coroutine execution to a thread pool of a fixed size. Instances of this dispatcher are created with ThreadPoolDispatcherKt.newSingleThreadContext and ThreadPoolDispatcherKt.newFixedThreadPoolContext.
ThreadPoolDispatcherKt
TimeSourceKt
Unconfined	A coroutine dispatcher that is not confined to any specific thread. It executes initial continuation of the coroutine right here in the current call-frame and let the coroutine resume in whatever thread that is used by the corresponding suspending function, without mandating any specific threading policy.
YieldKt

Enum Summary

Enum	Description
CoroutineStart	Defines start options for coroutines builders. It is used in start parameter of BuildersKt.launch, DeferredKt.async, and other coroutine builder functions.

Exception Summary

Exception	Description
CompletionHandlerException	This exception gets thrown if an exception is caught while processing CompletionHandler invocation for interface Job.
JobCancellationException	Thrown by cancellable suspending functions if the interface Job of the coroutine is cancelled or completed without cause, or with a cause or exception that is not CancellationException (see Job.getCancellationException).
TimeoutCancellationException	This exception is thrown by ScheduledKt.withTimeout to indicate timeout.

Package kotlinx.coroutines.experimental Description

General-purpose coroutine builders, contexts, and helper functions.