mqtt 0.0.1 → 0.0.2

data/NEWS

@@ -1,5 +1,9 @@
 = Ruby MQTT NEWS
 
-== Ruby MQTT Version 0.0.1 (2009-01-??)
+== Ruby MQTT Version 0.0.2 (2009-02-03)
+
+Added support for packets longer than 127 bytes.
+
+== Ruby MQTT Version 0.0.1 (2009-02-01)
 
 Initial Release.

data/README

@@ -22,8 +22,8 @@ You may get the latest stable version from Rubyforge. Source gems are also avail
 
 == TODO
 
-* Support payloads longer than 128 bytes
 * Process acknowledgement packets
+* Automatic uninque client identifier if none given
 * Create classes for each type of packet?
 * More validations of data/parameters
 * Implement exception throwing

data/Rakefile

@@ -8,7 +8,7 @@ require 'spec/rake/verify_rcov'
 
 
 NAME = "mqtt"
-VERS = "0.0.1"
+VERS = "0.0.2"
 CLEAN.include ['pkg', 'rdoc']
 
 spec = Gem::Specification.new do |s|

data/examples/livetext.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.dirname(__FILE__)+'/../lib'
+
+require 'mqtt'
+
+
+client = MQTT::Client.new('hadrian.aelius.com')
+client.connect('livetextclient')
+
+client.subscribe('livetext/#')
+
+loop do
+  topic,message = client.get
+  puts "#{topic}: #{message}"
+end
+
+client.disconnect

data/examples/simple_get.rb

@@ -8,7 +8,7 @@ require 'mqtt'
 client = MQTT::Client.new('mqtt.example.com')
 client.connect('simple_get')
 
-client.subscribe('$SYS/#')
+client.subscribe('test')
 
 loop do
   topic,message = client.get

data/examples/simple_publish.rb

@@ -7,6 +7,6 @@ require 'mqtt'
 client = MQTT::Client.new('mqtt.example.com')
 client.connect('simple_publish_example') do |c|
 
-  c.publish('test', "The time is: #{Time.now}")
+  c.publish('test', 'x' * 300)
 
 end

data/lib/mqtt/packet.rb

@@ -6,7 +6,7 @@ module MQTT
 
   # Class representing a MQTT Packet
   # Performs binary encoding and decoding of headers
-  class Packet #:nodoc: all
+  class Packet
     attr_reader :type      # The packet type
     attr_reader :dup       # Duplicate delivery flag
     attr_reader :retain    # Retain flag
@@ -14,20 +14,29 @@ module MQTT
     attr_reader :body      # Packet's body (everything after fixed header)
   
     # Read in a packet from a socket
-    def self.read(sock)
-      header = sock.read(2)
-      raise MQTT::ProtocolException if header.nil?
-      byte1,byte2 = header.unpack('C*')
-
-      # FIXME: support decoding of multi-byte length header
+    def self.read(socket)
 
+      # Create a packet object
+      header = read_byte(socket)
       packet = MQTT::Packet.new(
-        :type => ((byte1 & 0xF0) >> 4),
-        :dup => ((byte1 & 0x08) >> 3),
-        :qos => ((byte1 & 0x06) >> 1),
-        :retain => ((byte1 & 0x01) >> 0)
+        :type => ((header & 0xF0) >> 4),
+        :dup => ((header & 0x08) >> 3),
+        :qos => ((header & 0x06) >> 1),
+        :retain => ((header & 0x01) >> 0)
       )
-      packet.body = sock.read(byte2)
+      
+      # Read in the packet length
+      multiplier = 1 
+      body_len = 0 
+      begin
+        digit = read_byte(socket)
+        body_len += ((digit & 0x7F) * multiplier)
+        multiplier *= 0x80
+      end while ((digit & 0x80) != 0x00)
+      # FIXME: only allow 4 bytes?
+
+      # Read in the packet body
+      packet.body = socket.read(body_len)
 
       return packet
     end
@@ -41,6 +50,10 @@ module MQTT
       self.body = args[:body] || ''
     end
     
+    # Set the packet type
+    # Can either by the packet type id (integer)
+    # Or the packet type as a symbol/string
+    # See the MQTT module for an enumeration of packet types.
     def type=(arg)
       if arg.kind_of?(Integer)
         # Convert type identifier to symbol
@@ -59,6 +72,7 @@ module MQTT
       return index
     end
     
+    # Set the dup flag (true/false)
     def dup=(arg)
       if arg.kind_of?(Integer)
         @dup = (arg != 0 ? true : false)
@@ -67,6 +81,7 @@ module MQTT
       end
     end
     
+    # Set the retain flag (true/false)
     def retain=(arg)
       if arg.kind_of?(Integer)
         @retain = (arg != 0 ? true : false)
@@ -75,11 +90,14 @@ module MQTT
       end
     end
     
+    # Set the Quality of Service level (0/1/2)
     def qos=(arg)
       @qos = arg.to_i
     end
     
+    # Set (replace) the packet body
     def body=(arg)
+      # FIXME: only allow 268435455 bytes?
       @body = arg.to_s
     end
 
@@ -137,15 +155,25 @@ module MQTT
     
     # Serialise the packet
     def to_s
-      # Encode the 2-byte fixed header
+      # Encode the fixed header
       header = [
         ((type_id.to_i & 0x0F) << 4) |
         ((dup ? 0x1 : 0x0) << 3) |
         ((qos.to_i & 0x03) << 1) |
-        (retain ? 0x1 : 0x0),
-        (@body.length & 0x7F)
+        (retain ? 0x1 : 0x0)
       ]
-      # FIXME: support multi-byte length header
+      
+      # Build up the body length field bytes
+      body_size = @body.size
+      begin
+        digit = (body_size % 128)
+        body_size = (body_size / 128)
+        # if there are more digits to encode, set the top bit of this digit
+        digit |= 0x80 if (body_size > 0)
+        header.push(digit)
+      end while (body_size > 0)
+
+      # Convert header to binary and add on body
       header.pack('C*') + @body
     end
     
@@ -155,6 +183,15 @@ module MQTT
       "qos=#{@qos}, body.size=#{@body.size}>"
     end
     
+    private
+    
+    # Read and unpack a single byte from socket
+    def self.read_byte(socket)
+      byte = socket.read(1)
+      raise MQTT::ProtocolException if byte.nil?
+      byte.unpack('C').first
+    end
+    
   end
   
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mqtt
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Nicholas J Humfrey
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-02-01 00:00:00 +00:00
+date: 2009-02-03 00:00:00 +00:00
 default_executable: 
 dependencies: []
 
@@ -28,6 +28,7 @@ files:
 - lib/mqtt.rb
 - lib/mqtt/client.rb
 - lib/mqtt/packet.rb
+- examples/livetext.rb
 - examples/simple_get.rb
 - examples/simple_publish.rb
 - README