= ruby-mqtt

Pure Ruby gem that implements the MQTT (Message Queue Telemetry Transport) protocol, a lightweight protocol for publish/subscribe messaging.

RubyForge Project Page  http://rubyforge.org/projects/mqtt/

== Installing

You may get the latest stable version from Rubyforge. Source gems are also available.

  $ gem install mqtt

== Synopsis

  require 'rubygems'
  require 'mqtt/client'
  
  # 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


== TODO

* Implement Will and Testament
* Process acknowledgement packets / Implement QOS 1 in client
* More validations of data/parameters
* More error checking and exception throwing
  - Check that packet data is valid - don't blindly read values
  - Subscribe and Unsubscribe packets should always have QOS of 1
* More examples
* Integration tests
* Refactor to add callbacks that are called from seperate thread
* Implement QOS Level 2 in client
* Prevent proxy from connecting to itself
* Add support for binding socket to specific local address

== Resources

http://www.mqtt.org

== Contact

Author::     Nicholas J Humfrey
Email::      njh@aelius.com
Home Page::  http://www.aelius.com/njh/
License::    Distributes under the same terms as Ruby