paho-mqtt 1.0.7 → 1.0.9

data/lib/paho_mqtt/packet/disconnect.rb

@@ -29,7 +29,8 @@ module PahoMqtt
       def parse_body(buffer)
         super(buffer)
         unless buffer.empty?
-          raise "Extra bytes at end of Disconnect packet"
+          raise PacketFormatException.new(
+                  "Extra bytes at the end of Disconnect packet")
         end
       end
     end

data/lib/paho_mqtt/packet/pingresp.rb

@@ -29,7 +29,8 @@ module PahoMqtt
       def parse_body(buffer)
         super(buffer)
         unless buffer.empty?
-          raise "Extra bytes at end of Ping Response packet"
+          raise PahoMqtt::PacketFormatException.new(
+                  "Extra bytes at end of Ping Response packet")
         end
       end
     end

data/lib/paho_mqtt/packet/puback.rb

@@ -30,7 +30,8 @@ module PahoMqtt
         super(buffer)
         @id = shift_short(buffer)
         unless buffer.empty?
-          raise "Extra bytes at end of Publish Acknowledgment packet"
+          raise PahoMqtt::PacketFormatException.new(
+          "Extra bytes at end of Publish Acknowledgment packet")
         end
       end
 

data/lib/paho_mqtt/packet/pubcomp.rb

@@ -30,7 +30,8 @@ module PahoMqtt
         super(buffer)
         @id = shift_short(buffer)
         unless buffer.empty?
-          raise "Extra bytes at end of Publish Complete packet"
+          raise PahoMqtt::PacketFormatException.new(
+                  "Extra bytes at end of Publish Complete packet")
         end
       end
 

data/lib/paho_mqtt/packet/publish.rb

@@ -37,7 +37,7 @@ module PahoMqtt
 
       # Default attribute values
       ATTR_DEFAULTS = {
-        :topic => nil,
+        :topic   => nil,
         :payload => ''
       }
 
@@ -79,8 +79,9 @@ module PahoMqtt
       # Set the Quality of Service level (0/1/2)
       def qos=(arg)
         @qos = arg.to_i
-        if @qos < 0 or @qos > 2
-          raise "Invalid QoS value: #{@qos}"
+        if @qos < 0 || @qos > 2
+          raise PahoMqtt::PacketFormatException.new(
+                  "Invalid QoS value: #{@qos}")
         else
           @flags[1] = (arg & 0x01 == 0x01)
           @flags[2] = (arg & 0x02 == 0x02)
@@ -90,8 +91,9 @@ module PahoMqtt
       # Get serialisation of packet's body
       def encode_body
         body = ''
-        if @topic.nil? or @topic.to_s.empty?
-          raise "Invalid topic name when serialising packet"
+        if @topic.nil? || @topic.to_s.empty?
+          raise PahoMqtt::PacketFormatException.new(
+                  "Invalid topic name when serialising packet")
         end
         body += encode_string(@topic)
         body += encode_short(@id) unless qos == 0
@@ -102,8 +104,8 @@ module PahoMqtt
       # Parse the body (variable header and payload) of a Publish packet
       def parse_body(buffer)
         super(buffer)
-        @topic = shift_string(buffer)
-        @id = shift_short(buffer) unless qos == 0
+        @topic   = shift_string(buffer)
+        @id      = shift_short(buffer) unless qos == 0
         @payload = buffer
       end
 
@@ -111,10 +113,12 @@ module PahoMqtt
       # @private
       def validate_flags
         if qos == 3
-          raise "Invalid packet: QoS value of 3 is not allowed"
+          raise PahoMqtt::PacketFormatException.new(
+                  "Invalid packet: QoS value of 3 is not allowed")
         end
-        if qos == 0 and duplicate
-          raise "Invalid packet: DUP cannot be set for QoS 0"
+        if qos == 0 && duplicate
+          raise PahoMqtt::PacketFormatException.new(
+                  "Invalid packet: DUP cannot be set for QoS 0")
         end
       end
 
@@ -133,7 +137,7 @@ module PahoMqtt
 
       def inspect_payload
         str = payload.to_s
-        if str.bytesize < 16 and str =~ /^[ -~]*$/
+        if str.bytesize < 16 && str =~ /^[ -~]*$/
           "'#{str}'"
         else
           "... (#{str.bytesize} bytes)"

data/lib/paho_mqtt/packet/pubrec.rb

@@ -30,7 +30,8 @@ module PahoMqtt
         super(buffer)
         @id = shift_short(buffer)
         unless buffer.empty?
-          raise "Extra bytes at end of Publish Received packet"
+          raise PahoMqtt::PacketFormatException.new(
+                  "Extra bytes at end of Publish Received packet")
         end
       end
 

data/lib/paho_mqtt/packet/pubrel.rb

