runtime/io.matthewnelson.kmp.tor.runtime/TorCmdJob

TorCmdJob

A wrapper around the jobs returned by TorCmd.Unprivileged.Processor and TorCmd.Privileged.Processor to inform observers that they are being executed.

The job is non-cancellable, created just prior to when the actual TorCmd contents are to be written to the control connection.

This is useful for seeing what is happening and, if needed, attaching invokeOnCompletion handlers for reactionary purposes.

Parameters

cmd

The TorCmd class being executed.

Properties

cmd

@JvmField

val cmd: KClass<out TorCmd<*>>

executionPolicy

open val executionPolicy: EnqueuedJob.ExecutionPolicy

isActive

@get:JvmName(name = "isActive")

val isActive: Boolean

isCancelled

@get:JvmName(name = "isCancelled")

val isCancelled: Boolean

isCompleting

@get:JvmName(name = "isCompleting")

val isCompleting: Boolean

isError

@get:JvmName(name = "isError")

val isError: Boolean

isSuccess

@get:JvmName(name = "isSuccess")

val isSuccess: Boolean

name

@JvmField

val name: String

state

@get:JvmName(name = "state")

val state: EnqueuedJob.State

Functions

cancel

fun cancel(cause: CancellationException?): Boolean

cancellationAttempt

protected fun cancellationAttempt(): CancellationException?

invokeOnCompletion

fun invokeOnCompletion(handle: ItBlock<CancellationException?>): Disposable

onCancellation

protected open fun onCancellation(cause: CancellationException?)

onCompletion

protected fun <T> onCompletion(response: T, withLock: () -> OnSuccess<T>??): Boolean

onError

protected fun onError(cause: Throwable, withLock: ItBlock<Throwable>?): Boolean

onExecuting

protected fun onExecuting()

toString

override fun toString(): String

TorCmdJob

Parameters

See also

Properties

Functions