class MQTT::V5::SubTopic

Overview

A topic filter plus the 5.0 subscription options byte

Defined in:

mqtt/v5/subscribe.cr

Constant Summary

AFTER_DESERIALIZE = [] of Nil

A topic filter plus the 5.0 subscription options byte

BEFORE_SERIALIZE = [] of Nil

A topic filter plus the 5.0 subscription options byte

ENDIAN = ["big"]

A topic filter plus the 5.0 subscription options byte

KLASS_NAME = [MQTT::V5::SubTopic]

A topic filter plus the 5.0 subscription options byte

PARTS = [{type: "basic", name: filter_size, cls: UInt16, onlyif: nil, verify: nil, value: -> do filter.bytesize end, endian: nil}, {type: "string", name: filter, cls: String, onlyif: nil, verify: nil, length: -> do filter_size end, value: nil, encoding: nil}, {type: "bitfield", name: 5, cls: MQTT::V5::SubTopic, onlyif: nil, verify: nil, endian: IO::ByteFormat::BigEndian}] of Nil

A topic filter plus the 5.0 subscription options byte

REMAINING = [] of Nil

A topic filter plus the 5.0 subscription options byte

Class Method Summary

Instance Method Summary

Class Method Detail

def self.bit_fields #

A topic filter plus the 5.0 subscription options byte


[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 bytesize #

[View source]
def filter : String #

def filter=(filter : String) #

def filter_size : UInt16 #

def filter_size=(filter_size : UInt16) #

def no_local : Bool #

don't deliver our own publications back to us


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

don't deliver our own publications back to us


def no_local=(value : Bool) #

don't deliver our own publications back to us


[View source]
def qos : MQTT::QoS #

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

def qos=(value : MQTT::QoS) #

[View source]
def retain_as_published : Bool #

keep the retain flag the publisher set, rather than clearing it


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

keep the retain flag the publisher set, rather than clearing it


def retain_as_published=(value : Bool) #

keep the retain flag the publisher set, rather than clearing it


[View source]
def retain_handling : MQTT::V5::RetainHandling #

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

def retain_handling=(value : MQTT::V5::RetainHandling) #

[View source]