paho-mqtt 1.0.7 → 1.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af6f895ced3d30a8d24b38852cd3057dbeb25a483ace1d57d5b4ed02b0d0c863
-  data.tar.gz: 61e56c02727c3bfac306e23615cc94bdd549e920ab49fd53cea4c06d1815ca67
+  metadata.gz: f39a0f32404a6bd397f11413d0ac5630ac629dca3821bde3a8213e59f2f458ac
+  data.tar.gz: a3a47027e5ff76e97dfc3ea32479b0149eb7be1683e901b80b6021a2478d5d4d
 SHA512:
-  metadata.gz: ebe282a5693db9866c5397d75b4d1a39b142b61566ac09d61fa1820db33af4bf36489c55d93c9abe11cbd8ee9c79466bfbdba9ab6225e5ed55e21858b7e011b7
-  data.tar.gz: '0854c7eec6abf060a0e3334874da9587c28c404d861abe424d7d33fa4cbda8b4cf32908396d0c0c8fa3038bff28cedceb937fa9ed19db8e1539e954c2616cfdd'
+  metadata.gz: 926e0d70043c9cc1b60fbaceec3c354c3d48f632aac6d92d22b7662d220f90ca4a1bc1a753cb16e9571128201de253a69388f86ca224caae0f5ac09709de97a9
+  data.tar.gz: cf753442885c0005ededac63b1517ebe51b10e74725429f834ab4a65cb0710fdf8e83ba9cec4272e7e91c79a470080eba26a31c09e05f838743f978d1b056b42

data/README.md

@@ -111,15 +111,17 @@ client = PahoMqtt::Client.new({host: "iot.eclispe.org", port: 1883, ssl: false})
 The client has many accessors which help to configure the client depending on user's need. The different accessors could be splited in four roles, connection setup, last will setup, time-out setup and callback setup.
 Connection setup:
 ```
-* host          : The endpoint where the client would try to connect (defaut "")
-* port          : The port on the remote host where the socket would try to connect (default 1883)
-* mqtt_version  : The version of MQTT protocol used to communication (default 3.1.1)
-* clean_session : If set to false, ask the message broker to try to restore the previous session (default true)
-* persistent    : Keep the client connected even after keep alive timer run out, automatically try to reconnect on failure (default false)
-* client_id     : The identifier of the client (default nil)
-* username      : The username if the server require authentication (default nil)
-* password      : The password of the user if authentication required (default nil)
-* ssl           : Requiring the encryption for the communication (default false)
+* host            : The endpoint where the client would try to connect (defaut "")
+* port            : The port on the remote host where the socket would try to connect (default 1883)
+* mqtt_version    : The version of MQTT protocol used to communication (default 3.1.1)
+* clean_session   : If set to false, ask the message broker to try to restore the previous session (default true)
+* persistent      : Keep the client connected even after keep alive timer run out, automatically try to reconnect on failure (default false)
+* reconnect_limit : If persistent mode is enabled, the maximum reconnect attempt (default 3)
+* reconnect_delay : If persistent mode is enabled, the delay between to reconnection attempt in second (default 5)
+* client_id       : The identifier of the client (default nil)
+* username        : The username if the server require authentication (default nil)
+* password        : The password of the user if authentication required (default nil)
+* ssl             : Requiring the encryption for the communication (default false)
 ```
 
 Last Will:
@@ -186,7 +188,6 @@ client.connect("test.mosquitto.org", 8884)
 ### Persistence
 The client holds a keep_alive timer is the reference time that the connection should be held. The timer is reset every time a new valid packet is received from the message broker. The persistence flag, when set to True, enables the client to be more independent from the keep_alive timer. Just before the keep_alive run out, the client sends a ping request to tell to the message broker that the connection should be kept. The persistent mode also enables the client to automatically reconnect to the message broker after an unexpected failure.  
 When the client's persistence flag is set to False, it just simply disconnects when the keep_alive timer runs out.  
-
 ```ruby
 ### This will connect to the message broker, keep connected and automatically reconnect on failure
 client.connect('iot.eclipse.org', 1883, client.keep_alive, true, client.blocking)
@@ -194,6 +195,7 @@ client.connect('iot.eclipse.org', 1883, client.keep_alive, true, client.blocking
 ### This only connect to the message broker, disconnect after keep_alive or on failure
 client.connect('iot.eclipse.org', 1883, client.keep_alive, false, client.blocking)
 ```
+The client has two attributes `@reconnect_limit` and `@reconnect_delay` which configure the reconnection process. `@reconnection_limit` is the maximum reconnection attempt that a client could try and `@reconnection_delay` is the delay that the client waits between two reconnection attempt. Setting the `@reconnect_limit` to -1 would run the reconnection process forever. 
 
 ### Foreground and Daemon
 The client could be connected to the message broker using the main thread in foreground or as a daemon in a separate thread. The default mode is daemon mode, the daemon would run in the background the read/write operation as well as the control of the timers. If the client is connected using the main thread, all control operations are left to the user, using the different control loops. There are four different loop roles is detailed in the next part.

data/lib/paho-mqtt.rb

@@ -14,38 +14,38 @@
 
 require "paho_mqtt/version"
 require "paho_mqtt/client"
+require "paho_mqtt/exception"
 require "paho_mqtt/packet"
 require 'logger'
 
 module PahoMqtt
   extend self
-
   attr_accessor :logger
 
   # Default connection setup
-  DEFAULT_SSL_PORT = 8883
-  DEFAULT_PORT = 1883
-  SELECT_TIMEOUT = 0
-  LOOP_TEMPO = 0.005
-  RECONNECT_RETRY_TIME = 3
-  RECONNECT_RETRY_TEMPO = 5
+  DEFAULT_SSL_PORT      = 8883
+  DEFAULT_PORT          = 1883
+  SELECT_TIMEOUT        = 0
+  LOOP_TEMPO            = 0.005
 
   # MAX size of queue
-  MAX_READ = 10
-  MAX_PUBACK = 20
-  MAX_PUBREC = 20
-  MAX_PUBREL = 20
-  MAX_PUBCOMP = 20
-  MAX_WRITING = MAX_PUBACK + MAX_PUBREC + MAX_PUBREL  + MAX_PUBCOMP 
+  MAX_SUBACK   = 10
+  MAX_UNSUBACK = 10
+  MAX_READ     = 50
+  MAX_PUBACK   = 100
+  MAX_PUBREC   = 100
+  MAX_PUBREL   = 100
+  MAX_PUBCOMP  = 100
+  MAX_WRITING  = MAX_PUBACK + MAX_PUBREC + MAX_PUBREL  + MAX_PUBCOMP
 
   # Connection states values
-  MQTT_CS_NEW = 0
-  MQTT_CS_CONNECTED = 1
+  MQTT_CS_NEW        = 0
+  MQTT_CS_CONNECTED  = 1
   MQTT_CS_DISCONNECT = 2
 
   # Error values
   MQTT_ERR_SUCCESS = 0
-  MQTT_ERR_FAIL = 1
+  MQTT_ERR_FAIL    = 1
 
   PACKET_TYPES = [
     nil,
@@ -74,40 +74,40 @@ module PahoMqtt
   }
 
   CLIENT_ATTR_DEFAULTS = {
-      :host => "",
-      :port => nil,
-      :mqtt_version => '3.1.1',
+      :host          => "",
+      :port          => nil,
+      :mqtt_version  => '3.1.1',
       :clean_session => true,
-      :persistent => false,
-      :blocking => false,
-      :client_id => nil,
-      :username => nil,
-      :password => nil,
-      :ssl => false,
-      :will_topic => nil,
-      :will_payload => nil,
-      :will_qos => 0,
-      :will_retain => false,
-      :keep_alive => 60,
-      :ack_timeout => 5,
-      :on_connack => nil,
-      :on_suback => nil,
-      :on_unsuback => nil,
-      :on_puback => nil,
-      :on_pubrel => nil,
-      :on_pubrec => nil,
-      :on_pubcomp => nil,
-      :on_message => nil,
+      :persistent    => false,
+      :blocking      => false,
+      :client_id     => nil,
+      :username      => nil,
+      :password      => nil,
+      :ssl           => false,
+      :will_topic    => nil,
+      :will_payload  => nil,
+      :will_qos      => 0,
+      :will_retain   => false,
+      :keep_alive    => 60,
+      :ack_timeout   => 5,
+      :on_connack    => nil,
+      :on_suback     => nil,
+      :on_unsuback   => nil,
+      :on_puback     => nil,
+      :on_pubrel     => nil,
+      :on_pubrec     => nil,
+      :on_pubcomp    => nil,
+      :on_message    => nil,
   }
-    
+
   Thread.abort_on_exception = true
 
   def logger=(logger_path)
-    file = File.open(logger_path, "a+")
-    file.sync = true
-    log_file = Logger.new(file)
+    file           = File.open(logger_path, "a+")
+    file.sync      = true
+    log_file       = Logger.new(file)
     log_file.level = Logger::DEBUG
-    @logger = log_file
+    @logger        = log_file
   end
 
   def logger
@@ -162,22 +162,4 @@ module PahoMqtt
       raise ArgumentError
     end
   end
-
-  class Exception < ::Exception
-  end
-
-  class ProtocolViolation < PahoMqtt::Exception
-  end
-
-  class WritingException < PahoMqtt::Exception
-  end
-
-  class ReadingException < PahoMqtt::Exception
-  end
-
-  class PacketException < PahoMqtt::Exception
-  end
-
-  class LowVersionException < PahoMqtt::Exception
-  end
 end

data/lib/paho_mqtt/client.rb

@@ -27,6 +27,8 @@ module PahoMqtt
     attr_accessor :mqtt_version
     attr_accessor :clean_session
     attr_accessor :persistent
+    attr_accessor :reconnect_limit
+    attr_accessor :reconnect_delay
     attr_accessor :blocking
     attr_accessor :client_id
     attr_accessor :username
@@ -48,17 +50,19 @@ module PahoMqtt
     attr_reader :ssl_context
 
     def initialize(*args)
-      @last_ping_resp = Time.now
-      @last_packet_id = 0
-      @ssl_context = nil
-      @sender = nil
-      @handler = Handler.new
-      @connection_helper = nil
-      @connection_state = MQTT_CS_DISCONNECT
+      @last_ping_resp         = Time.now
+      @last_packet_id         = 0
+      @ssl_context            = nil
+      @sender                 = nil
+      @handler                = Handler.new
+      @connection_helper      = nil
+      @connection_state       = MQTT_CS_DISCONNECT
       @connection_state_mutex = Mutex.new
-      @mqtt_thread = nil
-      @reconnect_thread = nil
-      @id_mutex = Mutex.new
+      @mqtt_thread            = nil
+      @reconnect_thread       = nil
+      @id_mutex               = Mutex.new
+      @reconnect_limit        = 3
+      @reconnect_delay        = 5
 
       if args.last.is_a?(Hash)
         attr = args.pop
@@ -99,14 +103,15 @@ module PahoMqtt
 
     def connect(host=@host, port=@port, keep_alive=@keep_alive, persistent=@persistent, blocking=@blocking)
       @persistent = persistent
-      @blocking = blocking
-      @host = host
-      @port = port.to_i
+      @blocking   = blocking
+      @host       = host
+      @port       = port.to_i
       @keep_alive = keep_alive
-      @connection_state_mutex.synchronize {
+      @connection_state_mutex.synchronize do
         @connection_state = MQTT_CS_NEW
-      }
+      end
       @mqtt_thread.kill unless @mqtt_thread.nil?
+
       init_connection
       @connection_helper.send_connect(session_params)
       begin
@@ -129,7 +134,7 @@ module PahoMqtt
           end
         rescue SystemCallError => e
           if @persistent
-            reconnect()
+            reconnect
           else
             raise e
           end
@@ -188,17 +193,19 @@ module PahoMqtt
 
     def reconnect
       @reconnect_thread = Thread.new do
-        RECONNECT_RETRY_TIME.times do
-          PahoMqtt.logger.debug("New reconnect atempt...") if PahoMqtt.logger?
+        counter = 0
+        while (@reconnect_limit >= counter || @reconnect_limit == -1) do
+          counter += 1
+          PahoMqtt.logger.debug("New reconnect attempt...") if PahoMqtt.logger?
           connect
           if connected?
             break
           else
-            sleep RECONNECT_RETRY_TIME
+            sleep @reconnect_delay
           end
         end
         unless connected?
-          PahoMqtt.logger.error("Reconnection atempt counter is over.(#{RECONNECT_RETRY_TIME} times)") if PahoMqtt.logger?
+          PahoMqtt.logger.error("Reconnection attempt counter is over. (#{@reconnect_limit} times)") if PahoMqtt.logger?
           disconnect(false)
         end
       end
@@ -207,9 +214,9 @@ module PahoMqtt
     def disconnect(explicit=true)
       @last_packet_id = 0 if explicit
       @connection_helper.do_disconnect(@publisher, explicit, @mqtt_thread)
-      @connection_state_mutex.synchronize {
+      @connection_state_mutex.synchronize do
         @connection_state = MQTT_CS_DISCONNECT
-      }
+      end
       MQTT_ERR_SUCCESS
     end
 
@@ -220,7 +227,6 @@ module PahoMqtt
       end
       id = next_packet_id
       @publisher.send_publish(topic, payload, retain, qos, id)
-      MQTT_ERR_SUCCESS
     end
 
     def subscribe(*topics)
@@ -245,7 +251,7 @@ module PahoMqtt
         end
         MQTT_ERR_SUCCESS
       rescue ProtocolViolation
-        PahoMqtt.logger.error("Unsubscribe need at least one topics.") if PahoMqtt.logger?
+        PahoMqtt.logger.error("Unsubscribe need at least one topic.") if PahoMqtt.logger?
         disconnect(false)
         raise ProtocolViolation
       end
@@ -347,18 +353,18 @@ module PahoMqtt
     private
 
     def next_packet_id
-      @id_mutex.synchronize {
-        @last_packet_id = ( @last_packet_id || 0 ).next
-      }
+      @id_mutex.synchronize do
+        @last_packet_id = (@last_packet_id || 0).next
+      end
     end
 
     def downgrade_version
-      PahoMqtt.logger.debug("Unable to connect to the server with the version #{@mqtt_version}, trying 3.1") if PahoMqtt.logger?
+      PahoMqtt.logger.debug("Connection refused: unacceptable protocol version #{@mqtt_version}, trying 3.1") if PahoMqtt.logger?
       if @mqtt_version != "3.1"
         @mqtt_version = "3.1"
         connect(@host, @port, @keep_alive)
       else
-        raise "Unsupported MQTT version"
+        raise ProtocolVersionException.new("Unsupported MQTT version")
       end
     end
 
@@ -373,32 +379,34 @@ module PahoMqtt
         @publisher = Publisher.new(@sender)
       else
         @publisher.sender = @sender
+        @sender.flush_waiting_packet
         @publisher.config_all_message_queue
       end
       @handler.config_pubsub(@publisher, @subscriber)
-      @sender.flush_waiting_packet(true)
     end
 
     def init_connection
       unless reconnect?
-        @connection_helper = ConnectionHelper.new(@host, @port, @ssl, @ssl_context, @ack_timeout)
+        @connection_helper         = ConnectionHelper.new(@host, @port, @ssl, @ssl_context, @ack_timeout)
         @connection_helper.handler = @handler
-        @sender = @connection_helper.sender
+        @sender                    = @connection_helper.sender
       end
-        @connection_helper.setup_connection
+      @connection_helper.setup_connection
     end
 
     def session_params
-      {:version => @mqtt_version,
-       :clean_session => @clean_session,
-       :keep_alive => @keep_alive,
-       :client_id => @client_id,
-       :username => @username,
-       :password => @password,
-       :will_topic => @will_topic,
-       :will_payload => @will_payload,
-       :will_qos => @will_qos,
-       :will_retain => @will_retain}
+      {
+        :version       => @mqtt_version,
+        :clean_session => @clean_session,
+        :keep_alive    => @keep_alive,
+        :client_id     => @client_id,
+        :username      => @username,
+        :password      => @password,
+        :will_topic    => @will_topic,
+        :will_payload  => @will_payload,
+        :will_qos      => @will_qos,
+        :will_retain   => @will_retain
+      }
     end
 
     def check_persistence

