Instance Property

socksEndpoint

Tor’s local SOCKS5 proxy endpoint once start succeeds, else nil.

var socksEndpoint: HostPort? { get }

Mentioned In

Getting Started with swift-tor

Discussion

Populated by discoverSocksPort() via the GETINFO net/listeners/socks control-protocol key (control-spec.txt §3.9). Remains nil until Tor reaches TorState.running AND the port discovery completes; reverts to nil on stop().

Typical value: HostPort(host: "127.0.0.1", port: <ephemeral>) when configuration.socksPort == .ephemeral, or the literal fixed port when .fixed(n) was requested.

Important

Do not hand this endpoint to client code before waitUntilBootstrapped(timeout:) succeeds — the SOCKS listener is reachable immediately, but traffic will fail with Proxy connection refused until bootstrap reaches 100%.