class
MQTT::V5::Connack
- MQTT::V5::Connack
- MQTT::Header
- BinData
- Reference
- Object
Overview
MQTT-3.2
Included Modules
Defined in:
mqtt/v5/connect.crConstant 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
-
.bit_fields
MQTT-3.2
Instance Method Summary
-
#__format__ : IO::ByteFormat
A
grouporbit_fieldcaptures the endianness at its declaration point, so declaringendianafter one would silently leave it system-endian. - #_reserved_ : UInt8
- #_reserved_=(_reserved_ : UInt8)
-
#assigned_client_identifier : String | Nil
The identifier the broker picked for us, when we sent an empty one
- #authentication_data : Bytes | Nil
- #authentication_method : String | Nil
- #calculate_length : UInt32
- #maximum_packet_size : UInt32 | Nil
- #maximum_qos : QoS
- #properties : Properties
- #properties=(properties : Properties)
- #raw_reason_code : UInt8
- #raw_reason_code=(raw_reason_code : UInt8)
- #reason_string : String | Nil
-
#receive_maximum : UInt16
How many QoS > 0 messages the broker will accept in flight
- #response_information : String | Nil
- #retain_available? : Bool
-
#server_keep_alive : UInt16 | Nil
A broker may impose its own keep alive, overriding what we asked for
- #server_reference : String | Nil
- #session_expiry_interval : UInt32 | Nil
- #session_present : Bool
- #session_present=(session_present : UInt8)
- #session_present=(value : Bool)
- #shared_subscription_available? : Bool
- #subscription_identifier_available? : Bool
- #success! : self
- #topic_alias_maximum : UInt16
- #user_properties : Array(Tuple(String, String))
- #validate! : self
- #wildcard_subscription_available? : Bool
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
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.
def assigned_client_identifier : String | Nil
#
The identifier the broker picked for us, when we sent an empty one
def server_keep_alive : UInt16 | Nil
#
A broker may impose its own keep alive, overriding what we asked for