Class: MQTT::Packet::Subscribe

Inherits:
MQTT::Packet show all
Defined in:
lib/mqtt/packet.rb

Overview

Class representing an MQTT Client Subscribe packet

Constant Summary collapse

ATTR_DEFAULTS =

Default attribute values

{
  :topics => [],
  :flags => [false, true, false, false]
}

Instance Attribute Summary collapse

Attributes inherited from MQTT::Packet

#body_length, #flags, #id, #version

Instance Method Summary collapse

Methods inherited from MQTT::Packet

create_from_header, #message_id, #message_id=, parse, parse_header, read, read_byte, #to_s, #type_id, #type_name, #update_attributes

Constructor Details

#initialize(args = {}) ⇒ Subscribe

Create a new Subscribe packet



746
747
748
 
# File 'lib/mqtt/packet.rb', line 746

def initialize(args = {})
  super(ATTR_DEFAULTS.merge(args))
end

Instance Attribute Details

#topics ⇒ Object

One or more topic filters to subscribe to



737
738
739
 
# File 'lib/mqtt/packet.rb', line 737

def topics
  @topics
end

Instance Method Details

#encode_body ⇒ Object

Get serialisation of packet’s body



789
790
791
792
793
794
795
796
797
 
# File 'lib/mqtt/packet.rb', line 789

def encode_body
  raise 'no topics given when serialising packet' if @topics.empty?
  body = encode_short(@id)
  topics.each do |item|
    body += encode_string(item[0])
    body += encode_bytes(item[1])
  end
  body
end

#inspect ⇒ Object

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



819
820
821
822
823
824
 
# File 'lib/mqtt/packet.rb', line 819

def inspect
  _str = "\#<#{self.class}: 0x%2.2X, %s>" % [
    id,
    topics.map { |t| "'#{t[0]}':#{t[1]}" }.join(', ')
  ]
end

#parse_body(buffer) ⇒ Object

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



800
801
802
803
804
805
806
807
808
809
 
# File 'lib/mqtt/packet.rb', line 800

def parse_body(buffer)
  super(buffer)
  @id = shift_short(buffer)
  @topics = []
  while buffer.bytesize > 0
    topic_name = shift_string(buffer)
    topic_qos = shift_byte(buffer)
    @topics << [topic_name, topic_qos]
  end
end

#validate_flags ⇒ Object

Check that fixed header flags are valid for this packet type

Raises:



813
814
815
816
 
# File 'lib/mqtt/packet.rb', line 813

def validate_flags
  return if @flags == [false, true, false, false]
  raise ProtocolException, 'Invalid flags in SUBSCRIBE packet header'
end