@@ -48,7 +48,8 @@ module PahoMqtt
       # @private
       def validate_flags
         if @flags != [false, true, false, false]
-          raise "Invalid flags in PUBREL packet header"
+          raise PahoMqtt::PacketFormatException.new(
+                  "Invalid flags in #{type_name} packet header")
         end
       end
 

data/lib/paho_mqtt/packet/suback.rb

@@ -41,14 +41,16 @@ module PahoMqtt
         elsif value.is_a?(Integer)
           @return_codes = [value]
         else
-          raise "return_codes should be an integer or an array of return codes"
+          raise PahoMqtt::PacketFormatException.new(
+                  "return_codes should be an integer or an array of return codes")
         end
       end
 
       # Get serialisation of packet's body
       def encode_body
         if @return_codes.empty?
-          raise "no granted QoS given when serialising packet"
+          raise PahoMqtt::PacketFormatException.new(
+                  "No granted QoS given when serialising packet")
         end
         body = encode_short(@id)
         return_codes.each { |qos| body += encode_bytes(qos) }
@@ -59,14 +61,14 @@ module PahoMqtt
       def parse_body(buffer)
         super(buffer)
         @id = shift_short(buffer)
-        while(buffer.bytesize>0)
+        while buffer.bytesize > 0
           @return_codes << shift_byte(buffer)
         end
       end
 
       # Returns a human readable string, summarising the properties of the packet
       def inspect
-        "\#<#{self.class}: 0x%2.2X, rc=%s>" % [id, return_codes.map{|rc| "0x%2.2X" % rc}.join(',')]
+        "\#<#{self.class}: 0x%2.2X, rc=%s>" % [id, return_codes.map { |rc| "0x%2.2X" % rc }.join(',')]
       end
     end
   end

data/lib/paho_mqtt/packet/subscribe.rb

@@ -64,13 +64,14 @@ module PahoMqtt
             # Peek at the next item in the array, and remove it if it is an integer
             if input.first.is_a?(Integer)
               qos = input.shift
-              @topics << [item,qos]
+              @topics << [item, qos]
             else
-              @topics << [item,0]
+              @topics << [item, 0]
             end
           else
             # Meh?
-            raise "Invalid topics input: #{value.inspect}"
+            raise PahoMqtt::PacketFormatException.new(
+                    "Invalid topics input: #{value.inspect}")
           end
         end
         @topics
@@ -79,7 +80,8 @@ module PahoMqtt
       # Get serialisation of packet's body
       def encode_body
         if @topics.empty?
-          raise "no topics given when serialising packet"
+          raise PahoMqtt::PacketFormatException.new(
+                  "No topics given when serialising packet")
         end
         body = encode_short(@id)
         topics.each do |item|
@@ -97,7 +99,7 @@ module PahoMqtt
         while(buffer.bytesize>0)
           topic_name = shift_string(buffer)
           topic_qos = shift_byte(buffer)
-          @topics << [topic_name,topic_qos]
+          @topics << [topic_name, topic_qos]
         end
       end
 
@@ -105,7 +107,8 @@ module PahoMqtt
       # @private
       def validate_flags
         if @flags != [false, true, false, false]
-          raise "Invalid flags in SUBSCRIBE packet header"
+          raise PahoMqtt::PacketFormatException.new(
+                  "Invalid flags in SUBSCRIBE packet header")
         end
       end
 
@@ -113,7 +116,7 @@ module PahoMqtt
       def inspect
         _str = "\#<#{self.class}: 0x%2.2X, %s>" % [
           id,
-          topics.map {|t| "'#{t[0]}':#{t[1]}"}.join(', ')
+          topics.map { |t| "'#{t[0]}':#{t[1]}" }.join(', ')
         ]
       end
     end

data/lib/paho_mqtt/packet/unsuback.rb

@@ -35,7 +35,8 @@ module PahoMqtt
         super(buffer)
         @id = shift_short(buffer)
         unless buffer.empty?
-          raise "Extra bytes at end of Unsubscribe Acknowledgment packet"
+          raise PahoMqtt::PacketFormatException.new(
+                  "Extra bytes at end of Unsubscribe Acknowledgment packet")
         end
       end
 

data/lib/paho_mqtt/packet/unsubscribe.rb

@@ -26,7 +26,7 @@ module PahoMqtt
       # Default attribute values
       ATTR_DEFAULTS = {
         :topics => [],
-        :flags => [false, true, false, false],
+        :flags  => [false, true, false, false],
       }
 
       # Create a new Unsubscribe packet
@@ -46,7 +46,8 @@ module PahoMqtt
       # Get serialisation of packet's body
       def encode_body
         if @topics.empty?
-          raise "no topics given when serialising packet"
+          raise PahoMqtt::PacketFormatException.new(
+                  "No topics given when serialising packet")
         end
         body = encode_short(@id)
         topics.each { |topic| body += encode_string(topic) }
