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

    Interface IRelayProxyTargetOptions

    Options for the dialer side of StartRelayProxyCore. A fixed target is used for raw forwarding; an HTTP proxy supplies the destination with each connection.

    interface IRelayProxyTargetOptions {
        logger?: ILoggingAgent;
        name?: string;
        relayServer?: IHostPort;
        target?: IHostPort;
        tcpHolePunch?: boolean;
        tcpHolePunchTimeout?: number;
        tls?: ConnectionOptions;
    }

    Hierarchy

    • ILoggable
      • IRelayProxyTargetOptions
    Index
    logger? name? relayServer? target? tcpHolePunch? tcpHolePunchTimeout? tls?
    logger?: ILoggingAgent
    name?: string

    A name this target advertises via identify, so origins with a matching IRelayProxyOriginOptions.targetIdList can select it. When omitted the target is anonymous and only reachable by the "first peer" fallback.

    relayServer?: IHostPort

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

    target?: IHostPort

    Fixed destination for raw forwarding. Omit it when the proxy origin supplies a destination with every request.

    tcpHolePunch?: boolean

    Allow direct TCP transport attempts initiated by selected listeners.

    tcpHolePunchTimeout?: number

    Maximum direct transport setup time in milliseconds.

    tls?: ConnectionOptions

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

    Settings
    Member Visibility

    On This Page
    Properties