MqttConnectPayload class

Class that contains details related to an MQTT Connect messages payload.

The Payload of the Connect message MqttConnectMessage contains one or more length-prefixed fields, whose presence is determined by the flags in the Variable Header.

These fields, if present, MUST appear in the order client Identifier, Will Properties, Will Topic, Will Payload, User Name, Password.

Implemented types

• MqttIPayload

Constructors

MqttConnectPayload(MqttConnectVariableHeader? variableHeader)

Initializes a new instance of the MqttConnectPayload class.

Properties

clientIdentifier ↔ String

client identifier.

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

password ↔ String?

Password

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

username ↔ String?

User name

getter/setter pair

variableHeader ↔ MqttConnectVariableHeader?

Variable header, needed for payload encoding

getter/setter pair

willPayload ↔ Uint8Buffer

Will payload.

getter/setter pair

willProperties ↔ MqttWillProperties

Will Properties.

getter/setter pair

willTopic ↔ String?

Will topic.

getter/setter pair

Methods

getWriteLength() → int

Gets the length of the payload in bytes when written to a stream.

override

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

readFrom(MqttByteBuffer payloadStream) → void

Creates a payload from the specified header stream.

override

toString() → String

A string representation of this object.

override

writeTo(MqttByteBuffer payloadStream) → void

Writes the connect message payload to the supplied stream.

override

Operators

operator ==(Object other) → bool

The equality operator.

inherited