@@ -57,7 +58,7 @@ module PahoMqtt
       def parse_body(buffer)
         super(buffer)
         @id = shift_short(buffer)
-        while(buffer.bytesize>0)
+        while buffer.bytesize > 0
           @topics << shift_string(buffer)
         end
       end
@@ -66,7 +67,8 @@ module PahoMqtt
       # @private
       def validate_flags
         if @flags != [false, true, false, false]
-          raise "Invalid flags in UNSUBSCRIBE packet header"
+          raise PahoMqtt::PacketFormatException.new(
+                  "Invalid flags in UNSUBSCRIBE packet header")
         end
       end
 
@@ -74,7 +76,7 @@ module PahoMqtt
       def inspect
         "\#<#{self.class}: 0x%2.2X, %s>" % [
           id,
-          topics.map {|t| "'#{t}'"}.join(', ')
+          topics.map { |t| "'#{t}'" }.join(', ')
         ]
       end
     end

data/lib/paho_mqtt/publisher.rb

@@ -16,15 +16,15 @@ module PahoMqtt
   class Publisher
 
     def initialize(sender)
-      @waiting_puback = []
-      @waiting_pubrec = []
-      @waiting_pubrel = []
+      @waiting_puback  = []
+      @waiting_pubrec  = []
+      @waiting_pubrel  = []
       @waiting_pubcomp = []
-      @puback_mutex = Mutex.new
-      @pubrec_mutex = Mutex.new
-      @pubrel_mutex = Mutex.new
-      @pubcomp_mutex = Mutex.new
-      @sender = sender
+      @puback_mutex    = Mutex.new
+      @pubrec_mutex    = Mutex.new
+      @pubrel_mutex    = Mutex.new
+      @pubcomp_mutex   = Mutex.new
+      @sender          = sender
     end
 
     def sender=(sender)
@@ -33,23 +33,31 @@ module PahoMqtt
 
     def send_publish(topic, payload, retain, qos, new_id)
       packet = PahoMqtt::Packet::Publish.new(
-        :id => new_id,
-        :topic => topic,
+        :id      => new_id,
+        :topic   => topic,
         :payload => payload,
-        :retain => retain,
-        :qos => qos
+        :retain  => retain,
+        :qos     => qos
       )
-      @sender.append_to_writing(packet)
       case qos
       when 1
-        @puback_mutex.synchronize{
-          @waiting_puback.push({:id => new_id, :packet => packet, :timestamp => Time.now})
-        }
+        @puback_mutex.synchronize do
+          if @waiting_puback.length >= MAX_PUBACK
+            PahoMqtt.logger.error('PUBACK queue is full, could not send with qos=1') if PahoMqtt.logger?
+            return MQTT_ERR_FAIL
+          end
+          @waiting_puback.push(:id => new_id, :packet => packet, :timestamp => Time.now)
+        end
       when 2
-        @pubrec_mutex.synchronize{
-          @waiting_pubrec.push({:id => new_id, :packet => packet, :timestamp => Time.now})
-        }
+        @pubrec_mutex.synchronize do
+          if @waiting_pubrec.length >= MAX_PUBREC
+            PahoMqtt.logger.error('PUBREC queue is full, could not send with qos=2') if PahoMqtt.logger?
+            return MQTT_ERR_FAIL
+          end
+          @waiting_pubrec.push(:id => new_id, :packet => packet, :timestamp => Time.now)
+        end
       end
+      @sender.append_to_writing(packet)
       MQTT_ERR_SUCCESS
     end
 
@@ -61,8 +69,8 @@ module PahoMqtt
       when 2
         send_pubrec(packet_id)
       else
-        @logger.error("The packet qos value is invalid in publish.") if logger?
-        raise PacketException
+        PahoMqtt.logger.error("The packet QoS value is invalid in publish.") if PahoMqtt.logger?
+        raise PacketException.new('Invalid publish QoS value')
       end
       MQTT_ERR_SUCCESS
     end
@@ -76,27 +84,31 @@ module PahoMqtt
     end
 
     def do_puback(packet_id)
-      @puback_mutex.synchronize{
+      @puback_mutex.synchronize do
         @waiting_puback.delete_if { |pck| pck[:id] == packet_id }
-      }
-      MQTT_ERR_SUCCESS      
+      end
+      MQTT_ERR_SUCCESS
     end
-    
+
     def send_pubrec(packet_id)
       packet = PahoMqtt::Packet::Pubrec.new(
         :id => packet_id
       )
+      @pubrel_mutex.synchronize do
+        if @waiting_pubrel.length >= MAX_PUBREL
+          PahoMqtt.logger.error('PUBREL queue is full, could not acknowledge qos=2') if PahoMqtt.logger?
+          return MQTT_ERR_FAIL
+        end
+        @waiting_pubrel.push(:id => packet_id , :packet => packet, :timestamp => Time.now)
+      end
       @sender.append_to_writing(packet)
