xmpp-httpx - v0.11.0
    Preparing search index...

    Interface Socks5AdapterOptions

    Node-only XEP-0065 (SOCKS5 Bytestreams) transport, used as an optional stream-method by sipub (see src/sipub/sipub.ts) alongside IBB. Raw TCP sockets mean this can never run in a browser — that's why it lives under the ./node subpath export rather than the universal entry point.

    Supports two candidate sources, either or both:

    • an external SOCKS5 proxy component (needed for NAT traversal)
    • ourselves as a direct streamhost via a local TCP listener
    interface Socks5AdapterOptions {
        connectTimeoutMs?: number;
        listen?: { host: string; port: number };
        proxyHost?: string;
        proxyJid?: string;
        proxyPort?: number;
    }
    Index
    connectTimeoutMs?: number
    listen?: { host: string; port: number }

    Offer ourselves as a direct streamhost candidate on this address.

    proxyHost?: string

    Skip the proxy address discovery IQ and use this host/port directly.

    proxyJid?: string

    JID of an external XEP-0065 proxy component (e.g. proxy.example.org).

    proxyPort?: number