apiotics-paho-mqtt 1.0.0

data/lib/paho_mqtt/client.rb

@@ -0,0 +1,417 @@
+# Copyright (c) 2016-2017 Pierre Goudet <p-goudet@ruby-dev.jp>
+#
+# All rights reserved. This program and the accompanying materials
+# are made available under the terms of the Eclipse Public License v1.0
+# and Eclipse Distribution License v1.0 which accompany this distribution.
+#
+# The Eclipse Public License is available at
+#    https://eclipse.org/org/documents/epl-v10.php.
+# and the Eclipse Distribution License is available at
+#   https://eclipse.org/org/documents/edl-v10.php.
+#
+# Contributors:
+#    Pierre Goudet - initial committer
+
+require 'paho_mqtt/handler'
+require 'paho_mqtt/connection_helper'
+require 'paho_mqtt/sender'
+require 'paho_mqtt/publisher'
+require 'paho_mqtt/subscriber'
+require 'paho_mqtt/ssl_helper'
+
+module PahoMqtt
+  class Client
+    # Connection related attributes:
+    attr_accessor :host
+    attr_accessor :port
+    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
+    attr_accessor :password
+    attr_accessor :ssl
+
+    # Last will attributes:
+    attr_accessor :will_topic
+    attr_accessor :will_payload
+    attr_accessor :will_qos
+    attr_accessor :will_retain
+
+    # Timeout attributes:
+    attr_accessor :keep_alive
+    attr_accessor :ack_timeout
+
+    #Read Only attribute
+    attr_reader :connection_state
+    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
+      @connection_state_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
+      else
+        attr = {}
+      end
+
+      CLIENT_ATTR_DEFAULTS.merge(attr).each_pair do |k,v|
+        self.send("#{k}=", v)
+      end
+
+      if @ssl
+        @ssl_context = OpenSSL::SSL::SSLContext.new
+      end
+
+      if @port.nil?
+        if @ssl
+          @port = DEFAULT_SSL_PORT
+        else
+          @port = DEFAULT_PORT
+        end
+      end
+
+      if  @client_id.nil? || @client_id == ""
+        @client_id = generate_client_id
+      end
+    end
+
+    def generate_client_id(prefix='paho_ruby', lenght=16)
+      charset = Array('A'..'Z') + Array('a'..'z') + Array('0'..'9')
+      @client_id = prefix << Array.new(lenght) { charset.sample }.join
+    end
+
+    def config_ssl_context(cert_path, key_path, ca_path=nil)
+      @ssl ||= true
+      @ssl_context = SSLHelper.config_ssl_context(cert_path, key_path, ca_path)
+    end
+
+    def connect(host=@host, port=@port, keep_alive=@keep_alive, persistent=@persistent, blocking=@blocking)
+      @persistent = persistent
+      @blocking   = blocking
+      @host       = host
+      @port       = port.to_i
+      @keep_alive = keep_alive
+      @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
+        @connection_state = @connection_helper.do_connect(reconnect?)
+        if connected?
+          build_pubsub
+          daemon_mode unless @blocking
+        end
+      rescue LowVersionException
+        downgrade_version
+      end
+    end
+
+    def daemon_mode
+      @mqtt_thread = Thread.new do
+        @reconnect_thread.kill unless @reconnect_thread.nil? || !@reconnect_thread.alive?
+        begin
+          while connected? do
+            mqtt_loop
+          end
+        rescue SystemCallError => e
+          if @persistent
+            reconnect
+          else
+            raise e
+          end
+        end
+      end
+    end
+
+    def connected?
+      @connection_state == MQTT_CS_CONNECTED
+    end
+
+    def reconnect?
+      Thread.current == @reconnect_thread
+    end
+
+    def loop_write(max_packet=MAX_WRITING)
+      begin
+        @sender.writing_loop(max_packet)
+      rescue WritingException
+        if check_persistence
+          reconnect
+        else
+          raise WritingException
+        end
+      end
+    end
+
+    def loop_read(max_packet=MAX_READ)
+      max_packet.times do
+        begin
+          @handler.receive_packet
+        rescue ReadingException
+          if check_persistence
+            reconnect
+          else
+            raise ReadingException
+          end
+        end
+      end
+    end
+
+    def mqtt_loop
+      loop_read
+      loop_write
+      loop_misc
+      sleep LOOP_TEMPO
+    end
+
+    def loop_misc
+      if @connection_helper.check_keep_alive(@persistent, @handler.last_ping_resp, @keep_alive) == MQTT_CS_DISCONNECT
+        reconnect if check_persistence
+      end
+      @publisher.check_waiting_publisher
+      @subscriber.check_waiting_subscriber
+    end
+
+    def reconnect
+      @reconnect_thread = Thread.new do
+        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_delay
+          end
+        end
+        unless connected?
+          PahoMqtt.logger.error("Reconnection attempt counter is over. (#{@reconnect_limit} times)") if PahoMqtt.logger?
+          disconnect(false)
+        end
+      end
+    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
+      MQTT_ERR_SUCCESS
+    end
+
+    def publish(topic, payload="", retain=false, qos=0)
+      if topic == "" || !topic.is_a?(String)
+        PahoMqtt.logger.error("Publish topics is invalid, not a string or empty.") if PahoMqtt.logger?
+        raise ArgumentError
+      end
+      id = next_packet_id
+      @publisher.send_publish(topic, payload, retain, qos, id)
+    end
+
+    def subscribe(*topics)
+      begin
+        id = next_packet_id
+        unless @subscriber.send_subscribe(topics, id) == PahoMqtt::MQTT_ERR_SUCCESS
+          reconnect if check_persistence
+        end
+        MQTT_ERR_SUCCESS
+      rescue ProtocolViolation
+        PahoMqtt.logger.error("Subscribe topics need one topic or a list of topics.") if PahoMqtt.logger?
+        disconnect(false)
+        raise ProtocolViolation
+      end
+    end
+
+    def unsubscribe(*topics)
+      begin
+        id = next_packet_id
+        unless @subscriber.send_unsubscribe(topics, id) == MQTT_ERR_SUCCESS
+          reconnect if check_persistence
+        end
+        MQTT_ERR_SUCCESS
+      rescue ProtocolViolation
+        PahoMqtt.logger.error("Unsubscribe need at least one topic.") if PahoMqtt.logger?
+        disconnect(false)
+        raise ProtocolViolation
+      end
+    end
+
+    def ping_host
+      @sender.send_pingreq
+    end
+
+    def add_topic_callback(topic, callback=nil, &block)
+      @handler.register_topic_callback(topic, callback, &block)
+    end
+
+    def remove_topic_callback(topic)
+      @handler.clear_topic_callback(topic)
+    end
+
+    def on_connack(&block)
+      @handler.on_connack = block if block_given?
+      @handler.on_connack
+    end
+
+    def on_suback(&block)
+      @handler.on_suback = block if block_given?
+      @handler.on_suback
+    end
+
+    def on_unsuback(&block)
+      @handler.on_unsuback = block if block_given?
+      @handler.on_unsuback
+    end
+
+    def on_puback(&block)
+      @handler.on_puback = block if block_given?
+      @handler.on_puback
+    end
+
+    def on_pubrec(&block)
+      @handler.on_pubrec = block if block_given?
+      @handler.on_pubrec
+    end
+
+    def on_pubrel(&block)
+      @handler.on_pubrel = block if block_given?
+      @handler.on_pubrel
+    end
+
+    def on_pubcomp(&block)
+      @handler.on_pubcomp = block if block_given?
+      @handler.on_pubcomp
+    end
+
+    def on_message(&block)
+      @handler.on_message = block if block_given?
+      @handler.on_message
+    end
+
+    def on_connack=(callback)
+      @handler.on_connack = callback if callback.is_a?(Proc)
+    end
+
+    def on_suback=(callback)
+      @handler.on_suback = callback if callback.is_a?(Proc)
+    end
+
+    def on_unsuback=(callback)
+      @handler.on_unsuback = callback if callback.is_a?(Proc)
+    end
+
+    def on_puback=(callback)
+      @handler.on_puback = callback if callback.is_a?(Proc)
+    end
+
+    def on_pubrec=(callback)
+      @handler.on_pubrec = callback if callback.is_a?(Proc)
+    end
+
+    def on_pubrel=(callback)
+      @handler.on_pubrel = callback if callback.is_a?(Proc)
+    end
+
+    def on_pubcomp=(callback)
+      @handler.on_pubcomp = callback if callback.is_a?(Proc)
+    end
+
+    def on_message=(callback)
+      @handler.on_message = callback if callback.is_a?(Proc)
+    end
+
+    def registered_callback
+      @handler.registered_callback
+    end
+
+    def subscribed_topics
+      @subscriber.subscribed_topics
+    end
+
+
+    private
+
+    def next_packet_id
+      @id_mutex.synchronize do
+        @last_packet_id = (@last_packet_id || 0).next
+      end
+    end
+
+    def downgrade_version
+      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 ProtocolVersionException.new("Unsupported MQTT version")
+      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
+      @handler.config_pubsub(@publisher, @subscriber)
+    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
+    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
+      }
+    end
+
+    def check_persistence
+      disconnect(false)
+      @persistent
+    end
+  end
+end

