runtime-core/io.matthewnelson.kmp.tor.runtime.core/TorEvent

TorEvent

sealed class TorEvent : Event<String, TorEvent, TorEvent.Observer>

e.g.

val circObserver = TorEvent.CIRC.observer { data ->
    println(data)
}

Inheritors

Types

ADDRMAP

data object ADDRMAP : TorEvent

New Address Mapping

BUILDTIMEOUT_SET

data object BUILDTIMEOUT_SET : TorEvent

New Circuit Build Time Has Been Set

data object BW : TorEvent

Bandwidth Used In The Last Second

CELL_STATS

data object CELL_STATS : TorEvent

Per-circuit Cell Stats

CIRC

data object CIRC : TorEvent

Circuit Status Changed

CIRC_BW

data object CIRC_BW : TorEvent

Bandwidth Used By All Streams Attached To A Circuit

CIRC_MINOR

data object CIRC_MINOR : TorEvent

Circuit Status Changed Slightly

CLIENTS_SEEN

data object CLIENTS_SEEN : TorEvent

Per-country Client Stats

Companion

object Companion : Event.Entries<TorEvent>

CONF_CHANGED

data object CONF_CHANGED : TorEvent

Configuration Changed

CONN_BW

data object CONN_BW : TorEvent

Bandwidth Used On An OR Dir Or Exit Connection

DEBUG

data object DEBUG : TorEvent

Log Messages

DESCCHANGED

data object DESCCHANGED : TorEvent

Our Descriptor Changed

ERR

data object ERR : TorEvent

Log Messages

GUARD

data object GUARD : TorEvent

Our Set Of Guard Nodes Changed

HS_DESC

data object HS_DESC : TorEvent

HiddenService Descriptors

HS_DESC_CONTENT

data object HS_DESC_CONTENT : TorEvent

HiddenService Descriptors Content

INFO

data object INFO : TorEvent

Log Messages

NETWORK_LIVENESS

data object NETWORK_LIVENESS : TorEvent

Network Liveness Changed

NEWCONSENSUS

data object NEWCONSENSUS : TorEvent

New Consensus Network Status Arrived

NEWDESC

data object NEWDESC : TorEvent

New Descriptors Available

NOTICE

data object NOTICE : TorEvent

Log Messages

data object NS : TorEvent

Network Status Changed

Observer

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

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

ORCONN

data object ORCONN : TorEvent

OR Connection Status Changed

Processor

interface Processor

Base interface for implementations that process TorEvent.

SIGNAL

data object SIGNAL : TorEvent

Signal Received

STATUS_CLIENT

data object STATUS_CLIENT : TorEvent

Status Events

STATUS_GENERAL

data object STATUS_GENERAL : TorEvent

Status Events

STATUS_SERVER

data object STATUS_SERVER : TorEvent

Status Events

STREAM

data object STREAM : TorEvent

Stream Status Changed

STREAM_BW

data object STREAM_BW : TorEvent

Bandwidth Used On An Application Stream

TRANSPORT_LAUNCHED

data object TRANSPORT_LAUNCHED : TorEvent

Pluggable Transport Launched

WARN

data object WARN : TorEvent

Log Messages

Properties

name

@JvmField

val name: String

Functions

observer

fun observer(onEvent: OnEvent<String>): TorEvent.Observer

Creates a new observer for subscribing to its events.

fun observer(tag: String, onEvent: OnEvent<String>): TorEvent.Observer

Creates a new observer with the provided tag for subscribing to its events.

fun observer(tag: String?, executor: OnEvent.Executor?, onEvent: OnEvent<String>): TorEvent.Observer

Creates a new observer with the provided tag and executor for subscribing to its events.

TorEvent

See also

Inheritors

Types

Properties

Functions