Default attribute values
Set to false to keep a persistent session with the server
The client identifier string
Period the server should keep connection open for between pings
The password for authenticating with the server
The version number of the protocol
The name of the protocol
The username for authenticating with the server
The payload of the Will message
The QoS level to send the Will message as
Set to true to make the Will message retained
The topic name to send the Will message to
Create a new Client Connect packet
# File lib/mqtt/packet.rb, line 465 def initialize(args={}) super(ATTR_DEFAULTS.merge(args)) if version == '3.1.0' or version == '3.1' self.protocol_name ||= 'MQIsdp' self.protocol_level ||= 0x03 elsif version == '3.1.1' self.protocol_name ||= 'MQTT' self.protocol_level ||= 0x04 else raise ArgumentError.new("Unsupported protocol version: #{version}") end end
Get serialisation of packet's body
# File lib/mqtt/packet.rb, line 480 def encode_body body = '' if @version == '3.1.0' if @client_id.nil? or @client_id.bytesize < 1 raise "Client identifier too short while serialising packet" elsif @client_id.bytesize > 23 raise "Client identifier too long when serialising packet" end end body += encode_string(@protocol_name) body += encode_bytes(@protocol_level.to_i) if @keep_alive < 0 raise "Invalid keep-alive value: cannot be less than 0" end # Set the Connect flags @connect_flags = 0 @connect_flags |= 0x02 if @clean_session @connect_flags |= 0x04 unless @will_topic.nil? @connect_flags |= ((@will_qos & 0x03) << 3) @connect_flags |= 0x20 if @will_retain @connect_flags |= 0x40 unless @password.nil? @connect_flags |= 0x80 unless @username.nil? body += encode_bytes(@connect_flags) body += encode_short(@keep_alive) body += encode_string(@client_id) unless will_topic.nil? body += encode_string(@will_topic) # The MQTT v3.1 specification says that the payload is a UTF-8 string body += encode_string(@will_payload) end body += encode_string(@username) unless @username.nil? body += encode_string(@password) unless @password.nil? return body end
Returns a human readable string, summarising the properties of the packet
# File lib/mqtt/packet.rb, line 554 def inspect str = "\#<#{self.class}: " str += "keep_alive=#{keep_alive}" str += ", clean" if clean_session str += ", client_id='#{client_id}'" str += ", username='#{username}'" unless username.nil? str += ", password=..." unless password.nil? str += ">" end
Parse the body (variable header and payload) of a Connect packet
# File lib/mqtt/packet.rb, line 519 def parse_body(buffer) super(buffer) @protocol_name = shift_string(buffer) @protocol_level = shift_byte(buffer).to_i if @protocol_name == 'MQIsdp' and @protocol_level == 3 @version = '3.1.0' elsif @protocol_name == 'MQTT' and @protocol_level == 4 @version = '3.1.1' else raise ProtocolException.new( "Unsupported protocol: #{@protocol_name}/#{@protocol_level}" ) end @connect_flags = shift_byte(buffer) @clean_session = ((@connect_flags & 0x02) >> 1) == 0x01 @keep_alive = shift_short(buffer) @client_id = shift_string(buffer) if ((@connect_flags & 0x04) >> 2) == 0x01 # Last Will and Testament @will_qos = ((@connect_flags & 0x18) >> 3) @will_retain = ((@connect_flags & 0x20) >> 5) == 0x01 @will_topic = shift_string(buffer) # The MQTT v3.1 specification says that the payload is a UTF-8 string @will_payload = shift_string(buffer) end if ((@connect_flags & 0x80) >> 7) == 0x01 and buffer.bytesize > 0 @username = shift_string(buffer) end if ((@connect_flags & 0x40) >> 6) == 0x01 and buffer.bytesize > 0 @password = shift_string(buffer) end end
@deprecated Please use {#protocol_level} instead
# File lib/mqtt/packet.rb, line 568 def protocol_version protocol_level end
@deprecated Please use {#protocol_level=} instead
# File lib/mqtt/packet.rb, line 573 def protocol_version=(args) self.protocol_level = args end