data/lib/paho_mqtt/connection_helper.rb

@@ -0,0 +1,169 @@
+# Copyright (c) 2016-2017 Pierre Goudet <p-goudet@ruby-dev.jp>
+#
+# All rights reserved. This program and the accompanying materials
+# are made available under the terms of the Eclipse Public License v1.0
+# and Eclipse Distribution License v1.0 which accompany this distribution.
+#
+# The Eclipse Public License is available at
+#    https://eclipse.org/org/documents/epl-v10.php.
+# and the Eclipse Distribution License is available at
+#   https://eclipse.org/org/documents/edl-v10.php.
+#
+# Contributors:
+#    Pierre Goudet - initial committer
+
+require 'socket'
+
+module PahoMqtt
+  class ConnectionHelper
+
+    attr_accessor :sender
+
+    def initialize(host, port, ssl, ssl_context, ack_timeout)
+      @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)
+    end
+
+    def handler=(handler)
+      @handler = handler
+    end
+
+    def do_connect(reconnection=false)
+      @cs = MQTT_CS_NEW
+      @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
+        @cs = @handler.receive_packet
+        sleep 0.0001
+      end
+      unless is_connected?
+        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
+    end
+
+    def is_connected?
+      @cs == MQTT_CS_CONNECTED
+    end
+
+    def do_disconnect(publisher, explicit, mqtt_thread)
+      PahoMqtt.logger.debug("Disconnecting from #{@host}.") if PahoMqtt.logger?
+      if explicit
+        explicit_disconnect(publisher, mqtt_thread)
+      end
+      @socket.close unless @socket.nil? || @socket.closed?
+      @socket = nil
+    end
+
+    def explicit_disconnect(publisher, mqtt_thread)
+      @sender.flush_waiting_packet
+      send_disconnect
+      mqtt_thread.kill if mqtt_thread && mqtt_thread.alive?
+      publisher.flush_publisher unless publisher.nil?
+    end
+
+    def setup_connection
+      clean_start(@host, @port)
+      config_socket
+      unless @socket.nil?
+        @sender.socket = @socket
+      end
+    end
+
+    def config_socket
+      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?
+      end
+      if @ssl
+        encrypted_socket(tcp_socket, @ssl_context)
+      else
+        @socket = tcp_socket
+      end
+    end
+
+    def encrypted_socket(tcp_socket, ssl_context)
+      unless ssl_context.nil?
+        @socket = OpenSSL::SSL::SSLSocket.new(tcp_socket, ssl_context)
+        @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?
+        raise Exception
+      end
+    end
+
+    def clean_start(host, port)
+      self.host = host
+      self.port = port
+      unless @socket.nil?
+        @socket.close unless @socket.closed?
+        @socket = nil
+      end
+    end
+
+    def host=(host)
+      if host.nil? || host == ""
+        PahoMqtt.logger.error("The host was found as nil while the connection setup.") if PahoMqtt.logger?
+        raise ArgumentError
+      else
+        @host = host
+      end
+    end
+
+    def port=(port)
+      if port.to_i <= 0
+        PahoMqtt.logger.error("The port value is invalid (<= 0). Could not setup the connection.") if PahoMqtt.logger?
+        raise ArgumentError
+      else
+        @port = port
+      end
+    end
+
+    def send_connect(session_params)
+      setup_connection
+      packet = PahoMqtt::Packet::Connect.new(session_params)
+      @handler.clean_session = session_params[:clean_session]
+      @sender.send_packet(packet)
+      MQTT_ERR_SUCCESS
+    end
+
+    def send_disconnect
+      packet = PahoMqtt::Packet::Disconnect.new
+      @sender.send_packet(packet)
+      MQTT_ERR_SUCCESS
+    end
+
+    def send_pingreq
+      packet = PahoMqtt::Packet::Pingreq.new
+      @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?
+        send_pingreq
+      end
+      timeout_resp = last_ping_resp + (keep_alive * 1.1).ceil
+      #if timeout_resp <= now
+      if false #dirty hack to disable the ping timeout.  we are using a ping to a topic every 30 secs instead of this.
+        PahoMqtt.logger.debug("No activity period over timeout, disconnecting from #{@host}.") if PahoMqtt.logger?
+        @cs = MQTT_CS_DISCONNECT
+      end
+      @cs
+    end
+  end
+end

data/lib/paho_mqtt/exception.rb

@@ -0,0 +1,43 @@
+# Copyright (c) 2016-2018 Pierre Goudet <p-goudet@ruby-dev.jp>
+#
+# All rights reserved. This program and the accompanying materials
+# are made available under the terms of the Eclipse Public License v1.0
+# and Eclipse Distribution License v1.0 which accompany this distribution.
+#
+# The Eclipse Public License is available at
+#    https://eclipse.org/org/documents/epl-v10.php.
+# and the Eclipse Distribution License is available at
+#   https://eclipse.org/org/documents/edl-v10.php.
+#
+# Contributors:
+#    Pierre Goudet - initial committer
+
+
+module PahoMqtt
+  class Exception < ::StandardError
+    def initialize(msg="")
+      super
+    end
+  end
+  
+  class ProtocolViolation < Exception
+  end
+  
+  class WritingException < Exception
+  end
+  
+  class ReadingException < Exception
+  end
+
+  class PacketException < Exception
+  end
+
+  class PacketFormatException < Exception
+  end
+
+  class ProtocolVersionException < Exception
+  end
+
+  class LowVersionException < Exception
+  end
+end