kaven-utils - v6.1.9
    Preparing search index...

    Interface IRelayProxyOriginOptions

    Options for the originator side of StartRelayProxyCore. The local listener accepts TCP connections and tunnels each one through the relay server to the target relay client.

    interface IRelayProxyOriginOptions {
        host?: string;
        logger?: ILoggingAgent;
        port?: number;
        proxyTypes?: RelayProxyType[];
        relayServer?: IHostPort;
        targetIdList?: string[];
        tcpHolePunch?: boolean;
        tcpHolePunchTimeout?: number;
        tls?: ConnectionOptions;
    }

    Hierarchy

    • IHostPort
    • ILoggable
      • IRelayProxyOriginOptions
    Index
    host? logger? port? proxyTypes? relayServer? targetIdList? tcpHolePunch? tcpHolePunchTimeout? tls?
    host?: string
    logger?: ILoggingAgent
    port?: number
    proxyTypes?: RelayProxyType[]

    Proxy protocols accepted by the origin listener. The protocol is detected independently for every incoming connection.

    relayServer?: IHostPort

    Address of the relay server to connect to. When omitted and a local relay server is started by the same call, the origin connects to the server's actually bound address.

    targetIdList?: string[]

    Names of the target clients this origin may tunnel to. The origin waits for a peer that advertised (via identify) one of these names and binds to it. When empty/omitted, the origin binds to the first peer that joins (or the same-process target).

    tcpHolePunch?: boolean

    Try a direct TCP transport to the selected target before listening.

    tcpHolePunchTimeout?: number

    Maximum direct transport setup time in milliseconds.

    tls?: ConnectionOptions

    TLS options for connecting to the relay server. When set, the origin connects over TLS.

    Settings
    Member Visibility

    On This Page
    Properties