edgeport - v1.0.3
    Preparing search index...

    Interface StompConnectOptions

    Options for connect.

    1.0.0

    interface StompConnectOptions {
        heartBeat?: [number, number];
        host?: string;
        hostname: string;
        login?: string;
        passcode?: string;
        port?: number;
        timeoutMs?: number;
        tls?: "off" | "starttls" | "implicit";
    }
    Index
    heartBeat? host? hostname login? passcode? port? timeoutMs? tls?
    heartBeat?: [number, number]

    Heart-beat as [cx, cy] milliseconds; defaults to [0, 0] (disabled).

    host?: string

    Virtual host sent in the host header; defaults to hostname.

    hostname: string

    Remote STOMP host (also used for TLS certificate validation).

    login?: string

    Login name sent in the login header when provided.

    passcode?: string

    Passcode sent in the passcode header when provided.

    port?: number

    Remote port; defaults to 61613.

    timeoutMs?: number

    Read deadline in milliseconds for the connect handshake.

    tls?: "off" | "starttls" | "implicit"

    Transport security:

    • 'off' (default): plaintext.
    • 'implicit': TLS from the first byte.
    • 'starttls': dial plaintext, then upgrade to TLS before the CONNECT frame.

    Settings
    Member Visibility

    On This Page
    Properties