mqtt-rails 1.0

data/lib/mqtt_rails/packet/pubrec.rb

@@ -0,0 +1,44 @@
+# encoding: BINARY
+### original file from the ruby-mqtt gem
+### located at https://github.com/njh/ruby-mqtt/blob/master/lib/mqtt/packet.rb
+### Copyright (c) 2009-2013 Nicholas J Humfrey
+
+# 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 MqttRails
+  module Packet
+    class Pubrec < MqttRails::Packet::Base
+      # Get serialisation of packet's body
+      def encode_body
+        encode_short(@id)
+      end
+
+      # Parse the body (variable header and payload) of a packet
+      def parse_body(buffer)
+        super(buffer)
+        @id = shift_short(buffer)
+        unless buffer.empty?
+          raise MqttRails::PacketFormatException.new(
+                  "Extra bytes at end of Publish Received packet")
+        end
+      end
+
+      # Returns a human readable string, summarising the properties of the packet
+      def inspect
+        "\#<#{self.class}: 0x%2.2X>" % id
+      end
+    end
+  end
+end

data/lib/mqtt_rails/packet/pubrel.rb

@@ -0,0 +1,62 @@
+# encoding: BINARY
+### original file from the ruby-mqtt gem
+### located at https://github.com/njh/ruby-mqtt/blob/master/lib/mqtt/packet.rb
+### Copyright (c) 2009-2013 Nicholas J Humfrey
+
+# 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 MqttRails
+  module Packet
+    class Pubrel < MqttRails::Packet::Base
+      # Default attribute values
+      ATTR_DEFAULTS = {
+        :flags => [false, true, false, false],
+      }
+
+      # Create a new Pubrel packet
+      def initialize(args={})
+        super(ATTR_DEFAULTS.merge(args))
+      end
+
+      # Get serialisation of packet's body
+      def encode_body
+        encode_short(@id)
+      end
+
+      # Parse the body (variable header and payload) of a packet
+      def parse_body(buffer)
+        super(buffer)
+        @id = shift_short(buffer)
+        unless buffer.empty?
+          raise "Extra bytes at end of Publish Release packet"
+        end
+      end
+
+      # Check that fixed header flags are valid for this packet type
+      # @private
+      def validate_flags
+        if @flags != [false, true, false, false]
+          raise MqttRails::PacketFormatException.new(
+                  "Invalid flags in #{type_name} packet header")
+        end
+      end
+
+      # Returns a human readable string, summarising the properties of the packet
+      def inspect
+        "\#<#{self.class}: 0x%2.2X>" % id
+      end
+    end
+  end
+end

data/lib/mqtt_rails/packet/suback.rb

@@ -0,0 +1,75 @@
+# encoding: BINARY
+### original file from the ruby-mqtt gem
+### located at https://github.com/njh/ruby-mqtt/blob/master/lib/mqtt/packet.rb
+### Copyright (c) 2009-2013 Nicholas J Humfrey
+
+# 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 MqttRails
+  module Packet
+    class Suback < MqttRails::Packet::Base
+      # An array of return codes, ordered by the topics that were subscribed to
+      attr_accessor :return_codes
+
+      # Default attribute values
+      ATTR_DEFAULTS = {
+        :return_codes => [],
+      }
+
+      # Create a new Subscribe Acknowledgment packet
+      def initialize(args={})
+        super(ATTR_DEFAULTS.merge(args))
+      end
+
+      # Set the granted QoS value for each of the topics that were subscribed to
+      # Can either be an integer or an array or integers.
+      def return_codes=(value)
+        if value.is_a?(Array)
+          @return_codes = value
+        elsif value.is_a?(Integer)
+          @return_codes = [value]
+        else
+          raise MqttRails::PacketFormatException.new(
+                  "return_codes should be an integer or an array of return codes")
+        end
+      end
+
+      # Get serialisation of packet's body
+      def encode_body
+        if @return_codes.empty?
+          raise MqttRails::PacketFormatException.new(
+                  "No granted QoS given when serialising packet")
+        end
+        body = encode_short(@id)
+        return_codes.each { |qos| body += encode_bytes(qos) }
+        return body
+      end
+
+      # Parse the body (variable header and payload) of a packet
+      def parse_body(buffer)
+        super(buffer)
+        @id = shift_short(buffer)
+        while buffer.bytesize > 0
+          @return_codes << shift_byte(buffer)
+        end
+      end
+
+      # Returns a human readable string, summarising the properties of the packet
+      def inspect
+        "\#<#{self.class}: 0x%2.2X, rc=%s>" % [id, return_codes.map { |rc| "0x%2.2X" % rc }.join(',')]
+      end
+    end
+  end
+end

data/lib/mqtt_rails/packet/subscribe.rb

@@ -0,0 +1,124 @@
+# encoding: BINARY
+### original file from the ruby-mqtt gem
+### located at https://github.com/njh/ruby-mqtt/blob/master/lib/mqtt/packet.rb
+### Copyright (c) 2009-2013 Nicholas J Humfrey
+
+# 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 MqttRails
+  module Packet
+    class Subscribe < MqttRails::Packet::Base
+      # One or more topic filters to subscribe to
+      attr_accessor :topics
+
+      # Default attribute values
+      ATTR_DEFAULTS = {
+        :topics => [],
+        :flags => [false, true, false, false],
+      }
+
+      # Create a new Subscribe packet
+      def initialize(args={})
+        super(ATTR_DEFAULTS.merge(args))
+      end
+
+      # Set one or more topic filters for the Subscribe packet
+      # The topics parameter should be one of the following:
+      # * String: subscribe to one topic with QoS 0
+      # * Array: subscribe to multiple topics with QoS 0
+      # * Hash: subscribe to multiple topics where the key is the topic and the value is the QoS level
+      #
+      # For example:
+      #   packet.topics = 'a/b'
+      #   packet.topics = ['a/b', 'c/d']
+      #   packet.topics = [['a/b',0], ['c/d',1]]
+      #   packet.topics = {'a/b' => 0, 'c/d' => 1}
+      #
+      def topics=(value)
+        # Get input into a consistent state
+        if value.is_a?(Array)
+          input = value.flatten
+        else
+          input = [value]
+        end
+
+        @topics = []
+        while(input.length>0)
+          item = input.shift
+          if item.is_a?(Hash)
+            # Convert hash into an ordered array of arrays
+            @topics += item.sort
+          elsif item.is_a?(String)
+            # Peek at the next item in the array, and remove it if it is an integer
+            if input.first.is_a?(Integer)
+              qos = input.shift
+              @topics << [item, qos]
+            else
+              @topics << [item, 0]
+            end
+          else
+            # Meh?
+            raise MqttRails::PacketFormatException.new(
+                    "Invalid topics input: #{value.inspect}")
+          end
+        end
+        @topics
+      end
+
+      # Get serialisation of packet's body
+      def encode_body
+        if @topics.empty?
+          raise MqttRails::PacketFormatException.new(
+                  "No topics given when serialising packet")
+        end
+        body = encode_short(@id)
+        topics.each do |item|
+          body += encode_string(item[0])
+          body += encode_bytes(item[1])
+        end
+        return body
+      end
+
+      # Parse the body (variable header and payload) of a packet
+      def parse_body(buffer)
+        super(buffer)
+        @id = shift_short(buffer)
+        @topics = []
+        while(buffer.bytesize>0)
+          topic_name = shift_string(buffer)
+          topic_qos = shift_byte(buffer)
+          @topics << [topic_name, topic_qos]
+        end
+      end
+
+      # Check that fixed header flags are valid for this packet type
+      # @private
+      def validate_flags
+        if @flags != [false, true, false, false]
+          raise MqttRails::PacketFormatException.new(
+                  "Invalid flags in SUBSCRIBE packet header")
+        end
+      end
+
+      # Returns a human readable string, summarising the properties of the packet
+      def inspect
+        _str = "\#<#{self.class}: 0x%2.2X, %s>" % [
+          id,
+          topics.map { |t| "'#{t[0]}':#{t[1]}" }.join(', ')
+        ]
+      end
+    end
+  end
+end

