runtime-core/io.matthewnelson.kmp.tor.runtime.core.ctrl/TorCmd

TorCmd

sealed class TorCmd<Success : Any> : EnqueuedJob.Argument(source)

Commands to interact with tor via its control connection, as described in control-spec.

Commands are separated into 2 categories, Privileged and Unprivileged. This is unique to kmp-tor only, not tor. The purpose is to allow abstractions to be built on top of a control connection implementation (such as kmp-tor:runtime) that manage the connection and allow for pass-through of Unprivileged commands while internally using Privileged commands to set up and maintain the connection.

Inheritors

Privileged

Unprivileged

Types

Authenticate

class Authenticate : TorCmd.Privileged<Reply.Success.OK>

control-spec#AUTHENTICATE

Config

data object Config

DropGuards

data object DropGuards : TorCmd.Unprivileged<Reply.Success.OK>

control-spec#DROPGUARDS

data object Hs

Info

data object Info

MapAddress

class MapAddress : TorCmd.Unprivileged<Set<AddressMapping.Result>>

control-spec#MAPADDRESS

Onion

data object Onion

OnionClientAuth

data object OnionClientAuth

Ownership

data object Ownership

Privileged

sealed class Privileged<Success : Any>(keyword: String) : TorCmd<Success>

A TorCmd whose use is restricted to only that of the control connection, and not with TorRuntime.

Resolve

class Resolve : TorCmd.Unprivileged<Reply.Success.OK>

control-spec#RESOLVE

SetEvents

class SetEvents : TorCmd.Unprivileged<Reply.Success.OK>

control-spec#SETEVENTS

Signal

data object Signal

control-spec#SIGNAL

Unprivileged

sealed class Unprivileged<Success : Any>(keyword: String) : TorCmd<Success>

A TorCmd that is capable of being utilized with both the control connection and TorRuntime (which passes it through to the underlying control connection).

Properties

keyword

@JvmField

val keyword: String

TorCmd

See also

Inheritors

Types

Properties