mqtt 0.0.2 → 0.0.3

data/NEWS

@@ -1,5 +1,10 @@
 = Ruby MQTT NEWS
 
+== Ruby MQTT Version 0.0.3 (2009-02-08)
+
+Added checking of Connection Acknowledgement.
+Automatic client identifier generation.
+
 == Ruby MQTT Version 0.0.2 (2009-02-03)
 
 Added support for packets longer than 127 bytes.

data/README

@@ -12,24 +12,35 @@ You may get the latest stable version from Rubyforge. Source gems are also avail
 
 == Synopsis
 
- require 'rubygems'
- require 'mqtt'
+  require 'rubygems'
+  require 'mqtt'
+  
+  # Publish example
+  mqtt = MQTT::Client.new('mqtt.example.com')
+  mqtt.connect do |c|
+    c.publish('topic','message')
+  end
+
+  # Subscribe example
+  mqtt = MQTT::Client.new('mqtt.example.com')
+  client.connect do
+    client.subscribe('test')
+    loop do
+      topic,message = client.get
+      puts "#{topic}: #{message}"
+    end
+  end
 
- mqtt = MQTT::Client.new('mqtt.example.com')
- mqtt.connect('clientid') do |c|
-   c.publish('topic','message')
- end
 
 == TODO
 
 * 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
 * Implement Will and Testament
-* Add unit tests
 * More examples
+* Integration tests
 * Refactor to add callbacks that are called from seperate thread
 * Implement QOS Level 1
 * Implement QOS Level 2
@@ -37,7 +48,7 @@ You may get the latest stable version from Rubyforge. Source gems are also avail
 
 == Resources
 
-http://mqtt.org
+http://www.mqtt.org
 
 == Contact
 

data/Rakefile

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

data/examples/livetext.rb

@@ -4,15 +4,11 @@ $:.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
+client.connect do
+  client.subscribe('livetext/#')
+  loop do
+    topic,message = client.get
+    puts "#{topic}: #{message}"
+  end
+end

data/examples/simple_get.rb

@@ -4,15 +4,11 @@ $:.unshift File.dirname(__FILE__)+'/../lib'
 
 require 'mqtt'
 
-
 client = MQTT::Client.new('mqtt.example.com')
-client.connect('simple_get')
-
-client.subscribe('test')
-
-loop do
-  topic,message = client.get
-  puts "#{topic}: #{message}"
+client.connect do
+  client.subscribe('#')
+  loop do
+    topic,message = client.get
+    puts "#{topic}: #{message}"
+  end
 end
-
-client.disconnect

data/examples/simple_publish.rb

@@ -5,8 +5,8 @@ $:.unshift File.dirname(__FILE__)+'/../lib'
 require 'mqtt'
 
 client = MQTT::Client.new('mqtt.example.com')
-client.connect('simple_publish_example') do |c|
+client.connect do |c|
 
-  c.publish('test', 'x' * 300)
+  c.publish('test', "The time is: #{Time.now}")
 
 end

data/lib/mqtt/client.rb

@@ -4,6 +4,7 @@ require 'mqtt'
 require 'mqtt/packet'
 require 'thread'
 require 'socket'
+require 'timeout'
 
 
 module MQTT
@@ -12,8 +13,10 @@ module MQTT
   class Client
     attr_reader :remote_host    # Hostname of the remote broker
     attr_reader :remote_port    # Port number of the remote broker
-    attr_accessor :keep_alive   # Time between pings to remote broker
+    attr_accessor :keep_alive   # Time (in seconds) between pings to remote broker
     attr_accessor :clean_start  # Set the 'Clean Start' flag when connecting?
+    attr_accessor :client_id    # Client Identifier
+    attr_accessor :ack_timeout  # Number of seconds to wait for acknowledgement packets
     
     # Timeout between select polls (in seconds)
     SELECT_TIMEOUT = 0.5
@@ -22,9 +25,11 @@ module MQTT
     def initialize(remote_host='localhost', remote_port=1883)
       @remote_host = remote_host
       @remote_port = remote_port
-      @message_id = 0
       @keep_alive = 10
       @clean_start = true
+      @client_id = random_letters(16)
+      @message_id = 0
+      @ack_timeout = 5
       @last_pingreq = Time.now
       @last_pingresp = Time.now
       @socket = nil
@@ -35,16 +40,12 @@ module MQTT
     
     # Connect to the MQTT broker
     # If a block is given, then yield to that block and then disconnect again.
-    def connect(clientid)
+    def connect(clientid=nil)
+      @client_id = clientid unless clientid.nil?
+    
       if not connected?
         # Create network socket
         @socket = TCPSocket.new(@remote_host,@remote_port)
-        
-        # Start packet reading thread
-        @read_thread = Thread.new(Thread.current) do |parent|
-          Thread.current[:parent] = parent
-          loop { receive_packet } 
-        end
 
         # Protocol name and version
         packet = MQTT::Packet.new(:type => :connect)
@@ -61,10 +62,19 @@ module MQTT
         packet.add_short(@keep_alive)
         
         # Add the client identifier
-        packet.add_string(clientid)
+        packet.add_string(@client_id)
         
         # Send packet
         send_packet(packet)
+
+        # Receive response
+        receive_connack
+        
+        # Start packet reading thread
+        @read_thread = Thread.new(Thread.current) do |parent|
+          Thread.current[:parent] = parent
+          loop { receive_packet } 
+        end
       end
       
       # If a block is given, then yield and disconnect
@@ -82,7 +92,7 @@ module MQTT
           packet = MQTT::Packet.new(:type => :disconnect)
           send_packet(packet)
         end
-        @read_thread.kill unless @read_thread.nil?
+        @read_thread.kill if @read_thread and @read_thread.alive?
         @read_thread = nil
         @socket.close unless @socket.nil?
         @socket = nil
@@ -222,6 +232,31 @@ module MQTT
       end
     end
   
+    # Read and check a connection acknowledgement packet
+    def receive_connack
+      Timeout.timeout(@ack_timeout) do
+        packet = MQTT::Packet.read(@socket)
+        if packet.type != :connack
+          raise MQTT::ProtocolException.new("Response wan't a connection acknowledgement: #{packet.type}") 
+        end
+        
+        # Read in the return code
+        byte1, return_code = packet.shift_bytes(2)
+        if return_code == 0x00
+          # Success
+          nil
+        elsif return_code == 0x01
+          raise MQTT::ProtocolException.new("Connection refused: unacceptable protocol version")
+        elsif return_code == 0x02
+          raise MQTT::ProtocolException.new("Connection refused: client identifier rejected")
+        elsif return_code == 0x03
+          raise MQTT::ProtocolException.new("Connection refused: broker unavailable")
+        else
+          raise MQTT::ProtocolException.new("Connection refused: #{return_code}")
+        end
+      end
+    end
+  
     # Send a packet to broker
     def send_packet(data)
       # Throw exception if we aren't connected
@@ -232,6 +267,24 @@ module MQTT
         @socket.write(data)
       end
     end
+
+    # Generate a string of random letters (0-9,a-z)
+    def random_letters(count)
+      str = ''
+      count.times do
+        num = rand(36)
+        if (num<10)
+          # Number
+          num += 48
+        else
+          # Letter
+          num += 87
+        end
+        str += num.chr
+      end
+      return str
+    end
+    
     
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mqtt
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Nicholas J Humfrey
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-02-03 00:00:00 +00:00
+date: 2009-02-08 00:00:00 +00:00
 default_executable: 
 dependencies: []