-      @pubrel_mutex.synchronize{
-        @waiting_pubrel.push({:id => packet_id , :packet => packet, :timestamp => Time.now})
-      }
       MQTT_ERR_SUCCESS
     end
 
     def do_pubrec(packet_id)
-      @pubrec_mutex.synchronize {
+      @pubrec_mutex.synchronize do
         @waiting_pubrec.delete_if { |pck| pck[:id] == packet_id }
-      }
+      end
       send_pubrel(packet_id)
       MQTT_ERR_SUCCESS
     end
@@ -105,17 +117,21 @@ module PahoMqtt
       packet = PahoMqtt::Packet::Pubrel.new(
         :id => packet_id
       )
+      @pubcomp_mutex.synchronize do
+        if @waiting_pubcomp.length >= MAX_PUBCOMP
+          PahoMqtt.logger.error('PUBCOMP queue is full, could not acknowledge qos=2') if PahoMqtt.logger?
+          return MQTT_ERR_FAIL
+        end
+        @waiting_pubcomp.push(:id => packet_id, :packet => packet, :timestamp => Time.now)
+      end
       @sender.append_to_writing(packet)
-      @pubcomp_mutex.synchronize{
-        @waiting_pubcomp.push({:id => packet_id, :packet => packet, :timestamp => Time.now})
-      }
       MQTT_ERR_SUCCESS
     end
 
     def do_pubrel(packet_id)
-      @pubrel_mutex.synchronize {
+      @pubrel_mutex.synchronize do
         @waiting_pubrel.delete_if { |pck| pck[:id] == packet_id }
-      }
+      end
       send_pubcomp(packet_id)
       MQTT_ERR_SUCCESS
     end
@@ -129,52 +145,47 @@ module PahoMqtt
     end
 
     def do_pubcomp(packet_id)
-      @pubcomp_mutex.synchronize {
+      @pubcomp_mutex.synchronize do
         @waiting_pubcomp.delete_if { |pck| pck[:id] == packet_id }
-      }
+      end
       MQTT_ERR_SUCCESS
     end
 
     def config_all_message_queue
-      config_message_queue(@waiting_puback, @puback_mutex, MAX_PUBACK)
-      config_message_queue(@waiting_pubrec, @pubrec_mutex, MAX_PUBREC)
-      config_message_queue(@waiting_pubrel, @pubrel_mutex, MAX_PUBREL)
-      config_message_queue(@waiting_pubcomp, @pubcomp_mutex, MAX_PUBCOMP)
+      config_message_queue(@waiting_puback, @puback_mutex)
+      config_message_queue(@waiting_pubrec, @pubrec_mutex)
+      config_message_queue(@waiting_pubrel, @pubrel_mutex)
+      config_message_queue(@waiting_pubcomp, @pubcomp_mutex)
     end
 
-    def config_message_queue(queue, mutex, max_packet)
-      mutex.synchronize {
-        cnt = 0 
+    def config_message_queue(queue, mutex)
+      mutex.synchronize do
         queue.each do |pck|
-          pck[:packet].dup ||= true
-          if cnt <= max_packet
-            @sender.append_to_writing(pck[:packet])
-            cnt += 1
-          end
+          pck[:timestamp] = Time.now
         end
-      }
+      end
     end
 
     def check_waiting_publisher
-      @sender.check_ack_alive(@waiting_puback, @puback_mutex, MAX_PUBACK)
-      @sender.check_ack_alive(@waiting_pubrec, @pubrec_mutex, MAX_PUBREC)
-      @sender.check_ack_alive(@waiting_pubrel, @pubrel_mutex, MAX_PUBREL)
-      @sender.check_ack_alive(@waiting_pubcomp, @pubcomp_mutex, MAX_PUBCOMP)
+      @sender.check_ack_alive(@waiting_puback, @puback_mutex)
+      @sender.check_ack_alive(@waiting_pubrec, @pubrec_mutex)
+      @sender.check_ack_alive(@waiting_pubrel, @pubrel_mutex)
+      @sender.check_ack_alive(@waiting_pubcomp, @pubcomp_mutex)
     end
 
     def flush_publisher
-      @puback_mutex.synchronize {
+      @puback_mutex.synchronize do
         @waiting_puback = []
-      }
-      @pubrec_mutex.synchronize {
+      end
+      @pubrec_mutex.synchronize do
         @waiting_pubrec = []
-      }
-      @pubrel_mutex.synchronize {
+      end
+      @pubrel_mutex.synchronize do
         @waiting_pubrel = []
-      }
-      @pubcomp_mutex.synchronize {
+      end
+      @pubcomp_mutex.synchronize do
         @waiting_pubcomp = []
-      }
+      end
     end
   end
 end