paho-mqtt 1.0.11 → 1.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36bc2ea31aa16b29dd3630d0d5db7b1e21b9723ce208d5234c0cde283cdf26e4
-  data.tar.gz: 2baf2f376e7be26234ea7a6e94c662648a75442022c080dc76df7fd6bfa9c5e8
+  metadata.gz: 3b12b2ca9e37d486f259e998a800d9bb792aaf32bade2d542bfb1f65cddb7eed
+  data.tar.gz: d2526058c6647dcc29b694240074c17f1ba23153a4834002620da00fe0ca8618
 SHA512:
-  metadata.gz: 5293b974ec90097bf707b6d14870d6347c704a4a7da0622c63fe0cfba6591536b19673804d68726b2b0b2e77496a654caaddd8aa47cb5f6cfe58e2ce501979f7
-  data.tar.gz: f6f1f6c5c6f2659399cd70566b6af1d80606cdff9ee1c8fde8645799943a0b8a0d7c9608f8842d56cef8a9d885d42c0deb8fc5fcee875498b3da962fe4284c67
+  metadata.gz: 6e406280a8134c6ba1f6dfe4a308300bccfd5f724d6b9b1f6dcdee0dc39b038855ba49d9d8c810c552d3563f2af6f2e141e246579307819dcaaec39128fa8f79
+  data.tar.gz: 3d2733b63c3665ebf1c81636f7e056a72034b8dc3016413df9c3f4175f5a57b102b10edc680ab83283cc88d0fa2e361c9d1698bf754d608781730632642d5658

data/lib/paho-mqtt.rb

@@ -32,12 +32,8 @@ module PahoMqtt
   # MAX size of queue
   MAX_SUBACK   = 10
   MAX_UNSUBACK = 10
-  MAX_PUBACK   = 100
-  MAX_PUBREC   = 100
-  MAX_PUBREL   = 100
   MAX_PUBLISH  = 1000
-  MAX_PUBCOMP  = 100
-  MAX_QUEUE    = MAX_PUBACK + MAX_PUBREC + MAX_PUBREL + MAX_PUBCOMP
+  MAX_QUEUE    = 1000
 
   # Connection states values
   MQTT_CS_NEW        = 0

data/lib/paho_mqtt/client.rb

@@ -112,9 +112,10 @@ module PahoMqtt
       end
       @mqtt_thread.kill unless @mqtt_thread.nil?
 
-      init_connection
+      init_connection unless reconnect?
       @connection_helper.send_connect(session_params)
       begin
+        init_pubsub
         @connection_state = @connection_helper.do_connect(reconnect?)
         if connected?
           build_pubsub
@@ -168,6 +169,8 @@ module PahoMqtt
           result = @handler.receive_packet
           break if result.nil?
         end
+      rescue FullQueueException
+        PahoMqtt.logger.warn("Early exit in reading loop. The maximum packets have been reach for #{packet.type_name}") if PahoMqtt.logger?
       rescue ReadingException
         if check_persistence
           reconnect
@@ -213,11 +216,14 @@ module PahoMqtt
     end
 
     def disconnect(explicit=true)
-      @last_packet_id = 0 if explicit
       @connection_helper.do_disconnect(@publisher, explicit, @mqtt_thread)
       @connection_state_mutex.synchronize do
         @connection_state = MQTT_CS_DISCONNECT
       end
+      if explicit && @clean_session
+        @last_packet_id = 0
+        @subscriber.clear_queue
+      end
       MQTT_ERR_SUCCESS
     end
 
@@ -368,30 +374,22 @@ module PahoMqtt
       end
     end
 
-    def build_pubsub
-      if @subscriber.nil?
-        @subscriber = Subscriber.new(@sender)
-      else
-        @subscriber.sender = @sender
-        @subscriber.config_subscription(next_packet_id)
-      end
-      if @publisher.nil?
-        @publisher = Publisher.new(@sender)
-      else
-        @publisher.sender = @sender
-        @sender.flush_waiting_packet
-        @publisher.config_all_message_queue
-      end
+    def init_pubsub
+      @subscriber.nil? ? @subscriber = Subscriber.new(@sender) : @subscriber.sender = @sender
+      @publisher.nil? ? @publisher = Publisher.new(@sender) : @publisher.sender = @sender
       @handler.config_pubsub(@publisher, @subscriber)
     end
 
+    def build_pubsub
+      @subscriber.config_subscription(next_packet_id)
+      @sender.flush_waiting_packet
+      @publisher.config_all_message_queue
+    end
+
     def init_connection
