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

Socks

class Socks : BuilderScopePort

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

Properties

val option: TorOption

The TorOption being configured for this BuilderScope.

Functions

open override fun auto(): BuilderScopePort.Socks

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

open override fun disable(): BuilderScopePort.Socks

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

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

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

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

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

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

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

open override fun port(value: Port.Ephemeral): BuilderScopePort.Socks

Sets the argument to the specified port.

open override fun reassignable(allow: Boolean): BuilderScopePort.Socks

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

open override fun unixSocket(value: File): BuilderScopePort.Socks

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