enum MQTT::V5::ReasonCode

Overview

5.0 replaces 3.1.1's handful of return codes with a single reason code space shared across CONNACK, the PUBLISH acknowledgements, SUBACK, UNSUBACK, DISCONNECT and AUTH.

NOTE : anything below 0x80 is a success. Success, GrantedQoS0 and NormalDisconnection are all zero, they simply read differently depending on which packet carried them

Defined in:

mqtt/v5/reason_code.cr

Enum Members

Success = 0_u8

GrantedQoS1 = 1_u8

GrantedQoS2 = 2_u8

DisconnectWithWillMessage = 4_u8

NoMatchingSubscribers = 16_u8

NoSubscriptionExisted = 17_u8

ContinueAuthentication = 24_u8

ReAuthenticate = 25_u8

UnspecifiedError = 128_u8

MalformedPacket = 129_u8

ProtocolError = 130_u8

ImplementationSpecificError = 131_u8

UnsupportedProtocolVersion = 132_u8

ClientIdentifierNotValid = 133_u8

BadUserNameOrPassword = 134_u8

NotAuthorized = 135_u8

ServerUnavailable = 136_u8

ServerBusy = 137_u8

Banned = 138_u8

ServerShuttingDown = 139_u8

BadAuthenticationMethod = 140_u8

KeepAliveTimeout = 141_u8

SessionTakenOver = 142_u8

TopicFilterInvalid = 143_u8

TopicNameInvalid = 144_u8

PacketIdentifierInUse = 145_u8

PacketIdentifierNotFound = 146_u8

ReceiveMaximumExceeded = 147_u8

TopicAliasInvalid = 148_u8

PacketTooLarge = 149_u8

MessageRateTooHigh = 150_u8

QuotaExceeded = 151_u8

AdministrativeAction = 152_u8

PayloadFormatInvalid = 153_u8

RetainNotSupported = 154_u8

QoSNotSupported = 155_u8

UseAnotherServer = 156_u8

ServerMoved = 157_u8

SharedSubscriptionsNotSupported = 158_u8

ConnectionRateExceeded = 159_u8

MaximumConnectTime = 160_u8

SubscriptionIdentifiersNotSupported = 161_u8

WildcardSubscriptionsNotSupported = 162_u8

Instance Method Summary

• #administrative_action?

  Returns true if this enum value equals AdministrativeAction

• #bad_authentication_method?

  Returns true if this enum value equals BadAuthenticationMethod

• #bad_user_name_or_password?

  Returns true if this enum value equals BadUserNameOrPassword

• #banned?

  Returns true if this enum value equals Banned

• #client_identifier_not_valid?

  Returns true if this enum value equals ClientIdentifierNotValid

• #connection_rate_exceeded?

  Returns true if this enum value equals ConnectionRateExceeded

• #continue_authentication?

  Returns true if this enum value equals ContinueAuthentication

• #description : String
• #disconnect_with_will_message?

  Returns true if this enum value equals DisconnectWithWillMessage

• #error? : Bool
• #fatal? : Bool

  Whether reconnecting with the same settings could plausibly work.

• #granted_qo_s1?

  Returns true if this enum value equals GrantedQoS1

• #granted_qo_s2?

  Returns true if this enum value equals GrantedQoS2

• #granted_qos : QoS | Nil

  The QoS a SUBACK granted, or nil if the filter was rejected

• #implementation_specific_error?

  Returns true if this enum value equals ImplementationSpecificError

• #keep_alive_timeout?

  Returns true if this enum value equals KeepAliveTimeout

• #malformed_packet?

  Returns true if this enum value equals MalformedPacket

• #maximum_connect_time?

  Returns true if this enum value equals MaximumConnectTime

• #message_rate_too_high?

  Returns true if this enum value equals MessageRateTooHigh

• #no_matching_subscribers?

  Returns true if this enum value equals NoMatchingSubscribers

• #no_subscription_existed?

  Returns true if this enum value equals NoSubscriptionExisted

• #not_authorized?

  Returns true if this enum value equals NotAuthorized

• #packet_identifier_in_use?

  Returns true if this enum value equals PacketIdentifierInUse

• #packet_identifier_not_found?

  Returns true if this enum value equals PacketIdentifierNotFound

• #packet_too_large?

  Returns true if this enum value equals PacketTooLarge

• #payload_format_invalid?

  Returns true if this enum value equals PayloadFormatInvalid

• #protocol_error?

  Returns true if this enum value equals ProtocolError

• #qo_s_not_supported?

  Returns true if this enum value equals QoSNotSupported

• #quota_exceeded?

  Returns true if this enum value equals QuotaExceeded

• #re_authenticate?

  Returns true if this enum value equals ReAuthenticate

• #receive_maximum_exceeded?

  Returns true if this enum value equals ReceiveMaximumExceeded

• #retain_not_supported?

  Returns true if this enum value equals RetainNotSupported

• #server_busy?

  Returns true if this enum value equals ServerBusy

• #server_moved?

  Returns true if this enum value equals ServerMoved

• #server_shutting_down?

  Returns true if this enum value equals ServerShuttingDown

• #server_unavailable?

  Returns true if this enum value equals ServerUnavailable

• #session_taken_over?

  Returns true if this enum value equals SessionTakenOver

• #shared_subscriptions_not_supported?

  Returns true if this enum value equals SharedSubscriptionsNotSupported

• #subscription_identifiers_not_supported?

  Returns true if this enum value equals SubscriptionIdentifiersNotSupported

• #success? : Bool

  MQTT-2.4, everything below 0x80 is a success

• #topic_alias_invalid?

  Returns true if this enum value equals TopicAliasInvalid

• #topic_filter_invalid?

  Returns true if this enum value equals TopicFilterInvalid

• #topic_name_invalid?

  Returns true if this enum value equals TopicNameInvalid

• #unspecified_error?

  Returns true if this enum value equals UnspecifiedError

• #unsupported_protocol_version?

  Returns true if this enum value equals UnsupportedProtocolVersion

• #use_another_server?

  Returns true if this enum value equals UseAnotherServer

• #wildcard_subscriptions_not_supported?

  Returns true if this enum value equals WildcardSubscriptionsNotSupported

Instance Method Detail