class MQTT::Packet::Unsubscribe

Class representing an MQTT Client Unsubscribe packet

Constants

ATTR_DEFAULTS

Default attribute values

Attributes

topics[RW]

One or more topic paths to unsubscribe from

Public Class Methods

new(args = {}) click to toggle source

Create a new Unsubscribe packet

Calls superclass method MQTT::Packet::new
# File lib/qubitro-mqtt/packet.rb, line 904
def initialize(args = {})
  super(ATTR_DEFAULTS.merge(args))
end

Public Instance Methods

encode_body() click to toggle source

Get serialisation of packet's body

# File lib/qubitro-mqtt/packet.rb, line 914
def encode_body
  raise 'no topics given when serialising packet' if @topics.empty?
  body = encode_short(@id)
  topics.each { |topic| body += encode_string(topic) }
  body
end
inspect() click to toggle source

Returns a human readable string, summarising the properties of the packet

# File lib/qubitro-mqtt/packet.rb, line 936
def inspect
  "\#<#{self.class}: 0x%2.2X, %s>" % [
    id,
    topics.map { |t| "'#{t}'" }.join(', ')
  ]
end
parse_body(buffer) click to toggle source

Parse the body (variable header and payload) of a packet

Calls superclass method MQTT::Packet#parse_body
# File lib/qubitro-mqtt/packet.rb, line 922
def parse_body(buffer)
  super(buffer)
  @id = shift_short(buffer)
  @topics << shift_string(buffer) while buffer.bytesize > 0
end
topics=(value) click to toggle source

Set one or more topic paths to unsubscribe from

# File lib/qubitro-mqtt/packet.rb, line 909
def topics=(value)
  @topics = value.is_a?(Array) ? value : [value]
end
validate_flags() click to toggle source

Check that fixed header flags are valid for this packet type @private

# File lib/qubitro-mqtt/packet.rb, line 930
def validate_flags
  return if @flags == [false, true, false, false]
  raise ProtocolException, 'Invalid flags in UNSUBSCRIBE packet header'
end