runtime-core/io.matthewnelson.kmp.tor.runtime.core.config.builder/BuilderScopePort

BuilderScopePort

abstract class BuilderScopePort : TorSetting.BuilderScope(source)

A DSL builder scope for configuring TorOption containing the attribute(s) TorOption.Attribute.UNIX_SOCKET and/or TorOption.Attribute.PORT.

Inheritors

Types

Companion

object Companion

Control

class Control : BuilderScopePort

A DSL builder scope for TorOption.__ControlPort and TorOption.ControlPort. Because kmp-tor is built entirely around tor's control connection APIs, disable is made unavailable and the argument is always initialized with a value of auto.

DNS

class DNS : BuilderScopePort

A DSL builder scope for TorOption.__DNSPort and TorOption.DNSPort.

FlagsBuilderIsolation

class FlagsBuilderIsolation

Configure the desired TorOption with Isolation Flags, as described in tor-man#SocksPort.

FlagsBuilderSocks

class FlagsBuilderSocks

Configure the desired TorOption with Socks Flags, as described in tor-man#OtherSocksPortFlags.

FlagsBuilderUnix

class FlagsBuilderUnix

Configure the desired TorOption with Unix Flags, as described in tor-man#OtherSocksPortFlags and tor-man#ControlPort.

HTTPTunnel

class HTTPTunnel : BuilderScopePort

A DSL builder scope for TorOption.__HTTPTunnelPort and TorOption.HTTPTunnelPort.

Socks

class Socks : BuilderScopePort

A DSL builder scope for TorOption.__SocksPort and TorOption.SocksPort.

Trans

class Trans : BuilderScopePort

A DSL builder scope for TorOption.__TransPort and TorOption.TransPort.

Properties

argument

@JvmField

protected var argument: String

The argument string for this BuilderScope, the result of which is used as the LineItem.argument. Is initialized with whatever TorOption.default is.

option

@JvmField

val option: TorOption

The TorOption being configured for this BuilderScope.

Functions

auto

protected open fun auto(): BuilderScopePort

Sets the argument to auto, indicating that tor should pick a port value for this TorOption.

disable

protected open fun disable(): BuilderScopePort

Sets the argument to 0, indicating that tor will not utilize this TorOption.

flagsIsolation

protected open fun flagsIsolation(block: ThisBlock<BuilderScopePort.FlagsBuilderIsolation>): BuilderScopePort

Adds isolation flags to the TorSetting.LineItem.optionals of this builder result.

flagsSocks

protected open fun flagsSocks(block: ThisBlock<BuilderScopePort.FlagsBuilderSocks>): BuilderScopePort

Adds socks flags to the TorSetting.LineItem.optionals of this builder result.

flagsUnix

protected open fun flagsUnix(block: ThisBlock<BuilderScopePort.FlagsBuilderUnix>): BuilderScopePort

Adds unix flags to the TorSetting.LineItem.optionals of this builder result.

port

protected open fun port(value: Port.Ephemeral): BuilderScopePort

Sets the argument to the specified port.

reassignable

protected open fun reassignable(allow: Boolean): BuilderScopePort

In the event a configured Port is unavailable on the host device, tor will fail to start.

unixSocket

protected open fun unixSocket(value: File): BuilderScopePort

For a TorOption which can be configured to use Unix Sockets, containing the attribute TorOption.Attribute.UNIX_SOCKET.