runtime/io.matthewnelson.kmp.tor.runtime/TorRuntime/BuilderScope

BuilderScope

class BuilderScope(source)

Properties

Link copied to clipboard
@JvmField
var networkObserver: NetworkObserver

Configure a NetworkObserver for this TorRuntime instance.

Functions

Link copied to clipboard
fun config(block: ConfigCallback): TorRuntime.BuilderScope

Apply settings to the TorConfig at each startup. Multiple block may be set, each of which will be applied to the TorConfig.Builder before starting tor.

Link copied to clipboard
fun <R : Any> observer(observer: RuntimeEvent.Observer<R>): TorRuntime.BuilderScope

Add RuntimeEvent.Observer which is non-static (can be removed at any time).

fun observer(observer: TorEvent.Observer): TorRuntime.BuilderScope

Add TorEvent.Observer which is non-static (can be removed at any time).

Link copied to clipboard
fun <R : Any> observerStatic(event: RuntimeEvent<R>, onEvent: OnEvent<R>): TorRuntime.BuilderScope
fun <R : Any> observerStatic(event: RuntimeEvent<R>, executor: OnEvent.Executor?, onEvent: OnEvent<R>): TorRuntime.BuilderScope

Add RuntimeEvent.Observer which will never be removed from TorRuntime.

fun observerStatic(event: TorEvent, onEvent: OnEvent<String>): TorRuntime.BuilderScope
fun observerStatic(event: TorEvent, executor: OnEvent.Executor?, onEvent: OnEvent<String>): TorRuntime.BuilderScope

Add TorEvent.Observer which will never be removed from TorRuntime.

Link copied to clipboard
fun required(event: TorEvent): TorRuntime.BuilderScope

Add TorEvent that are required for your implementation. All configured TorEvent will be set at startup when the control connection is established via TorCmd.SetEvents.