runtime-core/io.matthewnelson.kmp.tor.runtime.core/EnqueuedJob/ExecutionPolicy/Cancellation

Cancellation

class Cancellation(source)

How the job handles cancellation while in a state of Executing

See also

Types

Link copied to clipboard
class BuilderScope
Link copied to clipboard
object Companion

Properties

Link copied to clipboard
@JvmField
val accessibilityOpen: Boolean

If true, allows the public cancel function the ability to set cancellationAttempt while the job is in a state of Executing (i.e. anyone with access to the EnqueuedJob instance may signal for cancellation).

Link copied to clipboard
@JvmField
val allowAttempts: Boolean

If true, cancellationAttempt may be set while the job is in a state of Executing in order to signal that cancellation is desired.

Link copied to clipboard
@get:JvmName(name = "isDefault")
val isDefault: Boolean

If this ExecutionPolicy.Cancellation configuration is equal to Cancellation.DEFAULT

Link copied to clipboard
@JvmField
val substituteErrorWithAttempt: Boolean

If true, calls to onError will have their cause replaced with cancellationAttempt if it is set.