MqttAuthenticateMessage class
An authenticate message is sent from the client to the broker or the broker to the client as part of an extended authentication exchange, such as challenge / response authentication.
It is a protocol rror for the client or the broker to send an authentication message if the connect message did not contain the same authentication method.
- Inheritance
-
- Object
- MqttMessage
- MqttAuthenticateMessage
Constructors
- MqttAuthenticateMessage()
- Initializes a new instance of the MqttAuthenticateMessage class.
- MqttAuthenticateMessage.fromByteBuffer(MqttHeader header, MqttByteBuffer messageStream)
- Initializes a new instance of the MqttAuthenticateMessage class from a message stream.
- MqttAuthenticateMessage.fromHeader(MqttHeader header)
- Initializes a new instance of the MqttAuthenticateMessage class from a supplied header.
Properties
- authenticationData → Uint8Buffer
-
Gets the authentication data.
no setter
- authenticationMethod → String?
-
Gets the authentication method.
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- header ↔ MqttHeader?
-
The header of the MQTT Message. Contains metadata about the message
getter/setter pairinherited
- isValid → bool
-
Is valid
no setteroverride
- reasonCode → MqttAuthenticateReasonCode?
-
Gets the reason code of the message.
no setter
- reasonString → String?
-
Gets the reason string.
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- timeout ↔ bool
-
Time out indication.
getter/setter pair
-
userProperties
→ List<
MqttUserProperty> -
Get the user properties
no setter
- variableHeader → MqttAuthenticateVariableHeader?
-
no setter
Methods
-
addUserProperty(
MqttUserProperty property) → void - Add a specific user property
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
readFrom(
MqttByteBuffer messageStream) → void -
Reads a message from the supplied stream.
override
-
toString(
) → String -
A string representation of this object.
override
-
withAuthenticationData(
Uint8Buffer data) → MqttAuthenticateMessage - Sets the authentication data.
-
withAuthenticationMethod(
String method) → MqttAuthenticateMessage - Sets the authentication method.
-
withReasonCode(
MqttAuthenticateReasonCode reasonCode) → MqttAuthenticateMessage - Sets the reason code of the message.
-
withReasonString(
String reason) → MqttAuthenticateMessage - Sets the reason string
-
withUserProperties(
List< MqttUserProperty> properties) → MqttAuthenticateMessage - Sets a list of user properties
-
writeTo(
MqttByteBuffer messageStream) → void -
Writes the message to the supplied stream.
override
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited