paho-mqtt 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 777754009990c745ded4b02654a54bc26a2e422d
-  data.tar.gz: 0e92fba78c0e1938db874d2faed6bee9ef52890c
+  metadata.gz: 5f334ef3126b1f0def40579e6f202200d3dacfc3
+  data.tar.gz: 9ef4eb0748507a6b744f82011a9da894f909624e
 SHA512:
-  metadata.gz: ee45850a33868e480871d6cf7b50bd8277a9a1d1d81e634341a64548d69c77b5145fa49d4ccd1524be6b4358af7ace9414222f3a074d796b9ebe85ee8d97a7a3
-  data.tar.gz: b295155a5598e8f410b61a4591df6024133e2d9125364d27aa47a4aff10fb308d7ac9c4ac1a7cc8161d5afd5c122ee6b964372c692cba3be7820509426d86866
+  metadata.gz: 412649a90228d742ba6812d77924f74559d759199ed1258f9095a9b1e80d759979bc0ceb64065cf11d73a6c4b1b9294102ccd690b7c9ca2d42f695d3c29b86b5
+  data.tar.gz: 3533ef2b3774a816a66827341a14aebd4d70534cf08888881ac619f072b9aa09ab7700cc28ba406a8bcffe0a9f3bdf02e66d8c045289a386d31ef2930b6734a3

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require "bundler/setup"
-require "PahoMqttRuby"
+require "paho-mqtt"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.

data/lib/paho-mqtt.rb

@@ -3,5 +3,43 @@ require "paho.mqtt/paho_client"
 require "paho.mqtt/packet_manager"
 
 module PahoMqtt
-  # Your code goes here...
+
+  # 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
+
+  # MAX size of queue
+  MAX_PUBACK = 20
+  MAX_PUBREC = 20
+  MAX_PUBREL = 20
+  MAX_PUBCOMP = 20
+  MAX_WRITING = MAX_PUBACK + MAX_PUBREC + MAX_PUBREL  + MAX_PUBCOMP 
+    
+  # Connection states values
+  MQTT_CS_NEW = 0
+  MQTT_CS_CONNECTED = 1
+  MQTT_CS_DISCONNECT = 2
+  MQTT_CS_CONNECT_ASYNC = 3
+  
+  # Error values
+  MQTT_ERR_SUCCESS = 0
+  MQTT_ERR_FAIL = 1
+
+  Thread.abort_on_exception = true
+  
+  class Exception < ::Exception
+  end
+
+  class ProtocolViolation < PahoMqtt::Exception
+  end
+
+  class ParameterException < PahoMqtt::Exception
+  end
+
+  class PacketException < PahoMqtt::Exception
+  end
 end

data/lib/paho.mqtt/paho_client.rb

@@ -1,45 +1,11 @@
 require 'openssl'
 require 'socket'
+require 'logger'
 
 module PahoMqtt
-  DEFAULT_SSL_PORT = 8883
-  DEFAULT_PORT = 1883
-  SELECT_TIMEOUT = 0
-  LOOP_TEMPO = 0.005
-  RECONNECT_RETRY_TIME = 3
-  RECONNECT_RETRY_TEMPO = 5
-
-  class Client
-    # MAX size of queue
-    MAX_PUBACK = 20
-    MAX_PUBREC = 20
-    MAX_PUBREL = 20
-    MAX_PUBCOMP = 20
-    MAX_WRITING = MAX_PUBACK + MAX_PUBREC + MAX_PUBREL  + MAX_PUBCOMP 
-    
-    # Connection states values
-    MQTT_CS_NEW = 0
-    MQTT_CS_CONNECTED = 1
-    MQTT_CS_DISCONNECT = 2
-    MQTT_CS_CONNECT_ASYNC = 3
-    
-    # Error values
-    MQTT_ERR_AGAIN = -1
-    MQTT_ERR_SUCCESS = 0
-    MQTT_ERR_NOMEM = 1
-    MQTT_ERR_PROTOCOL = 2
-    MQTT_ERR_INVAL = 3
-    MQTT_ERR_NO_CONN = 4
-    MQTT_ERR_CONN_REFUSED = 5
-    MQTT_ERR_NOT_FOUND = 6
-    MQTT_ERR_CONN_LOST = 7
-    MQTT_ERR_TLS = 8
-    MQTT_ERR_PAYLOAD_SIZE = 9
-    MQTT_ERR_NOT_SUPPORTED = 10
-    MQTT_ERR_AUTH = 11
-    MQTT_ERR_ACL_DENIED = 12
-    MQTT_ERR_UNKNOWN = 13
-    MQTT_ERR_ERRNO = 14
+  class Client    
+    # Log file
+    attr_accessor :logger
     
     # Connection related attributes:
     attr_accessor :host
@@ -78,6 +44,7 @@ module PahoMqtt
     attr_reader :connection_state
 
     ATTR_DEFAULTS = {
+      :logger => nil,
       :host => "",
       :port => nil,
       :mqtt_version => '3.1.1',
@@ -91,7 +58,7 @@ module PahoMqtt
       :will_payload => nil,
       :will_qos => 0,
       :will_retain => false,
-      :keep_alive => 10,
+      :keep_alive => 60,
       :ack_timeout => 5,
       :on_connack => nil,
       :on_suback => nil,
@@ -102,7 +69,7 @@ module PahoMqtt
       :on_pubcomp => nil,
       :on_message => nil,
     }
-
+    
     def initialize(*args)
       if args.last.is_a?(Hash)
         attr = args.pop
@@ -156,10 +123,6 @@ module PahoMqtt
       @client_id = prefix << Array.new(lenght) { charset.sample }.join
     end
 
-    def next_packet_id
-      @last_packet_id = ( @last_packet_id || 0 ).next
-    end
-
     def config_ssl_context(cert_path, key_path, ca_path=nil)
       @ssl ||= true
       @ssl_context = ssl_context
@@ -168,29 +131,6 @@ module PahoMqtt
       self.root_ca = ca_path
     end
 
-    def config_socket
-      unless @socket.nil?
-        @socket.close
-        @socket = nil
-      end
-
-      unless @host.nil? || @port < 0
-        tcp_socket = TCPSocket.new(@host, @port)
-      end
-
-      if @ssl
-        unless @ssl_context.nil?
-          @socket = OpenSSL::SSL::SSLSocket.new(tcp_socket, @ssl_context)
-          @socket.sync_close = true
-          @socket.connect
-        else
-          raise "SSL context should be defined and set to open SSLSocket"
-        end
-      else
-        @socket = tcp_socket
-      end
-    end
-
     def ssl_context
       @ssl_context ||= OpenSSL::SSL::SSLContext.new
     end
@@ -236,47 +176,6 @@ module PahoMqtt
       setup_connection
     end
 
-    def setup_connection
-      @mqtt_thread.kill unless @mqtt_thread.nil? 
-      if @host.nil? || @host == ""
-        raise "Connection Failed, host cannot be nil or empty"
-      end
-
-      if @port.to_i <= 0
-        raise "Connection Failed port cannot be 0 >="
-      end
-
-       @socket.close unless @socket.nil?
-       @socket = nil
-
-      @last_ping_req = Time.now
-      @last_ping_resp = Time.now
-
-      # TODO => MOVE TO LOGGER
-      #      puts "Try to connect to #{@host}"
-      config_socket
-      send_connect
-
-      # Waiting a Connack packet for "ack_timeout" second from the remote 
-      connect_timeout = Time.now + @ack_timeout
-      while (Time.now <= connect_timeout) && (@connection_state != MQTT_CS_CONNECTED) do
-        receive_packet
-      end
-
-      if @connection_state != MQTT_CS_CONNECTED
-      # TODO => MOVE TO LOGGER
-      # puts "Didn't receive Connack answer from server #{@host}"
-      else
-        config_subscription
-        config_all_message_queue
-        @mqtt_thread = Thread.new do
-          @reconnect_thread.kill unless @reconnect_thread.nil? || !@reconnect_thread.alive?
-          while @connection_state == MQTT_CS_CONNECTED do
-            mqtt_loop
-          end
-        end
-      end
-    end
     
     def loop_write(max_packet=MAX_WRITING)
       @writing_mutex.synchronize {
@@ -310,32 +209,12 @@ module PahoMqtt
       check_ack_alive(@waiting_suback, @suback_mutex, @waiting_suback.length)
       check_ack_alive(@waiting_unsuback, @unsuback_mutex, @waiting_unsuback.length)
     end
-    
-    def check_keep_alive
-      if @keep_alive >= 0 && @connection_state == MQTT_CS_CONNECTED
-        now = Time.now
-        timeout_req = (@last_ping_req + (@keep_alive * 0.7).ceil)
 
-        if timeout_req <= now && @persistent
-          send_pingreq
-          @last_ping_req = now
-        end
 
-        timeout_resp = @last_ping_resp + (@keep_alive * 1.1).ceil
-        if timeout_resp <= now
-          # TODO => MOVE TO LOGGER
-          #puts "Didn't get answer from server for a long time, trying to reconnect."
-          disconnect(false)
-          reconnect(RECONNECT_RETRY_TIME, RECONNECT_RETRY_TEMPO) if @persistent
-        end
-      end
-    end
-
-    def reconnect(retry_time=3, retry_tempo=3)
+    def reconnect(retry_time=RECONNECT_RETRY_TIME, retry_tempo=RECONNECT_RETRY_TEMPO)
       @reconnect_thread = Thread.new do
         retry_time.times do
-          # TODO => MOVE TO LOGGER
-          #puts "Retrying to connect"
+          @logger.debug("New reconnect atempt...") if @logger.is_a?(Logger)
           setup_connection
           if @connection_state == MQTT_CS_CONNECTED
             break
@@ -343,34 +222,155 @@ module PahoMqtt
             sleep retry_tempo
           end
         end
-        raise "Reconnection retry counter is over (#{RECONNECT_RETRY_TIME}), could not reconnect to the server."
+        if @connection_state != MQTT_CS_CONNECTED
+          @logger.error("Reconnection atempt counter is over.(#{RECONNECT_RETRY_TIME} times)") if @logger.is_a?(Logger)
+          disconnect(false)
+          exit
+        end
       end
     end
 
-    def check_ack_alive(queue, mutex, max_packet)
-      mutex.synchronize {
-        now = Time.now
-        cnt = 0
-        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
-            unless cnt > max_packet
-              append_to_writing(pck[:packet]) 
-              pck[:timestamp] = now
-              cnt += 1
-            end
-          end
-        end
+    def disconnect(explicit=true)
+      @logger.debug("Disconnecting from #{@host}") if @logger.is_a?(Logger)
+
+      if explicit
+        send_disconnect
+        @mqtt_thread.kill if @mqtt_thread && @mqtt_thread.alive?
+        @mqtt_thread.kill if @mqtt_thread.alive?
+        @last_packet_id = 0
+
+        @writing_mutex.synchronize {
+          @writing_queue = []
+        }
+
+        @puback_mutex.synchronize {
+          @waiting_puback = []
+        }
+
+        @pubrec_mutex.synchronize {
+          @waiting_pubrec = []
+        }
+
+        @pubrel_mutex.synchronize {
+          @waiting_pubrel = []
+        }
+
+        @pubcomp_mutex.synchronize {
+          @waiting_pubcomp = []
+        }
+      end
+
+      @socket.close unless @socket.nil?
+      @socket = nil
+
+      @connection_state_mutex.synchronize {
+        @connection_state = MQTT_CS_DISCONNECT
       }
+      MQTT_ERR_SUCCESS
+    end
+    
+    def publish(topic, payload="", retain=false, qos=0)
+      if topic == "" || !topic.is_a?(String)
+        @logger.error("Publish topics is invalid, not a string or empty.") if @logger.is_a?(Logger)
+        raise ParameterException
+      end
+      send_publish(topic, payload, retain, qos)
     end
 
-    def append_to_writing(packet)
-      @writing_mutex.synchronize {
-        @writing_queue.push(packet)
-      }
+    def subscribe(*topics)
+      unless topics.length == 0
+        send_subscribe(topics)
+      else
+        @logger.error("Subscribe topics need one topic or a list of topics.") if @logger.is_a?(Logger)
+        disconnect(false)
+        raise ProtocolViolation
+      end
+    end
+
+    def unsubscribe(*topics)
+      unless topics.length == 0
+        send_unsubscribe(topics)
+      else
+        @logger.error("Unsubscribe need at least one topics.") if @logger.is_a?(Logger)
+        disconnect(false)
+        raise ProtocolViolation
+      end
+    end
+
+    def ping_host
+      send_pingreq
+    end
+    
+    def add_topic_callback(topic, callback=nil, &block)
+      if topic.nil?
+        @logger.error("The topics where the callback is trying to be registered have been found nil.") if @logger.is_a?(Logger)
+        raise ParameterException
+      end
+      remove_topic_callback(topic)
+
+      if block_given?
+        @registered_callback.push([topic, block])
+      elsif !(callback.nil?) && callback.class == Proc
+        @registered_callback.push([topic, callback])
+      end
       MQTT_ERR_SUCCESS
     end
 
+    def remove_topic_callback(topic)
+      if topic.nil?
+        @logger.error("The topics where the callback is trying to be unregistered have been found nil.") if @logger.is_a?(Logger)
+        raise ParameterException
+      end
+      @registered_callback.delete_if {|pair| pair.first == topic}
+      MQTT_ERR_SUCCESS
+    end
+    
+    def on_connack(&block)
+      @on_connack = block if block_given?
+      @on_connack
+    end
+
+    def on_suback(&block)
+      @on_suback = block if block_given?
+      @on_suback
+    end
+
+    def on_unsuback(&block)
+      @on_unsuback = block if block_given?
+      @on_unsuback
+    end
+
+    def on_puback(&block)
+      @on_puback = block if block_given?
+      @on_puback
+    end
+
+    def on_pubrec(&block)
+      @on_pubrec = block if block_given?
+      @on_pubrec
+    end
+
+    def on_pubrel(&block)
+      @on_pubrel = block if block_given?
+      @on_pubrel
+    end
+
+    def on_pubcomp(&block)
+      @on_pubcomp = block if block_given?
+      @on_pubcomp
+    end
+
+    def on_message(&block)
+      @on_message = block if block_given?
+      @on_message
+    end
+
+    private
+
+    def next_packet_id
+      @last_packet_id = ( @last_packet_id || 0 ).next
+    end
+
     def config_subscription
       unless @subscribed_topics == []
         new_id = next_packet_id
@@ -402,82 +402,128 @@ module PahoMqtt
         queue.each do |pck|
           pck[:packet].dup ||= true
           if cnt <= max_packet
-            append_to_writing(pck)
+            append_to_writing(pck[:packet])
             cnt += 1
           end
         end
       }
     end
-    
-    def disconnect(explicit=true)
-      # TODO => MOVE TO LOGGER
-      #      puts "Disconnecting"
-      
-      if explicit
-        send_disconnect
-        @mqtt_thread.kill if @mqtt_thread && @mqtt_thread.alive?
-        @mqtt_thread.kill if @mqtt_thread.alive?
 
-        @socket.close unless @socket.nil?
+    def config_socket
+      unless @socket.nil?
+        @socket.close
         @socket = nil
       end
 
-      @connection_state_mutex.synchronize {
-        @connection_state = MQTT_CS_DISCONNECT
-      }
+      unless @host.nil? || @port < 0
+        begin
+          tcp_socket = TCPSocket.new(@host, @port)
+        rescue ::Exception => exp
+          @logger.warn("Could not open a socket with #{@host} on port #{@port}") if @logger.is_a?(Logger)
+        end
+      end
 
-      @writing_mutex.synchronize {
-        @writing_queue = []
-      }
+      if @ssl
+        unless @ssl_context.nil?
+          @socket = OpenSSL::SSL::SSLSocket.new(tcp_socket, @ssl_context)
+          @socket.sync_close = true
+          @socket.connect
+        else
+          @logger.error("The ssl context was found as nil while the socket's opening.") if @logger.is_a?(Logger)
+          raise Exception
+        end
+      else
+        @socket = tcp_socket
+      end
+    end
 
-      @puback_mutex.synchronize {
-        @waiting_puback = []
-      }
+    def setup_connection
+      @mqtt_thread.kill unless @mqtt_thread.nil? 
+      if @host.nil? || @host == ""
+        @logger.error("The host was found as nil while the connection setup.") if @logger.is_a?(Logger)
+        raise ParameterException
+      end
 
-      @pubrec_mutex.synchronize {
-        @waiting_pubrec = []
-      }
+      if @port.to_i <= 0
+        @logger.error("The port value is invalid (<= 0). Could not setup the connection.") if @logger.is_a?(Logger)
+        raise ParameterException
+      end
 
-      @pubrel_mutex.synchronize {
-        @waiting_pubrel = []
-      }
+       @socket.close unless @socket.nil?
+       @socket = nil
 
-      @pubcomp_mutex.synchronize {
-        @waiting_pubcomp = []
-      }
+      @last_ping_req = Time.now
+      @last_ping_resp = Time.now
 
-      @last_packet_id = 0
-      MQTT_ERR_SUCCESS
-    end
-    
-    def publish(topic, payload="", retain=false, qos=0)
-      if topic == "" || !topic.is_a?(String)
-        raise "Publish error, topic is empty or invalid"
+      @logger.debug("Atempt to connect to host: #{@host}") if @logger.is_a?(Logger)
+      config_socket
+
+      unless @socket.nil?
+        send_connect
+        # Waiting a Connack packet for "ack_timeout" second from the remote
+        connect_timeout = Time.now + @ack_timeout
+        while (Time.now <= connect_timeout) && (@connection_state != MQTT_CS_CONNECTED) do
+          receive_packet
+          sleep 0.0001
+        end
       end
-      send_publish(topic, payload, retain, qos)
-    end
 
-    def subscribe(*topics)
-      unless topics.length == 0
-        send_subscribe(topics)
+      if @connection_state != MQTT_CS_CONNECTED
+        @logger.warn("Connection failed. Couldn't recieve a Connack packet from: #{@host}, socket is \"#{@socket}\".") if @logger.is_a?(Logger)
+        
+        unless Thread.current == @reconnect_thread
+          raise Exception.new("Connection failed. Check log for more details.")
+        end
       else
-        raise "Protocol Violation, subscribe topics list must not be empty."
+        config_subscription
+        @mqtt_thread = Thread.new do
+          @reconnect_thread.kill unless @reconnect_thread.nil? || !@reconnect_thread.alive?
+          while @connection_state == MQTT_CS_CONNECTED do
+            mqtt_loop
+          end
+        end
       end
     end
 
-    def unsubscribe(topics)
-      unless topics.length == 0
-        send_unsubscribe(topics)
-      else
-        raise "Protocol Violation, unsubscribe topics list must not be empty."
+    def check_keep_alive
+      if @keep_alive >= 0 && @connection_state == MQTT_CS_CONNECTED
+        now = Time.now
+        timeout_req = (@last_ping_req + (@keep_alive * 0.7).ceil)
+
+        if timeout_req <= now && @persistent
+          send_pingreq
+          @last_ping_req = now
+        end
+
+        timeout_resp = @last_ping_resp + (@keep_alive * 1.1).ceil
+        if timeout_resp <= now
+          @logger.debug("No activity over timeout, trying to reconnect to #{@host}") if @logger.is_a?(Logger)
+          disconnect(false)
+          reconnect if @persistent
+        end
       end
     end
-    
-    private
-    
+
+    def check_ack_alive(queue, mutex, max_packet)
+      mutex.synchronize {
+        now = Time.now
+        cnt = 0
+        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
+            unless cnt > max_packet
+              append_to_writing(pck[:packet]) 
+              pck[:timestamp] = now
+              cnt += 1
+            end
+          end
+        end
+      }
+    end
+
     def receive_packet
       begin
-        result = IO.select([@socket], [], [], SELECT_TIMEOUT)
+        result = IO.select([@socket], [], [], SELECT_TIMEOUT) unless @socket.nil?
         unless result.nil?
           packet = PahoMqtt::Packet.read(@socket)
           unless packet.nil?
@@ -485,16 +531,19 @@ module PahoMqtt
             @last_ping_resp = Time.now
           end
         end
-      rescue Exception => exp
-        unless @socket.nil?
-          @socket.close
-          @socket = nil
+      rescue ::Exception => exp
+        disconnect(false)
+        if @persistent
+          reconnect
+        else
+          @logger.error("The packet reading have failed.") if @logger.is_a?(Logger)
+          raise(exp)
         end
-        raise(exp)
       end
     end
-    
-    def handle_packet(packet)
+
+    def handle_packet(packet)      
+      @logger.info("New packet #{packet.class} recieved.") if @logger.is_a?(Logger)
       if packet.class == PahoMqtt::Packet::Connack
         handle_connack(packet)
       elsif packet.class == PahoMqtt::Packet::Suback
@@ -511,28 +560,29 @@ module PahoMqtt
         handle_pubrel(packet)
       elsif packet.class == PahoMqtt::Packet::Pubcomp
         handle_pubcomp(packet)
-      elsif packet.class ==PahoMqtt::Packet::Pingresp
+      elsif packet.class == PahoMqtt::Packet::Pingresp
         handle_pingresp
       else
-        raise "Unknow packet received"
+        @logger.error("The packets header is invalid for packet: #{packet}") if @logger.is_a?(Logger)
+        raise PacketException
       end
     end
 
     def handle_connack(packet)
-      if packet.return_code == 0x00        
-      # TODO => MOVE TO LOGGER
-        #        puts "Connection accepted, ready to process"
+      if packet.return_code == 0x00
+        @logger.debug("Connack receive and connection accepted.") if @logger.is_a?(Logger)
         if @clean_session && !packet.session_present
-        #        puts "New session created"
+          @logger.debug("New session created for the client") if @logger.is_a?(Logger)
         elsif !@clean_session && !packet.session_present
-        #       puts "Could not find session on server side, starting a new one."
+          @logger.debug("No previous session found by server, starting a new one.") if @logger.is_a?(Logger)
         elsif !@clean_session && packet.session_present
-          #   puts "Retrieving previous session on server side."
+          @logger.debug("Previous session restored by the server.") if @logger.is_a?(Logger)
         end
         @connection_state_mutex.synchronize{
           @connection_state = MQTT_CS_CONNECTED
         }
       else
+        disconnect(false)
         handle_connack_error(packet.return_code)
       end
       config_all_message_queue
@@ -547,7 +597,7 @@ module PahoMqtt
     def handle_pingresp
       @last_ping_resp = Time.now
     end
-    
+
     def handle_suback(packet)
       adjust_qos = []
       max_qos = packet.return_codes
@@ -562,11 +612,13 @@ module PahoMqtt
           elsif max_qos[0] == 128
             adjust_qos.delete(t)
           else
-            raise "Invalid qos value used."
+            @logger.error("The qos value is invalid in subscribe.") if @logger.is_a?(Logger)
+            raise PacketException
           end
         end
       else
-        raise "Two packet subscribe packet cannot have the same id"
+        @logger.error("The packet id is invalid, already used.") if @logger.is_a?(Logger)
+        raise PacketException
       end
       @subscribed_mutex.synchronize {
         @subscribed_topics.concat(adjust_qos)
@@ -583,7 +635,8 @@ module PahoMqtt
       if to_unsub.length == 1
         to_unsub = to_unsub.first[:packet].topics
       else
-        raise "Two packet unsubscribe cannot have the same id"
+        @logger.error("The packet id is invalid, already used.") if @logger.is_a?(Logger)
+        raise PacketException
       end
 
       @subscribed_mutex.synchronize {
@@ -593,7 +646,7 @@ module PahoMqtt
       }
       @on_unsuback.call unless @on_unsuback.nil?
     end
-    
+
     def handle_publish(packet)
       case packet.qos
       when 0
@@ -602,13 +655,14 @@ module PahoMqtt
       when 2
         send_pubrec(packet.id)
       else
-        raise "Unknow qos level for a publish packet"
+        @logger.error("The packet qos value is invalid in publish.") if @logger.is_a?(Logger)
+        raise PacketException
       end
 
       @on_message.call(packet) unless @on_message.nil?
       @registered_callback.assoc(packet.topic).last.call if @registered_callback.any? { |pair| pair.first == packet.topic}
     end
-    
+
     def handle_puback(packet)
       @puback_mutex.synchronize{
         @waiting_puback.delete_if { |pck| pck[:id] == packet.id }
@@ -639,33 +693,44 @@ module PahoMqtt
       @on_pubcomp.call unless @on_pubcomp.nil?
     end
     
-    ### MOVE TO ERROR HANDLER CLASS
     def handle_connack_error(return_code)
       case return_code
       when 0x01
-      # TODO => MOVE TO LOGGER
-      #        puts "Unable to connect with this version #{@mqtt_version}"
-        if @mqtt_version == "3.1.1"
+        @logger.debug("Unable to connect to the server with the version #{@mqtt_version}, trying 3.1") if @logger.is_a?(Logger)
+        if @mqtt_version != "3.1"
           @mqtt_version = "3.1"
           connect(@host, @port, @keep_alive)
         end
       when 0x02
-        
+        @logger.warn("Client Identifier is correct but not allowed by remote server.") if @logger.is_a?(Logger)
+        MQTT_ERR_FAIL
       when 0x03
-
+        @logger.warn("Connection established but MQTT service unvailable on remote server.") if @logger.is_a?(Logger)
+        MQTT_ERR_FAIL
       when 0x04
-
+        @logger.warn("User name or user password is malformed.") if @logger.is_a?(Logger)
+        MQTT_ERR_FAIL
       when 0x05
-
+        @logger.warn("Client is not authorized to connect to the server.") if @logger.is_a?(Logger)
+        MQTT_ERR_FAIL
       end
     end
     
     def send_packet(packet)
       @socket.write(packet.to_s)
+      @logger.info("A packet #{packet.class} have been sent.") if @logger.is_a?(Logger)
       @last_ping_req = Time.now
       MQTT_ERR_SUCCESS
     end
     
+    
+    def append_to_writing(packet)
+      @writing_mutex.synchronize {
+        @writing_queue.push(packet)
+      }
+      MQTT_ERR_SUCCESS
+    end
+
     def send_connect
       packet = PahoMqtt::Packet::Connect.new(
         :version => @mqtt_version,
@@ -680,18 +745,20 @@ module PahoMqtt
         :will_retain => @will_retain
       )
       send_packet(packet)
+      MQTT_ERR_SUCCESS
     end
 
     def send_disconnect
       packet = PahoMqtt::Packet::Disconnect.new
       send_packet(packet)
+      MQTT_ERR_SUCCESS
     end
 
     def send_pingreq
       packet = PahoMqtt::Packet::Pingreq.new
-      # TODO => MOVE TO LOGGER
-      #      puts "Check if the connection is still alive."
+      @logger.debug("Checking if server is still alive.") if @logger.is_a?(Logger)
       send_packet(packet)
+      MQTT_ERR_SUCCESS
     end
 
     def send_subscribe(topics)
@@ -706,8 +773,6 @@ module PahoMqtt
         @suback_mutex.synchronize {
           @waiting_suback.push({ :id => new_id, :packet => packet, :timestamp => Time.now })
         }
-      else
-        raise "Protocol Violation, subscribe topics list must not be empty."
       end        
       MQTT_ERR_SUCCESS
     end
@@ -724,8 +789,6 @@ module PahoMqtt
         @unsuback_mutex.synchronize {
           @waiting_unsuback.push({:id => new_id, :packet => packet, :timestamp => Time.now})
         }
-      else
-        raise "Protocol Violation, unsubscribe topics list must not be empty."
       end
       MQTT_ERR_SUCCESS
     end
@@ -799,72 +862,13 @@ module PahoMqtt
       MQTT_ERR_SUCCESS
     end
 
-    def add_topic_callback(topic, callback=nil, &block)
-      raise "Trying to register a callback for an undefined topic" if topic.nil?
-
-      remove_topic_callback(topic)
-      
-      if block_given?          
-        @registered_callback.push([topic, block])
-      elsif !(callback.nil?) && callback.class == Proc
-        @registered_callback.push([topic, callback])
-      end
-      MQTT_ERR_SUCCESS
-    end
-
-    def remove_topic_callback(topic)
-      raise "Trying to unregister a callback for an undefined topic" if topic.nil?
-
-      @registered_callback.delete_if {|pair| pair.first == topic}
-      MQTT_ERR_SUCCESS
-    end
-    
-    def on_connack(&block)
-      @on_connack = block if block_given?
-      @on_connack
-    end
-    
-    def on_suback(&block)
-      @on_suback = block if block_given?
-      @on_suback
-    end
-
-    def on_unsuback(&block)
-      @on_unsuback = block if block_given?
-      @on_unsuback
-    end
-    
-    def on_puback(&block)
-      @on_puback = block if block_given?
-      @on_puback
-    end
-
-    def on_pubrec(&block)
-      @on_pubrec = block if block_given?
-      @on_pubrec
-    end
-
-    def on_pubrel(&block)
-      @on_pubrel = block if block_given?
-      @on_pubrel
-    end
-
-    def on_pubcomp(&block)
-      @on_pubcomp = block if block_given?
-      @on_pubcomp
-    end
-
-    def on_message(&block)
-      @on_message = block if block_given?
-      @on_message
-    end
-
     def match_filter(topics, filters)
       if topics.is_a?(String) && filters.is_a?(String)
         topic = topics.split('/')
         filter = filters.split('/')
       else
-        raise "Invalid parameter type #{topics.class} and #{filters.class}"
+        @logger.error("Topics and filters are not found as String while matching topics to filter.") if @logger.is_a?(Logger)
+        raise ParameterException
       end
       
       rc = false

data/lib/paho.mqtt/version.rb

@@ -1,3 +1,3 @@
 module PahoMqtt
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/paho-mqtt.gemspec

@@ -17,12 +17,12 @@ Gem::Specification.new do |spec|
   # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
   # delete this section to allow pushing this gem to any host.
   if spec.respond_to?(:metadata)
-  #  spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  #    spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'
   else
     raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
   end
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|benchmark)/}) }
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]

data/samples/{test_init.rb → test_client.rb}

@@ -1,16 +1,20 @@
-require "../lib/paho_client"
-require "../lib/packet_manager"
-require "pp"
+require "paho-mqtt"
+require "logger"
 
-cli = PahoRuby::Client.new
-cli.ssl = true
-cli.config_ssl_context("/Users/Pierre/certs/test/mykey.crt", "/Users/Pierre/certs/test/mykey.key")
-cli.connect('test.mosquitto.org', 8883)
+file = File.open('paho.log', "a+")
+log = Logger.new(file)
+log.level = Logger::DEBUG
+
+cli = PahoMqtt::Client.new({logger: log, persistent: true, keep_alive: 7})
+
+cli.connect('localhost', 1883)
 
 #########################################################
 ### Callback settings
+waiting = true
+cli.on_suback { waiting = false}
 
-cli.on_message = lambda { |topic, payload, qos|  puts ">>>>> This is a LAMBDA callback for message event <<<<<\nTopic: #{topic}\nPayload: #{payload}\nQoS: #{qos}" }
+cli.on_message = lambda { |p|  puts ">>>>> This is a LAMBDA callback for message event <<<<<\nTopic: #{p.topic}\nPayload: #{p.payload}\nQoS: #{p.qos}" }
 
 toto_toto = lambda { puts ">>>>> I am LAMBDA callback for the /toto/toto topic <<<<<" }
 toto_tata = proc { puts ">>>>> I am PROC callback for the /toto/tata topic <<<<<" }
@@ -26,7 +30,9 @@ cli.add_topic_callback('/toto/toto', toto_toto)
 
 cli.subscribe(['/toto/toto', 0], ['/toto/tata', 1], ['/toto/tutu', 2], ["/toto", 0])
 
-sleep 1
+while waiting do
+  sleep 0.0001
+end
 
 cli.publish("/toto/tutu", "It's me!", false, 2)
 cli.publish("/toto/tutu", "It's you!", false, 1)
@@ -40,7 +46,7 @@ cli.publish("/toto/toto", "It's me!", false, 2)
 cli.publish("/toto/toto", "It's you!", false, 1)
 cli.publish("/toto/toto", "It's them!", false, 0)
 
-sleep 3
+sleep cli.ack_timeout
 
 cli.on_message = nil
 toto_tutu = lambda { puts ">>>>> Changing callback type to LAMBDA for the /toto/tutu topic <<<<<" }
@@ -57,8 +63,11 @@ cli.publish("/toto/tata", "It's me!", false, 2)
 cli.publish("/toto/tata", "It's you!", false, 1)
 cli.publish("/toto/tata", "It's them!", false, 0)
 
-sleep 3
+sleep cli.ack_timeout
+
 cli.unsubscribe('+/tutu', "+/+")
+
+puts "Waiting 10 sec for keeping alive..."
 sleep 10
 
 cli.disconnect

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paho-mqtt
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Pierre Goudet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-27 00:00:00.000000000 Z
+date: 2017-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -73,9 +73,10 @@ files:
 - lib/paho.mqtt/packet_manager.rb
 - lib/paho.mqtt/paho_client.rb
 - lib/paho.mqtt/version.rb
+- paho-mqtt-0.0.1.gem
 - paho-mqtt.gemspec
 - samples/test_aws.rb
-- samples/test_init.rb
+- samples/test_client.rb
 homepage: http://ruby-dev.jp
 licenses:
 - MIT