-      unless reconnect?
-        @connection_helper         = ConnectionHelper.new(@host, @port, @ssl, @ssl_context, @ack_timeout)
-        @connection_helper.handler = @handler
-        @sender                    = @connection_helper.sender
-      end
-      @connection_helper.setup_connection
+      @connection_helper         = ConnectionHelper.new(@host, @port, @ssl, @ssl_context, @ack_timeout)
+      @connection_helper.handler = @handler
+      @sender                    = @connection_helper.sender
     end
 
     def session_params

data/lib/paho_mqtt/connection_helper.rb

@@ -63,7 +63,7 @@ module PahoMqtt
     end
 
     def explicit_disconnect(publisher, mqtt_thread)
-      @sender.flush_waiting_packet
+      @sender.flush_waiting_packet(false)
       send_disconnect
       mqtt_thread.kill if mqtt_thread && mqtt_thread.alive?
       publisher.flush_publisher unless publisher.nil?
@@ -81,14 +81,14 @@ module PahoMqtt
       PahoMqtt.logger.debug("Attempt to connect to host: #{@host}...") if PahoMqtt.logger?
       begin
         tcp_socket = TCPSocket.new(@host, @port)
+        if @ssl
+          encrypted_socket(tcp_socket, @ssl_context)
+        else
+          @socket = tcp_socket
+        end
       rescue StandardError
         PahoMqtt.logger.warn("Could not open a socket with #{@host} on port #{@port}.") if PahoMqtt.logger?
       end
-      if @ssl
-        encrypted_socket(tcp_socket, @ssl_context)
-      else
-        @socket = tcp_socket
-      end
     end
 
     def encrypted_socket(tcp_socket, ssl_context)

data/lib/paho_mqtt/exception.rb

@@ -46,4 +46,7 @@ module PahoMqtt
 
   class FullQueueException < Exception
   end
+
+  class NotSupportedEncryptionException < Exception
+  end
 end

data/lib/paho_mqtt/publisher.rb

@@ -39,28 +39,28 @@ module PahoMqtt
         :retain  => retain,
         :qos     => qos
       )
-      case qos
-      when 1
-        push_queue(@waiting_puback, @puback_mutex, MAX_PUBACK, packet, new_id)
-      when 2
-        push_queue(@waiting_pubrec, @pubrec_mutex, MAX_PUBREC, packet, new_id)
+      begin
+        case qos
+        when 1
+          push_queue(@waiting_puback, @puback_mutex, MAX_QUEUE, packet, new_id)
+        when 2
+          push_queue(@waiting_pubrec, @pubrec_mutex, MAX_QUEUE, packet, new_id)
+        end
+      rescue FullQueueException
+        PahoMqtt.logger.warn("PUBLISH queue is full, waiting for publishing #{packet.inspect}") if PahoMqtt.logger?
+        sleep SELECT_TIMEOUT
+        retry
       end
       @sender.append_to_writing(packet)
       MQTT_ERR_SUCCESS
     end
 
     def push_queue(waiting_queue, queue_mutex, max_packet, packet, new_id)
-      begin
-        if waiting_queue.length >= max_packet
-          raise FullQueueException
-        end
-        queue_mutex.synchronize do
-          waiting_queue.push(:id => new_id, :packet => packet, :timestamp => Time.now)
-        end
-      rescue FullQueueException
-        PahoMqtt.logger.error("#{packet.type_name} queue is full") if PahoMqtt.logger?
-        sleep SELECT_TIMEOUT
-        retry
+      if waiting_queue.length >= max_packet
+        raise FullQueueException
+      end
+      queue_mutex.synchronize do
+        waiting_queue.push(:id => new_id, :packet => packet, :timestamp => Time.now)
       end
       MQTT_ERR_SUCCESS
     end
@@ -98,7 +98,7 @@ module PahoMqtt
       packet = PahoMqtt::Packet::Pubrec.new(
         :id => packet_id
       )
-      push_queue(@waiting_pubrel, @pubrel_mutex, MAX_PUBREL, packet, packet_id)
+      push_queue(@waiting_pubrel, @pubrel_mutex, MAX_QUEUE, packet, packet_id)
       @sender.append_to_writing(packet)
       MQTT_ERR_SUCCESS
     end
@@ -114,7 +114,7 @@ module PahoMqtt
       packet = PahoMqtt::Packet::Pubrel.new(
         :id => packet_id
       )
-      push_queue(@waiting_pubcomp, @pubcomp_mutex, MAX_PUBCOMP, packet, packet_id)
+      push_queue(@waiting_pubcomp, @pubcomp_mutex, MAX_QUEUE, packet, packet_id)
       @sender.append_to_writing(packet)
       MQTT_ERR_SUCCESS
     end

data/lib/paho_mqtt/sender.rb

@@ -61,8 +61,7 @@ module PahoMqtt
 
     def append_to_writing(packet)
       begin
