paho-mqtt 1.0.0 → 1.0.1

data/lib/paho_mqtt/connection_helper.rb

@@ -0,0 +1,167 @@
+# 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)
+      @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}, socket is \"#{@socket}\".") 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("Atempt 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
+        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/handler.rb

@@ -0,0 +1,271 @@
+# 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
+
+module PahoMqtt
+  class Handler
+
+    attr_reader :registered_callback
+    attr_accessor :last_ping_resp
+    attr_accessor :clean_session
+    
+    def initialize
+      @registered_callback = []
+      @last_ping_resp = -1
+      @publisher = nil
+      @subscriber = nil
+    end
+
+    def config_pubsub(publisher, subscriber)
+      @publisher = publisher
+      @subscriber = subscriber
+    end
+
+    def socket=(socket)
+      @socket = socket
+    end
+
+    def receive_packet
+      result = IO.select([@socket], [], [], SELECT_TIMEOUT) unless @socket.nil? || @socket.closed?
+      unless result.nil?
+        packet = PahoMqtt::Packet::Base.read(@socket)
+        unless packet.nil?
+          if packet.is_a?(PahoMqtt::Packet::Connack)
+            @last_ping_resp = Time.now
+            handle_connack(packet)
+          else
+            handle_packet(packet)
+            @last_ping_resp = Time.now
+          end          
+        end
+      end
+    end
+
+    def handle_packet(packet)
+      PahoMqtt.logger.info("New packet #{packet.class} recieved.") if PahoMqtt.logger?
+      type = packet_type(packet)
+      self.send("handle_#{type}", packet)
+    end
+
+    def register_topic_callback(topic, callback, &block)
+      if topic.nil?
+        PahoMqtt.logger.error("The topics where the callback is trying to be registered have been found nil.") if PahoMqtt.logger?
+        raise ArgumentError
+      end
+      clear_topic_callback(topic)
+      if block_given?
+        @registered_callback.push([topic, block])
+      elsif !(callback.nil?) && callback.is_a?(Proc)
+        @registered_callback.push([topic, callback])
+      end
+      MQTT_ERR_SUCCESS
+    end
+
+    def clear_topic_callback(topic)
+      if topic.nil?
+        PahoMqtt.logger.error("The topics where the callback is trying to be unregistered have been found nil.") if PahoMqtt.logger?
+        raise ArgumentError
+      end
+      @registered_callback.delete_if {|pair| pair.first == topic}
+      MQTT_ERR_SUCCESS
+    end
+
+    def handle_connack(packet)
+      if packet.return_code == 0x00
+        PahoMqtt.logger.debug("Connack receive and connection accepted.") if PahoMqtt.logger?
+        handle_connack_accepted(packet.session_present)
+      else
+        handle_connack_error(packet.return_code)
+      end
+      @on_connack.call(packet) unless @on_connack.nil?
+      MQTT_CS_CONNECTED
+    end
+
+    def handle_connack_accepted(session_flag)
+      clean_session?(session_flag)
+      new_session?(session_flag)
+      old_session?(session_flag)
+    end
+
+    def new_session?(session_flag)
+      if !@clean_session && !session_flag
+        PahoMqtt.logger.debug("New session created for the client") if PahoMqtt.logger?
+      end
+    end
+
+    def clean_session?(session_flag)
+      if @clean_session && !session_flag
+        PahoMqtt.logger.debug("No previous session found by server, starting a new one.") if PahoMqtt.logger?
+      end
+    end
+
+    def old_session?(session_flag)
+      if !@clean_session && session_flag
+        PahoMqtt.logger.debug("Previous session restored by the server.") if PahoMqtt.logger?
+      end
+    end
+
+    def handle_pingresp(_packet)
+      @last_ping_resp = Time.now
+    end
+
+    def handle_suback(packet)
+      max_qos = packet.return_codes
+      id = packet.id
+      topics = []
+      if @subscriber.add_subscription(max_qos, id, topics) == MQTT_ERR_SUCCESS
+        @on_suback.call(topics) unless @on_suback.nil?
+      end
+    end
+
+    def handle_unsuback(packet)
+      id = packet.id
+      topics = []
+      if @subscriber.remove_subscription(id, topics) == MQTT_ERR_SUCCESS
+        @on_unsuback.call(topics) unless @on_unsuback.nil?
+      end
+    end
+
+    def handle_publish(packet)
+      id = packet.id
+      qos = packet.qos
+      if @publisher.do_publish(qos, id) == MQTT_ERR_SUCCESS
+        @on_message.call(packet) unless @on_message.nil?
+        @registered_callback.assoc(packet.topic).last.call(packet) if @registered_callback.any? { |pair| pair.first == packet.topic}
+      end
+    end
+
+    def handle_puback(packet)
+      id = packet.id
+      if @publisher.do_puback(id) == MQTT_ERR_SUCCESS
+        @on_puback.call(packet) unless @on_puback.nil?
+      end
+    end
+
+    def handle_pubrec(packet)
+      id = packet.id
+      if @publisher.do_pubrec(id) == MQTT_ERR_SUCCESS      
+        @on_pubrec.call(packet) unless @on_pubrec.nil?
+      end
+    end
+
+    def handle_pubrel(packet)
+      id = packet.id
+      if @publisher.do_pubrel(id) == MQTT_ERR_SUCCESS
+        @on_pubrel.call(packet) unless @on_pubrel.nil?
+      end
+    end
+
+    def handle_pubcomp(packet)
+      id = packet.id
+      if @publisher.do_pubcomp(id) == MQTT_ERR_SUCCESS
+        @on_pubcomp.call(packet) unless @on_pubcomp.nil?
+      end
+    end
+
+    def handle_connack_error(return_code)
+      if return_code ==  0x01
+        raise LowVersionException
+      elsif CONNACK_ERROR_MESSAGE.has_key(return_code.to_sym)
+        PahoMqtt.logger.warm(CONNACK_ERRO_MESSAGE[return_code])
+        MQTT_CS_DISCONNECTED
+      else
+        PahoMqtt.logger("Unknown return code for CONNACK packet: #{return_code}")
+        raise PacketException
+      end
+    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 on_connack=(callback)
+      @on_connack = callback if callback.is_a?(Proc)
+    end
+
+    def on_suback=(callback)
+      @on_suback = callback if callback.is_a?(Proc)
+    end
+
+    def on_unsuback=(callback)
+      @on_unsuback = callback if callback.is_a?(Proc)
+    end
+
+    def on_puback=(callback)
+      @on_puback = callback if callback.is_a?(Proc)
+    end
+
+    def on_pubrec=(callback)
+      @on_pubrec = callback if callback.is_a?(Proc)
+    end
+
+    def on_pubrel=(callback)
+      @on_pubrel = callback if callback.is_a?(Proc)
+    end
+
+    def on_pubcomp=(callback)
+      @on_pubcomp = callback if callback.is_a?(Proc)
+    end
+
+    def on_message=(callback)
+      @on_message = callback if callback.is_a?(Proc)
+    end
+
+    def packet_type(packet)
+      type = packet.class
+      if PahoMqtt::PACKET_TYPES[3..13].include?(type)
+        type.to_s.split('::').last.downcase
+      else
+        puts "Packet: #{packet.inspect}"
+        PahoMqtt.logger.error("Received an unexpeceted packet: #{packet}") if PahoMqtt.logger?
+         raise PacketException
+      end
+    end
+  end
+end

data/lib/paho_mqtt/packet.rb

@@ -1,4 +1,18 @@
 # encoding: BINARY
+# 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/packet/base"
 require "paho_mqtt/packet/connect"
 require "paho_mqtt/packet/connack"