data/lib/mqtt_rails/packet/unsuback.rb

@@ -0,0 +1,49 @@
+# encoding: BINARY
+### original file from the ruby-mqtt gem
+### located at https://github.com/njh/ruby-mqtt/blob/master/lib/mqtt/packet.rb
+### Copyright (c) 2009-2013 Nicholas J Humfrey
+
+# 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 MqttRails
+  module Packet
+    class Unsuback < MqttRails::Packet::Base
+      # Create a new Unsubscribe Acknowledgment packet
+      def initialize(args={})
+        super(args)
+      end
+
+      # Get serialisation of packet's body
+      def encode_body
+        encode_short(@id)
+      end
+
+      # Parse the body (variable header and payload) of a packet
+      def parse_body(buffer)
+        super(buffer)
+        @id = shift_short(buffer)
+        unless buffer.empty?
+          raise MqttRails::PacketFormatException.new(
+                  "Extra bytes at end of Unsubscribe Acknowledgment packet")
+        end
+      end
+
+      # Returns a human readable string, summarising the properties of the packet
+      def inspect
+        "\#<#{self.class}: 0x%2.2X>" % id
+      end
+    end
+  end
+end

data/lib/mqtt_rails/packet/unsubscribe.rb

@@ -0,0 +1,84 @@
+# encoding: BINARY
+### original file from the ruby-mqtt gem
+### located at https://github.com/njh/ruby-mqtt/blob/master/lib/mqtt/packet.rb
+### Copyright (c) 2009-2013 Nicholas J Humfrey
+
+# 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 MqttRails
+  module Packet
+    class Unsubscribe < MqttRails::Packet::Base
+      # One or more topic paths to unsubscribe from
+      attr_accessor :topics
+
+      # Default attribute values
+      ATTR_DEFAULTS = {
+        :topics => [],
+        :flags  => [false, true, false, false],
+      }
+
+      # Create a new Unsubscribe packet
+      def initialize(args={})
+        super(ATTR_DEFAULTS.merge(args))
+      end
+
+      # Set one or more topic paths to unsubscribe from
+      def topics=(value)
+        if value.is_a?(Array)
+          @topics = value
+        else
+          @topics = [value]
+        end
+      end
+
+      # Get serialisation of packet's body
+      def encode_body
+        if @topics.empty?
+          raise MqttRails::PacketFormatException.new(
+                  "No topics given when serialising packet")
+        end
+        body = encode_short(@id)
+        topics.each { |topic| body += encode_string(topic) }
+        return body
+      end
+
+      # Parse the body (variable header and payload) of a packet
+      def parse_body(buffer)
+        super(buffer)
+        @id = shift_short(buffer)
+        while buffer.bytesize > 0
+          @topics << shift_string(buffer)
+        end
+      end
+
+      # Check that fixed header flags are valid for this packet type
+      # @private
+      def validate_flags
+        if @flags != [false, true, false, false]
+          raise MqttRails::PacketFormatException.new(
+                  "Invalid flags in UNSUBSCRIBE packet header")
+        end
+      end
+
+      # Returns a human readable string, summarising the properties of the packet
+      def inspect
+        "\#<#{self.class}: 0x%2.2X, %s>" % [
+          id,
+          topics.map { |t| "'#{t}'" }.join(', ')
+        ]
+      end
+    end
+  end
+end

data/lib/mqtt_rails/publisher.rb

