runtime/io.matthewnelson.kmp.tor.runtime/RuntimeEvent

RuntimeEvent

sealed class RuntimeEvent<Data : Any> : Event<Data, RuntimeEvent<Data>, RuntimeEvent.Observer<Data>> (source)

Events specific to TorRuntime

e.g.

val runtime = TorRuntime.Builder(myEnvironment) {
    observerStatic(ERROR) { t ->
        t.printStackTrace()
    }
    observerStatic(EXECUTE.ACTION) { job ->
        println(job)
    }
    // ...
}

val observerState = STATE.observer(
    tag = "1234",
    executor = OnEvent.Executor.Main,
    onEvent = { state -> println(state) },
)
runtime.subscribe(observerState)
runtime.unsubscribe(observerState)

Inheritors

Types

Companion

object Companion : Event.Entries<RuntimeEvent<*>>

ERROR

data object ERROR : RuntimeEvent<Throwable>

Errors encountered by TorRuntime.

EXECUTE

data object EXECUTE

LIFECYCLE

data object LIFECYCLE : RuntimeEvent<Lifecycle.Event>

Events pertaining to an object's lifecycle.

LISTENERS

data object LISTENERS : RuntimeEvent<TorListeners>

Events pertaining to listeners which tor has opened.

LOG

sealed class LOG : RuntimeEvent<String>

Logging for TorRuntime internals.

Notifier

interface Notifier

Helper for selectively exposing the ability to notify observers externally of the TorRuntime implementation.

Observer

open class Observer<Data : Any>(event: RuntimeEvent<Data>, tag: String?, executor: OnEvent.Executor?, onEvent: OnEvent<Data>) : Event.Observer<Data, RuntimeEvent<Data>>

Model to be registered with a Processor for being notified via OnEvent invocation with RuntimeEvent data.

Processor

interface Processor : TorEvent.Processor

Base interface for implementations that process RuntimeEvent.

READY

data object READY : RuntimeEvent<String>

Indicates that tor has completed bootstrapping and the network is enabled. All READY observers will be notified a single time per runtime startup completion. If the currently running tor instance is stopped via Action.StopDaemon or Action.RestartDaemon, READY observers will be notified again in the same manner when the next start completion occurs.

STATE

data object STATE : RuntimeEvent<TorState>

Events pertaining to the current state of TorRuntime.