runtime-ctrl/io.matthewnelson.kmp.tor.runtime.ctrl/TorCtrl

TorCtrl

expect interface TorCtrl : Destroyable, TorEvent.Processor, TorCmd.Privileged.Processor(source)

A Tor control connection

Issuance of TorCmd.Signal.Halt or TorCmd.Signal.Shutdown will interrupt all enqueued jobs (if any) and then automatically destroy itself when the underlying connection closes itself.

See also

actual interface TorCtrl : Destroyable, TorEvent.Processor, TorCmd.Privileged.Processor(source)

A Tor control connection

Issuance of TorCmd.Signal.Halt or TorCmd.Signal.Shutdown will interrupt all enqueued jobs (if any) and then automatically destroy itself when the underlying connection closes itself.

See also

actual interface TorCtrl : Destroyable, TorEvent.Processor, TorCmd.Privileged.Processor(source)

A Tor control connection

Issuance of TorCmd.Signal.Halt or TorCmd.Signal.Shutdown will interrupt all enqueued jobs (if any) and then automatically destroy itself when the underlying connection closes itself.

See also

Types

Link copied to clipboard
expect class Factory constructor(staticTag: String? = null, observers: Set<TorEvent.Observer> = emptySet(), interceptors: Set<TorCmdInterceptor<*>> = emptySet(), defaultExecutor: OnEvent.Executor = OnEvent.Executor.Immediate, debugger: ItBlock<String>? = null, handler: UncaughtException.Handler)

A factory class for connecting to tor via its control listener.

actual class Factory constructor(staticTag: String?, observers: Set<TorEvent.Observer>, interceptors: Set<TorCmdInterceptor<*>>, defaultExecutor: OnEvent.Executor, debugger: ItBlock<String>?, handler: UncaughtException.Handler)

A factory class for connecting to tor via its control listener.

actual class Factory @JvmOverloads constructor(staticTag: String?, observers: Set<TorEvent.Observer>, interceptors: Set<TorCmdInterceptor<*>>, defaultExecutor: OnEvent.Executor, debugger: ItBlock<String>?, handler: UncaughtException.Handler)

A factory class for connecting to tor via its control listener.

Functions

Link copied to clipboard
abstract fun clearObservers()
abstract fun clearObservers()
abstract fun clearObservers()
Link copied to clipboard
expect abstract override fun destroy()

Immediately disconnects from the control listener resulting in interruption of all EnqueuedJob, and invocation of all handles registered via invokeOnDestroy.

actual abstract override fun destroy()

Immediately disconnects from the control listener resulting in interruption of all EnqueuedJob, and invocation of all handles registered via invokeOnDestroy.

actual abstract override fun destroy()

Immediately disconnects from the control listener resulting in interruption of all EnqueuedJob, and invocation of all handles registered via invokeOnDestroy.

Link copied to clipboard
abstract fun <Success : Any> enqueue(cmd: TorCmd.Privileged<Success>, onFailure: OnFailure, onSuccess: OnSuccess<Success>): EnqueuedJob
abstract fun <Success : Any> enqueue(cmd: TorCmd.Unprivileged<Success>, onFailure: OnFailure, onSuccess: OnSuccess<Success>): EnqueuedJob
abstract fun <Success : Any> enqueue(cmd: TorCmd.Privileged<Success>, onFailure: OnFailure, onSuccess: OnSuccess<Success>): EnqueuedJob
abstract fun <Success : Any> enqueue(cmd: TorCmd.Unprivileged<Success>, onFailure: OnFailure, onSuccess: OnSuccess<Success>): EnqueuedJob
abstract fun <Success : Any> enqueue(cmd: TorCmd.Privileged<Success>, onFailure: OnFailure, onSuccess: OnSuccess<Success>): EnqueuedJob
abstract fun <Success : Any> enqueue(cmd: TorCmd.Unprivileged<Success>, onFailure: OnFailure, onSuccess: OnSuccess<Success>): EnqueuedJob
Link copied to clipboard
expect abstract fun invokeOnDestroy(handle: ItBlock<TorCtrl>): Disposable

Register a handle to be invoked when this TorCtrl instance is destroyed. If handle is already registered, Disposable.noOp is returned.

actual abstract fun invokeOnDestroy(handle: ItBlock<TorCtrl>): Disposable

Register a handle to be invoked when this TorCtrl instance is destroyed. If handle is already registered, Disposable.noOp is returned.

actual abstract fun invokeOnDestroy(handle: ItBlock<TorCtrl>): Disposable

Register a handle to be invoked when this TorCtrl instance is destroyed. If handle is already registered, Disposable.noOp is returned.

Link copied to clipboard
abstract fun isDestroyed(): Boolean
abstract fun isDestroyed(): Boolean
abstract fun isDestroyed(): Boolean
Link copied to clipboard
abstract fun subscribe(observer: TorEvent.Observer)
abstract fun subscribe(vararg observers: TorEvent.Observer)
abstract fun subscribe(observer: TorEvent.Observer)
abstract fun subscribe(vararg observers: TorEvent.Observer)
abstract fun subscribe(observer: TorEvent.Observer)
abstract fun subscribe(vararg observers: TorEvent.Observer)
Link copied to clipboard
abstract fun unsubscribe(observer: TorEvent.Observer)
abstract fun unsubscribe(vararg observers: TorEvent.Observer)
abstract fun unsubscribe(observer: TorEvent.Observer)
abstract fun unsubscribe(vararg observers: TorEvent.Observer)
abstract fun unsubscribe(observer: TorEvent.Observer)
abstract fun unsubscribe(vararg observers: TorEvent.Observer)
Link copied to clipboard
abstract fun unsubscribeAll(event: TorEvent)
abstract fun unsubscribeAll(vararg events: TorEvent)
abstract fun unsubscribeAll(tag: String)
abstract fun unsubscribeAll(event: TorEvent)
abstract fun unsubscribeAll(vararg events: TorEvent)
abstract fun unsubscribeAll(tag: String)
abstract fun unsubscribeAll(event: TorEvent)
abstract fun unsubscribeAll(vararg events: TorEvent)
abstract fun unsubscribeAll(tag: String)