runtime/io.matthewnelson.kmp.tor.runtime/Lifecycle/DestroyableTorRuntime

DestroyableTorRuntime

class DestroyableTorRuntime : TorRuntime, Destroyable(source)

A wrapper around the TorRuntime implementation which adds the ability to destroy the instance. Is only available if using the TorRuntime.ServiceFactory API.

NOTE: Any observers subscribed to this instance will use OnEvent.Executor.Immediate as their default, and not what was defined for TorRuntime.Environment.BuilderScope.defaultEventExecutor. If this is undesirable, define an OnEvent.Executor for your service implementation's observer(s) individually.

Properties

fid

open override val fid: String

An ID string which is based off of a file path.

fidEllipses

@get:JvmStatic

@get:JvmName(name = "fidEllipses")

val FileID.fidEllipses: String

Returns the first and last 4 characters of the fid concatenated together with an ellipses between.

Functions

clearObservers

open override fun clearObservers()

destroy

open override fun destroy()

enqueue

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

Enqueues the Action for execution.

open override fun <Success : Any> enqueue(cmd: TorCmd.Unprivileged<Success>, onFailure: OnFailure, onSuccess: OnSuccess<Success>): EnqueuedJob

environment

open override fun environment(): TorRuntime.Environment

Returns the current Environment for this TorRuntime instance.

invokeOnDestroy

fun invokeOnDestroy(handle: ItBlock<Any?>): Disposable

Attaches a callback handle to the lifecycle which will be invoked when destroy is called.

isDestroyed

open override fun isDestroyed(): Boolean

isReady

open override fun isReady(): Boolean

Checks if the tor process backing TorRuntime (if it is running) has completed starting up.

listeners

open override fun listeners(): TorListeners

Returns the current TorListeners of this TorRuntime instance.

observeSignalNewNym

@JvmStatic

fun RuntimeEvent.Processor.observeSignalNewNym(tag: String?, executor: OnEvent.Executor?, onEvent: OnEvent<String?>): Disposable.Once

Subscribes with provided TorRuntime a CMD observer which will intercept execution of all TorCmd.Signal.NewNym jobs in order to transform tor's generic server response of Reply.Success.OK.

state

open override fun state(): TorState

Returns the current TorState of this TorRuntime instance.

open override fun subscribe(observer: RuntimeEvent.Observer<*>)

Add a single Observer.

open override fun subscribe(vararg observers: RuntimeEvent.Observer<*>)

Add multiple Observer.

open override fun subscribe(observer: TorEvent.Observer)

open override fun subscribe(vararg observers: TorEvent.Observer)

toFIDString

@JvmStatic

@JvmOverloads

@JvmName(name = "fidString")

fun FileID.toFIDString(defaultClassName: String = "Unknown", includeHashCode: Boolean = true): String

Helper for overriding a class's toString function.

unsubscribe

open override fun unsubscribe(observer: RuntimeEvent.Observer<*>)

Remove a single Observer.

open override fun unsubscribe(vararg observers: RuntimeEvent.Observer<*>)

Remove multiple Observer.

open override fun unsubscribe(observer: TorEvent.Observer)

open override fun unsubscribe(vararg observers: TorEvent.Observer)

unsubscribeAll

open override fun unsubscribeAll(event: RuntimeEvent<*>)

Remove all Observer of a single RuntimeEvent.

open override fun unsubscribeAll(vararg events: RuntimeEvent<*>)

Remove all Observer of multiple RuntimeEvent.

open override fun unsubscribeAll(event: TorEvent)

open override fun unsubscribeAll(vararg events: TorEvent)

open override fun unsubscribeAll(tag: String)