Type Alias ConnectPacket

CONNECT packet - Client requests connection to server.

See

MQTT 5.0 §3.1

type ConnectPacket = {
    cleanStart: boolean;
    clientId: string;
    keepAlive: number;
    password?: Uint8Array;
    properties?: ConnectProperties;
    protocolVersion: ProtocolVersion;
    type: typeof CONNECT;
    username?: string;
    will?: WillMessage;
}

Index

Properties

cleanStart clientId keepAlive password? properties? protocolVersion type username? will?

Properties

`Readonly`cleanStart

cleanStart: boolean

Clean start / clean session

`Readonly`clientId

clientId: string

Client identifier

`Readonly`keepAlive

keepAlive: number

Keep alive interval (seconds)

`Optional` `Readonly`password

password?: Uint8Array

Password (optional)

`Optional` `Readonly`properties

properties?: ConnectProperties

CONNECT properties (5.0)

`Readonly`protocolVersion

protocolVersion: ProtocolVersion

Protocol version

`Readonly`type

type: typeof CONNECT

Packet type discriminator.

`Optional` `Readonly`username

username?: string

Username (optional)

`Optional` `Readonly`will

will?: WillMessage

Will message (optional)