-        case packet
-        when packet.is_a?(PahoMqtt::Packet::Publish)
+        if packet.is_a?(PahoMqtt::Packet::Publish)
           prepare_sending(@publish_queue, @publish_mutex, MAX_PUBLISH, packet)
         else
           prepare_sending(@writing_queue, @writing_mutex, MAX_QUEUE, packet)
@@ -95,13 +94,18 @@ module PahoMqtt
     def flush_waiting_packet(sending=true)
       if sending
         @writing_mutex.synchronize do
-          @writing_queue.each do |m|
-            send_packet(m)
+          @writing_queue.each do |packet|
+            send_packet(packet)
+          end
+        end
+        @publish_mutex.synchronize do
+          @publish_queue.each do |packet|
+            send_packet(packet)
           end
         end
-      else
-        @writing_queue = []
       end
+      @writing_queue = []
+      @publish_queue = []
     end
 
     def check_ack_alive(queue, mutex)
@@ -110,7 +114,8 @@ module PahoMqtt
         queue.each do |pck|
           if now >= pck[:timestamp] + @ack_timeout
             pck[:packet].dup ||= true unless pck[:packet].class == PahoMqtt::Packet::Subscribe || pck[:packet].class == PahoMqtt::Packet::Unsubscribe
-            append_to_writing(pck[:packet])
+            PahoMqtt.logger.info("Acknowledgement timeout is over, resending #{pck[:packet].inspect}") if PahoMqtt.logger?
+            send_packet(pck[:packet])
             pck[:timestamp] = now
           end
         end

data/lib/paho_mqtt/ssl_helper.rb

@@ -18,21 +18,40 @@ module PahoMqtt
   module SSLHelper
     extend self
 
-    def config_ssl_context(cert_path, key_path, ca_path=nil)
+    def config_ssl_context(cert_path=nil, key_path=nil, ca_path=nil)
       ssl_context = OpenSSL::SSL::SSLContext.new
       set_cert(cert_path, ssl_context)
       set_key(key_path, ssl_context)
       set_root_ca(ca_path, ssl_context)
-      #ssl_context.verify_mode = OpenSSL::SSL::VERIFY_PEER unless ca_path.nil?
+      # ssl_context.verify_mode = OpenSSL::SSL::VERIFY_PEER unless ca_path.nil?
       ssl_context
     end
 
-    def set_cert(cert_path, ssl_context)
-      ssl_context.cert = OpenSSL::X509::Certificate.new(File.read(cert_path))
+    def set_cert(cert_path=nil, ssl_context)
+      unless cert_path.nil?
+        ssl_context.cert = OpenSSL::X509::Certificate.new(File.read(cert_path))
+      end
     end
 
-    def set_key(key_path, ssl_context)
-      ssl_context.key = OpenSSL::PKey::RSA.new(File.read(key_path))
+    def set_key(key_path=nil, ssl_context)
+      unless key_path.nil?
+        return MQTT_ERR_SUCCESS if try_rsa_key(key_path, ssl_context) == MQTT_ERR_SUCCESS
+        begin
+          ssl_context.key = OpenSSL::PKey::EC.new(File.read(key_path))
+          return MQTT_ERR_SUCCESS
+        rescue OpenSSL::PKey::ECError
+          raise NotSupportedEncryptionException.new("Could not support the type of the provided key (supported: RSA and EC)")
+        end
+      end
+    end
+
+    def try_rsa_key(key_path, ssl_context)
+      begin
+        ssl_context.key = OpenSSL::PKey::RSA.new(File.read(key_path))
+        return MQTT_ERR_SUCCESS
+      rescue OpenSSL::PKey::RSAError
+        return MQTT_ERR_FAIL
+      end
     end
 
     def set_root_ca(ca_path, ssl_context)

data/lib/paho_mqtt/subscriber.rb

@@ -47,7 +47,7 @@ module PahoMqtt
           end
           @waiting_suback.push(:id => new_id, :packet => packet, :timestamp => Time.now)
         end
-        @sender.send_packet(packet)
+        @sender.append_to_writing(packet)
       end
       MQTT_ERR_SUCCESS
     end
@@ -143,6 +143,10 @@ module PahoMqtt
       @sender.check_ack_alive(@waiting_unsuback, @unsuback_mutex)
     end
 
+    def clear_queue
+      @waiting_suback = []
+    end
+
     def valid_topics?(topics)
       unless topics.length == 0
         topics.map do |topic|

data/lib/paho_mqtt/version.rb

@@ -1,3 +1,3 @@
 module PahoMqtt
-  VERSION = "1.0.11"
+  VERSION = "1.0.12"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paho-mqtt
 version: !ruby/object:Gem::Version
-  version: 1.0.11
+  version: 1.0.12
 platform: ruby
 authors:
 - Pierre Goudet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-22 00:00:00.000000000 Z
+date: 2018-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler