class MQTT::V5::Connack

Overview

MQTT-3.2

Included Modules

Defined in:

mqtt/v5/connect.cr

Constant Summary

AFTER_DESERIALIZE = [] of Nil

MQTT-3.2

ALLOWED_PROPERTIES = [PropertyId::SessionExpiryInterval, PropertyId::ReceiveMaximum, PropertyId::MaximumQoS, PropertyId::RetainAvailable, PropertyId::MaximumPacketSize, PropertyId::AssignedClientIdentifier, PropertyId::TopicAliasMaximum, PropertyId::ReasonString, PropertyId::UserProperty, PropertyId::WildcardSubscriptionAvailable, PropertyId::SubscriptionIdentifiersAvailable, PropertyId::SharedSubscriptionAvailable, PropertyId::ServerKeepAlive, PropertyId::ResponseInformation, PropertyId::ServerReference, PropertyId::AuthenticationMethod, PropertyId::AuthenticationData]
BEFORE_SERIALIZE = [] of Nil

MQTT-3.2

ENDIAN = ["big"]

MQTT-3.2

KLASS_NAME = [MQTT::V5::Connack]

MQTT-3.2

PARTS = [{type: "bitfield", name: 4, cls: MQTT::V5::Connack, onlyif: nil, verify: nil, endian: IO::ByteFormat::BigEndian}, {type: "basic", name: raw_reason_code, cls: UInt8, onlyif: nil, verify: nil, value: nil, endian: nil}, {type: "basic", name: properties, cls: MQTT::V5::Properties, onlyif: nil, verify: nil, value: nil}] of Nil

MQTT-3.2

REMAINING = [] of Nil

MQTT-3.2

Class Method Summary

Instance Method Summary

Instance methods inherited from module MQTT::V5::ReasonCoded

error? : Bool error?, reason_code : ReasonCode | Nil reason_code, reason_code=(code : ReasonCode) : ReasonCode reason_code=, reason_description : String reason_description, success? : Bool success?

Instance methods inherited from class MQTT::Header

__format__ : IO::ByteFormat __format__, duplicate : Bool duplicate, duplicate=(duplicate : UInt8)
duplicate=(value : Bool)
duplicate=
, fixed_header_size : Int32 fixed_header_size, id : MQTT::RequestType id, id=(id : UInt8)
id=(value : MQTT::RequestType)
id=
, packet_length : UInt32 packet_length, packet_length=(size : UInt32) : UInt32 packet_length=, qos : MQTT::QoS qos, qos=(qos : UInt8)
qos=(value : MQTT::QoS)
qos=
, qos? qos?, retain : Bool retain, retain=(retain : UInt8)
retain=(value : Bool)
retain=
, variable_length1 : UInt8 variable_length1, variable_length1=(value : UInt8) : UInt8 variable_length1=, variable_length2 : UInt8 variable_length2, variable_length2=(value : UInt8) : UInt8 variable_length2=, variable_length3 : UInt8 variable_length3, variable_length3=(value : UInt8) : UInt8 variable_length3=, variable_length4 : UInt8 variable_length4, variable_length4=(value : UInt8) : UInt8 variable_length4=

Class methods inherited from class MQTT::Header

bit_fields bit_fields

Class Method Detail

def self.bit_fields #

MQTT-3.2


[View source]

Instance Method Detail

def __format__ : IO::ByteFormat #

A group or bit_field captures the endianness at its declaration point, so declaring endian after one would silently leave it system-endian. Fail loudly.


[View source]
def _reserved_ : UInt8 #

def _reserved_=(_reserved_ : UInt8) #

def assigned_client_identifier : String | Nil #

The identifier the broker picked for us, when we sent an empty one


[View source]
def authentication_data : Bytes | Nil #

[View source]
def authentication_method : String | Nil #

[View source]
def calculate_length : UInt32 #

[View source]
def maximum_packet_size : UInt32 | Nil #

[View source]
def maximum_qos : QoS #

[View source]
def properties : Properties #

def properties=(properties : Properties) #

def raw_reason_code : UInt8 #

def raw_reason_code=(raw_reason_code : UInt8) #

def reason_string : String | Nil #

[View source]
def receive_maximum : UInt16 #

How many QoS > 0 messages the broker will accept in flight


[View source]
def response_information : String | Nil #

[View source]
def retain_available? : Bool #

[View source]
def server_keep_alive : UInt16 | Nil #

A broker may impose its own keep alive, overriding what we asked for


[View source]
def server_reference : String | Nil #

[View source]
def session_expiry_interval : UInt32 | Nil #

[View source]
def session_present : Bool #

[View source]
def session_present=(session_present : UInt8) #

def session_present=(value : Bool) #

[View source]
def shared_subscription_available? : Bool #

[View source]
def subscription_identifier_available? : Bool #

[View source]
def success! : self #

[View source]
def topic_alias_maximum : UInt16 #

[View source]
def user_properties : Array(Tuple(String, String)) #

[View source]
def validate! : self #

[View source]
def wildcard_subscription_available? : Bool #

[View source]