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

    Interface IRelayProxyInstance

    Result returned by StartRelayProxyCore / StartRelayProxy.

    interface IRelayProxyInstance {
        cert?: GeneratedCertificateFiles;
        origins: {
            address: { host: string; port: number };
            client: RelayClient;
            tunnel: RelayTunnel;
        }[];
        server?: RelayServer;
        targets: { client: RelayClient; tunnel: RelayTunnel }[];
        Stop(): Promise<void>;
    }
    Index
    cert? origins server? targets
    Stop
    cert?: GeneratedCertificateFiles

    The generated/loaded TLS certificate set, when SERVER_TLS was enabled.

    origins: {
        address: { host: string; port: number };
        client: RelayClient;
        tunnel: RelayTunnel;
    }[]

    Started origin clients, tunnels, and bound listener addresses in the same order as the enabled listener entries in CLIENTS.

    server?: RelayServer

    The relay server, if one was started by this call.

    targets: { client: RelayClient; tunnel: RelayTunnel }[]

    Started target clients and tunnels in the same order as the enabled dialer entries in CLIENTS.

    • Stop every component started by this call.

      Returns Promise<void>

    Settings
    Member Visibility

    On This Page
    Properties
    Methods