Class ConnectBuilder

Builder for CONNECT packets.

Index

Constructors

Methods

build cleanStart clientId keepAlive maxPacketSize password properties receiveMaximum sessionExpiry topicAliasMaximum username userProperty version will withWill

Constructors

constructor

new ConnectBuilder(): ConnectBuilder
Returns ConnectBuilder

Methods

build

build(): ConnectPacket
Build the CONNECT packet

Returns ConnectPacket
- Defined in testing/builders.ts:177

cleanStart

cleanStart(value?: boolean): this
Enable clean start
Parameters
- value: boolean = true
Returns this
- Defined in testing/builders.ts:96

clientId

clientId(value: string): this
Set client identifier
Parameters
- value: string
Returns this
- Defined in testing/builders.ts:84

keepAlive

keepAlive(seconds: number): this
Set keep alive interval (seconds)
Parameters
- seconds: number
Returns this
- Defined in testing/builders.ts:102

maxPacketSize

maxPacketSize(bytes: number): this
Set maximum packet size
Parameters
- bytes: number
Returns this
- Defined in testing/builders.ts:155

password

password(value: string | Uint8Array<ArrayBufferLike>): this
Set password
Parameters
- value: string | Uint8Array<ArrayBufferLike>
Returns this
- Defined in testing/builders.ts:114

properties

properties(props: ConnectProperties): this
Set CONNECT properties
Parameters
- props: ConnectProperties
Returns this
- Defined in testing/builders.ts:137

receiveMaximum

receiveMaximum(value: number): this
Set receive maximum
Parameters
- value: number
Returns this
- Defined in testing/builders.ts:149

sessionExpiry

sessionExpiry(seconds: number): this
Set session expiry interval
Parameters
- seconds: number
Returns this
- Defined in testing/builders.ts:143

topicAliasMaximum

topicAliasMaximum(value: number): this
Set topic alias maximum
Parameters
- value: number
Returns this
- Defined in testing/builders.ts:161

username

username(value: string): this
Set username
Parameters
- value: string
Returns this
- Defined in testing/builders.ts:108

userProperty

userProperty(key: string, value: string): this
Add user property
Parameters
- key: string
- value: string
Returns this
- Defined in testing/builders.ts:167

version

version(value: ProtocolVersion): this
Set protocol version
Parameters
- value: ProtocolVersion
Returns this
- Defined in testing/builders.ts:90

will

will(will: WillMessage): this
Set will message
Parameters
- will: WillMessage
Returns this
- Defined in testing/builders.ts:120

withWill

withWill(
    topic: string,
    payload: string | Uint8Array<ArrayBufferLike>,
    configure?: (builder: WillBuilder) => WillBuilder,
): this
Set will message using builder callback
Parameters
- topic: string
- payload: string | Uint8Array<ArrayBufferLike>
- Optionalconfigure: (builder: WillBuilder) => WillBuilder
Returns this
- Defined in testing/builders.ts:126