edgeport - v1.0.3
    Preparing search index...

    Interface ConnectOptions

    Fields needed to build a CONNECT packet.

    interface ConnectOptions {
        cleanSession: boolean;
        clientId: string;
        keepAliveSeconds: number;
        password?: string | Uint8Array<ArrayBufferLike>;
        username?: string;
        will?: {
            payload: string | Uint8Array<ArrayBufferLike>;
            qos?: 0 | 1 | 2;
            retain?: boolean;
            topic: string;
        };
    }
    Index
    cleanSession clientId keepAliveSeconds password? username? will?
    cleanSession: boolean

    Whether the broker should discard any prior session state for this client.

    clientId: string

    Client identifier; may be empty when the broker assigns one (requires cleanSession).

    keepAliveSeconds: number

    Keep-alive interval in seconds advertised to the broker (0 disables it).

    password?: string | Uint8Array<ArrayBufferLike>

    Optional password; encoded as bytes (a string is treated as UTF-8).

    username?: string

    Optional username for credential auth.

    will?: {
        payload: string | Uint8Array<ArrayBufferLike>;
        qos?: 0 | 1 | 2;
        retain?: boolean;
        topic: string;
    }

    Optional Last Will and Testament the broker publishes if the client drops ungracefully.

    Settings
    Member Visibility

    On This Page
    Properties