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

Trans

class Trans : BuilderScopePort(source)

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

NOTE: This builder scope is only available for unix-like hosts. UnsupportedOperationException may be thrown when attempting to instantiate it.

Properties

Link copied to clipboard
@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.

Link copied to clipboard
@JvmField
val option: TorOption

The TorOption being configured for this BuilderScope.

Functions

Link copied to clipboard
open override fun auto(): BuilderScopePort.Trans

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

Link copied to clipboard
open override fun disable(): BuilderScopePort.Trans

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

Link copied to clipboard
open override fun flagsIsolation(block: ThisBlock<BuilderScopePort.FlagsBuilderIsolation>): BuilderScopePort.Trans

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

Link copied to clipboard
protected open fun flagsSocks(block: ThisBlock<BuilderScopePort.FlagsBuilderSocks>): BuilderScopePort

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

Link copied to clipboard
protected open fun flagsUnix(block: ThisBlock<BuilderScopePort.FlagsBuilderUnix>): BuilderScopePort

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

Link copied to clipboard
open override fun port(value: Port.Ephemeral): BuilderScopePort.Trans

Sets the argument to the specified port.

Link copied to clipboard
open override fun reassignable(allow: Boolean): BuilderScopePort.Trans

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

Link copied to clipboard
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.