kotlinx.coroutines

Class NonCancellable

kotlinx.coroutines.NonCancellable

All Implemented Interfaces:

Job

public class NonCancellable
implements Job

A non-cancelable job that is always Job.isActive. It is designed for BuildersKt.withContext function to prevent cancellation of code blocks that need to be executed without cancellation.

Use it like this:

withContext(NonCancellable) {
    // this code will not be cancelled
}

See Also:

Job.isActive, BuildersKt.withContext

Nested Class Summary

Nested classes/interfaces inherited from interface kotlinx.coroutines.Job

Job.DefaultImpls, Job.Key

Field Summary

Fields

Modifier and Type	Field and Description
static NonCancellable	INSTANCE A non-cancelable job that is always Job.isActive. It is designed for BuildersKt.withContext function to prevent cancellation of code blocks that need to be executed without cancellation.

Fields inherited from interface kotlinx.coroutines.Job

Key

Method Summary

Methods inherited from interface kotlinx.coroutines.Job

cancel, getChildren, getOnJoin, invokeOnCompletion, isActive, isCancelled, isCompleted, join, start

Field Detail

INSTANCE

public static NonCancellable INSTANCE

A non-cancelable job that is always Job.isActive. It is designed for BuildersKt.withContext function to prevent cancellation of code blocks that need to be executed without cancellation.

Use it like this:

withContext(NonCancellable) {
    // this code will not be cancelled
}

See Also:

Job.isActive, BuildersKt.withContext