class MQTT::V3::Connack

Overview

Class representing an MQTT Connect Acknowledgment Packet

Defined in:

mqtt/v3/connack.cr

Constant Summary

ENDIAN = ["big"]

Class representing an MQTT Connect Acknowledgment Packet

KLASS_NAME = [MQTT::V3::Connack]

Class representing an MQTT Connect Acknowledgment Packet

PARTS = [{type: "bitfield", name: 1, cls: MQTT::V3::Connack, onlyif: nil, verify: nil}, {type: "basic", name: return_code, cls: UInt8, onlyif: nil, verify: nil, value: nil, endian: nil}] of Nil

Class representing an MQTT Connect Acknowledgment Packet

REFUSAL_CODES = {1_u8 => "Connection refused: unacceptable protocol version", 2_u8 => "Connection refused: client identifier rejected", 3_u8 => "Connection refused: server unavailable", 4_u8 => "Connection refused: bad user name or password", 5_u8 => "Connection refused: not authorised"}
REMAINING = [] of Nil

Class representing an MQTT Connect Acknowledgment Packet

Class Method Summary

Macro Summary

Instance Method Summary

Instance methods inherited from class MQTT::V3::Header

__format__ : IO::ByteFormat __format__, duplicate : Bool duplicate, duplicate=(duplicate : UInt8)
duplicate=(value : Bool)
duplicate=
, 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=(variable_length1 : UInt8) variable_length1=, variable_length2 : UInt8 variable_length2, variable_length2=(variable_length2 : UInt8) variable_length2=, variable_length3 : UInt8 variable_length3, variable_length3=(variable_length3 : UInt8) variable_length3=, variable_length4 : UInt8 variable_length4, variable_length4=(variable_length4 : UInt8) variable_length4=

Class methods inherited from class MQTT::V3::Header

bit_fields bit_fields

Macros inherited from class MQTT::V3::Header

mqtt_v3_header(name, onlyif = nil, verify = nil, value = nil) mqtt_v3_header

Class Method Detail

def self.bit_fields #

Class representing an MQTT Connect Acknowledgment Packet


[View source]

Macro Detail

macro mqtt_v3_ack(name, onlyif = nil, verify = nil, value = nil) #

Class representing an MQTT Connect Acknowledgment Packet


[View source]
macro mqtt_v3_connack(name, onlyif = nil, verify = nil, value = nil) #

Class representing an MQTT Connect Acknowledgment Packet


[View source]
macro mqtt_v3_header(name, onlyif = nil, verify = nil, value = nil) #

Class representing an MQTT Connect Acknowledgment Packet


[View source]

Instance Method Detail

def __format__ : IO::ByteFormat #

[View source]
def _reserved_ : UInt8 #

def _reserved_=(_reserved_ : UInt8) #

def calculate_length : UInt32 #

[View source]
def return_code : UInt8 #

The return code (defaults to 0 for connection accepted)


def return_code=(return_code : UInt8) #

The return code (defaults to 0 for connection accepted)


def session_present : Bool #

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

def session_present=(value : Bool) #

[View source]
def success! #

[View source]
def success? #

[View source]