@@ -0,0 +1,181 @@
+# 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 MqttRails
+  class Publisher
+
+    def initialize(sender)
+      @waiting_puback  = []
+      @waiting_pubrec  = []
+      @waiting_pubrel  = []
+      @waiting_pubcomp = []
+      @puback_mutex    = Mutex.new
+      @pubrec_mutex    = Mutex.new
+      @pubrel_mutex    = Mutex.new
+      @pubcomp_mutex   = Mutex.new
+      @sender          = sender
+    end
+
+    def sender=(sender)
+      @sender = sender
+    end
+
+    def send_publish(topic, payload, retain, qos, new_id)
+      packet = MqttRails::Packet::Publish.new(
+        :id      => new_id,
+        :topic   => topic,
+        :payload => payload,
+        :retain  => retain,
+        :qos     => qos
+      )
+      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
+        Rails.logger.warn("PUBLISH queue is full, waiting for publishing #{packet.inspect}")
+        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)
+      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
+
+    def do_publish(qos, packet_id)
+      case qos
+      when 0
+      when 1
+        send_puback(packet_id)
+      when 2
+        send_pubrec(packet_id)
+      else
+        Rails.logger.error("The packet QoS value is invalid in publish.")
+        raise PacketException.new('Invalid publish QoS value')
+      end
+      MQTT_ERR_SUCCESS
+    end
+
+    def send_puback(packet_id)
+      packet = MqttRails::Packet::Puback.new(
+        :id => packet_id
+      )
+      @sender.append_to_writing(packet)
+      MQTT_ERR_SUCCESS
+    end
+
+    def do_puback(packet_id)
+      @puback_mutex.synchronize do
+        @waiting_puback.delete_if { |pck| pck[:id] == packet_id }
+      end
+      MQTT_ERR_SUCCESS
+    end
+
+    def send_pubrec(packet_id)
+      packet = MqttRails::Packet::Pubrec.new(
+        :id => packet_id
+      )
+      push_queue(@waiting_pubrel, @pubrel_mutex, MAX_QUEUE, packet, packet_id)
+      @sender.append_to_writing(packet)
+      MQTT_ERR_SUCCESS
+    end
+
+    def do_pubrec(packet_id)
+      @pubrec_mutex.synchronize do
+        @waiting_pubrec.delete_if { |pck| pck[:id] == packet_id }
+      end
+      send_pubrel(packet_id)
+    end
+
+    def send_pubrel(packet_id)
+      packet = MqttRails::Packet::Pubrel.new(
+        :id => packet_id
+      )
+      push_queue(@waiting_pubcomp, @pubcomp_mutex, MAX_QUEUE, packet, packet_id)
+      @sender.append_to_writing(packet)
+      MQTT_ERR_SUCCESS
+    end
+
+    def do_pubrel(packet_id)
+      @pubrel_mutex.synchronize do
+        @waiting_pubrel.delete_if { |pck| pck[:id] == packet_id }
+      end
+      send_pubcomp(packet_id)
+    end
+
+    def send_pubcomp(packet_id)
+      packet = MqttRails::Packet::Pubcomp.new(
+        :id => packet_id
+      )
+      @sender.append_to_writing(packet)
+      MQTT_ERR_SUCCESS
+    end
+
+    def do_pubcomp(packet_id)
+      @pubcomp_mutex.synchronize do
+        @waiting_pubcomp.delete_if { |pck| pck[:id] == packet_id }
+      end
+      MQTT_ERR_SUCCESS
+    end
+
+    def config_all_message_queue
+      config_message_queue(@waiting_puback, @puback_mutex)
+      config_message_queue(@waiting_pubrec, @pubrec_mutex)
+      config_message_queue(@waiting_pubrel, @pubrel_mutex)
+      config_message_queue(@waiting_pubcomp, @pubcomp_mutex)
+    end
+
+    def config_message_queue(queue, mutex)
+      mutex.synchronize do
+        queue.each do |pck|
+          pck[:timestamp] = Time.now
+        end
+      end
+    end
+
+    def check_waiting_publisher
+      @sender.check_ack_alive(@waiting_puback, @puback_mutex)
+      @sender.check_ack_alive(@waiting_pubrec, @pubrec_mutex)
+      @sender.check_ack_alive(@waiting_pubrel, @pubrel_mutex)
+      @sender.check_ack_alive(@waiting_pubcomp, @pubcomp_mutex)
+    end
+
+    def flush_publisher
+      @puback_mutex.synchronize do
+        @waiting_puback = []
+      end
+      @pubrec_mutex.synchronize do
+        @waiting_pubrec = []
+      end
+      @pubrel_mutex.synchronize do
+        @waiting_pubrel = []
+      end
+      @pubcomp_mutex.synchronize do
+        @waiting_pubcomp = []
+      end
+    end
+  end
+end