runtime/io.matthewnelson.kmp.tor.runtime/Action/Processor/enqueue

enqueue

expect abstract fun enqueue(action: Action, onFailure: OnFailure, onSuccess: OnSuccess<Unit>): EnqueuedJob(source)

Enqueues the Action for execution.

NOTE: If the returned EnqueuedJob gets cancelled, onFailure will be invoked with CancellationException indicating normal behavior.

NOTE: If the returned EnqueuedJob gets interrupted, onFailure will be invoked with InterruptedException. For example, if StartDaemon is enqueued and immediately after, StopDaemon is enqueued too. StopDaemon will be at the top of the stack by the time the processor starts. The StopDaemon job will be executed, and all StartDaemon or RestartDaemon jobs beneath will be interrupted. If there are multiple StopDaemon jobs also enqueued, those jobs will be attached as children to the executing StopDaemon job and complete successfully alongside the job being executed. The converse scenario where StartDaemon or RestartDaemon is being executed, is the same whereby StopDaemon jobs are all interrupted, and StartDaemon or RestartDaemon jobs are attached as children, completing alongside the job that is executing.

Return

EnqueuedJob

See also

io.matthewnelson.kmp.tor.runtime.Action.Companion.executeSync
actual abstract fun enqueue(action: Action, onFailure: OnFailure, onSuccess: OnSuccess<Unit>): EnqueuedJob(source)

Enqueues the Action for execution.

NOTE: If the returned EnqueuedJob gets cancelled, onFailure will be invoked with CancellationException indicating normal behavior.

NOTE: If the returned EnqueuedJob gets interrupted, onFailure will be invoked with InterruptedException. For example, if StartDaemon is enqueued and immediately after, StopDaemon is enqueued too. StopDaemon will be at the top of the stack by the time the processor starts. The StopDaemon job will be executed, and all StartDaemon or RestartDaemon jobs beneath will be interrupted. If there are multiple StopDaemon jobs also enqueued, those jobs will be attached as children to the executing StopDaemon job and complete successfully alongside the job being executed. The converse scenario where StartDaemon or RestartDaemon is being executed, is the same whereby StopDaemon jobs are all interrupted, and StartDaemon or RestartDaemon jobs are attached as children, completing alongside the job that is executing.

Return

EnqueuedJob

See also

io.matthewnelson.kmp.tor.runtime.Action.Companion.executeSync
actual abstract fun enqueue(action: Action, onFailure: OnFailure, onSuccess: OnSuccess<Unit>): EnqueuedJob(source)

Enqueues the Action for execution.

NOTE: If the returned EnqueuedJob gets cancelled, onFailure will be invoked with CancellationException indicating normal behavior.

NOTE: If the returned EnqueuedJob gets interrupted, onFailure will be invoked with InterruptedException. For example, if StartDaemon is enqueued and immediately after, StopDaemon is enqueued too. StopDaemon will be at the top of the stack by the time the processor starts. The StopDaemon job will be executed, and all StartDaemon or RestartDaemon jobs beneath will be interrupted. If there are multiple StopDaemon jobs also enqueued, those jobs will be attached as children to the executing StopDaemon job and complete successfully alongside the job being executed. The converse scenario where StartDaemon or RestartDaemon is being executed, is the same whereby StopDaemon jobs are all interrupted, and StartDaemon or RestartDaemon jobs are attached as children, completing alongside the job that is executing.

Return

EnqueuedJob

See also