data/lib/paho_mqtt/connection_helper.rb

@@ -20,14 +20,14 @@ module PahoMqtt
     attr_accessor :sender
 
     def initialize(host, port, ssl, ssl_context, ack_timeout)
-      @cs = MQTT_CS_DISCONNECT
-      @socket = nil
-      @host = host
-      @port = port
-      @ssl = ssl
+      @cs          = MQTT_CS_DISCONNECT
+      @socket      = nil
+      @host        = host
+      @port        = port
+      @ssl         = ssl
       @ssl_context = ssl_context
       @ack_timeout = ack_timeout
-      @sender = Sender.new(ack_timeout)
+      @sender      = Sender.new(ack_timeout)
     end
 
     def handler=(handler)
@@ -39,12 +39,12 @@ module PahoMqtt
       @handler.socket = @socket
       # Waiting a Connack packet for "ack_timeout" second from the remote
       connect_timeout = Time.now + @ack_timeout
-      while (Time.now <= connect_timeout) && (!is_connected?) do
+      while (Time.now <= connect_timeout) && !is_connected? do
         @cs = @handler.receive_packet
         sleep 0.0001
       end
       unless is_connected?
-        PahoMqtt.logger.warn("Connection failed. Couldn't recieve a Connack packet from: #{@host}, socket is \"#{@socket}\".") if PahoMqtt.logger?
+        PahoMqtt.logger.warn("Connection failed. Couldn't recieve a Connack packet from: #{@host}.") if PahoMqtt.logger?
         raise Exception.new("Connection failed. Check log for more details.") unless reconnection
       end
       @cs
@@ -55,7 +55,7 @@ module PahoMqtt
     end
 
     def do_disconnect(publisher, explicit, mqtt_thread)
-      PahoMqtt.logger.debug("Disconnecting from #{@host}") if PahoMqtt.logger?
+      PahoMqtt.logger.debug("Disconnecting from #{@host}.") if PahoMqtt.logger?
       if explicit
         explicit_disconnect(publisher, mqtt_thread)
       end
@@ -79,11 +79,11 @@ module PahoMqtt
     end
 
     def config_socket
-      PahoMqtt.logger.debug("Atempt to connect to host: #{@host}") if PahoMqtt.logger?
+      PahoMqtt.logger.debug("Attempt to connect to host: #{@host}...") if PahoMqtt.logger?
       begin
         tcp_socket = TCPSocket.new(@host, @port)
       rescue StandardError
-        PahoMqtt.logger.warn("Could not open a socket with #{@host} on port #{@port}") if PahoMqtt.logger?
+        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)
@@ -98,7 +98,7 @@ module PahoMqtt
         @socket.sync_close = true
         @socket.connect
       else
-        PahoMqtt.logger.error("The ssl context was found as nil while the socket's opening.") if PahoMqtt.logger?
+        PahoMqtt.logger.error("The SSL context was found as nil while the socket's opening.") if PahoMqtt.logger?
         raise Exception
       end
     end
@@ -149,17 +149,17 @@ module PahoMqtt
       @sender.send_packet(packet)
       MQTT_ERR_SUCCESS
     end
- 
+
     def check_keep_alive(persistent, last_ping_resp, keep_alive)
       now = Time.now
       timeout_req = (@sender.last_ping_req + (keep_alive * 0.7).ceil)
       if timeout_req <= now && persistent
-        PahoMqtt.logger.debug("Checking if server is still alive.") if PahoMqtt.logger?
+        PahoMqtt.logger.debug("Checking if server is still alive...") if PahoMqtt.logger?
         send_pingreq
       end
       timeout_resp = last_ping_resp + (keep_alive * 1.1).ceil
       if timeout_resp <= now
-        PahoMqtt.logger.debug("No activity period over timeout, disconnecting from #{@host}") if PahoMqtt.logger?
+        PahoMqtt.logger.debug("No activity period over timeout, disconnecting from #{@host}.") if PahoMqtt.logger?
         @cs = MQTT_CS_DISCONNECT
       end
       @cs