Class DisconnectBuilder

Builder for DISCONNECT packets.

Index

Constructors

Methods

build normal properties reasonCode reasonString serverReference sessionExpiry userProperty withWill

Constructors

constructor

new DisconnectBuilder(): DisconnectBuilder
Returns DisconnectBuilder

Methods

build

build(): DisconnectPacket
Build the DISCONNECT packet

Returns DisconnectPacket
- Defined in testing/builders.ts:955

normal

normal(): this
Set normal disconnection (0x00)

Returns this
- Defined in testing/builders.ts:909

properties

properties(props: DisconnectProperties): this
Set DISCONNECT properties
Parameters
- props: DisconnectProperties
Returns this
- Defined in testing/builders.ts:921

reasonCode

reasonCode(code: ReasonCode): this
Set reason code
Parameters
- code: ReasonCode
Returns this
- Defined in testing/builders.ts:903

reasonString

reasonString(value: string): this
Set reason string
Parameters
- value: string
Returns this
- Defined in testing/builders.ts:933

serverReference

serverReference(value: string): this
Set server reference
Parameters
- value: string
Returns this
- Defined in testing/builders.ts:939

sessionExpiry

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

userProperty

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

withWill

withWill(): this
Set with will message (0x04)

Returns this
- Defined in testing/builders.ts:915