MqttConnectReasonCode enum

MQTT reason code

A Reason Code is a one byte unsigned value that indicates the result of an operation. Reason codes less than 0x80 indicate successful completion of an operation. The normal Reason Code for success is 0. Reason Code values of 0x80 or greater indicate failure. Connect message processing reason codes.

Inheritance

Constructors

MqttConnectReasonCode()
const

Values

success → const MqttConnectReasonCode

The connection is accepted.

unspecifiedError → const MqttConnectReasonCode

The broker does not wish to reveal the reason for the failure, or none of the other reason codes apply.

malformedPacket → const MqttConnectReasonCode

Data within the connect message could not be correctly parsed.

protocolError → const MqttConnectReasonCode

Data in the connect message does not conform to this specification.

implementationSpecificError → const MqttConnectReasonCode

The connect message is valid but is not accepted by this broker.

unsupportedProtocolVersion → const MqttConnectReasonCode

The broker does not support the version of the MQTT protocol requested by the client.

clientIdentifierNotValid → const MqttConnectReasonCode

The client identifier is a valid string but is not allowed by the broker.

badUsernameOrPassword → const MqttConnectReasonCode

The broker does not accept the user name or password specified by the client

notAuthorized → const MqttConnectReasonCode

The client is not authorized to connect.

serverUnavailable → const MqttConnectReasonCode

The MQTT broker is not available.

serverBusy → const MqttConnectReasonCode

The broker is busy. Try again later.

banned → const MqttConnectReasonCode

This client has been banned by administrative action. Contact the server administrator.

badAuthenticationMethod → const MqttConnectReasonCode

The authentication method is not supported or does not match the authentication method currently in use.

topicNameInvalid → const MqttConnectReasonCode

The will topic name is not malformed, but is not accepted by this broker.

packetTooLarge → const MqttConnectReasonCode

The connect packet(message) exceeded the maximum permissible size.

quotaExceeded → const MqttConnectReasonCode

An implementation or administrative imposed limit has been exceeded.

payloadFormatInvalid → const MqttConnectReasonCode

The will payload does not match the specified payload format indicator.

retainNotSupported → const MqttConnectReasonCode

The broker does not support retained messages, and will retain was set to true.

qosNotSupported → const MqttConnectReasonCode

The broker does not support the QoS set in will QoS.

useAnotherServer → const MqttConnectReasonCode

The client should temporarily use another broker.

serverMoved → const MqttConnectReasonCode

The client should permanently use another broker.

connectionRateExceeded → const MqttConnectReasonCode

The connection rate limit has been exceeded.

notSet → const MqttConnectReasonCode

Not set indication, not part of the MQTT specification, used by the client to indicate a field has not yet been set.

Properties

hashCode → int
The hash code for this object.
no setterinherited
index → int
A numeric identifier for the enumerated value.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Constants

values → const List<MqttConnectReasonCode>
A constant List of the values in this enum, in order of their declaration.