majordomo 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in rb-mdp.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/examples/sample_client.rb

@@ -0,0 +1,24 @@
+
+# Majordomo Protocol client example. Uses the mdcli API to hide all MDP aspects
+# Author : Mark Wotton <mark@ninjablocks.com>, modelled on python
+# version by Min RK <benjaminrk@gmail.com>
+
+require 'majordomo'
+ 
+client = Majordomo::Client.new("tcp://localhost:5773", true)
+count = 0
+while count < 100000
+  request = "Hello world"
+  begin
+    warn "sending"
+    reply = client.mdp_send("echo", request)
+  rescue => e
+    warn e
+    warn e.backtrace
+    break
+  end
+  break unless reply
+  raise "bad response: got #{reply}" unless reply == ["Hello world"]
+  count += 1
+  puts "#{count} requests/replies processed"
+end

data/examples/sample_worker.rb

@@ -0,0 +1,11 @@
+# -*- coding: utf-8 -*-
+require 'majordomo'
+
+worker = Majordomo::Worker.new "tcp://localhost:5773", "echo", true
+reply = nil
+while true
+  request = worker.recv(reply)
+  break unless request
+  puts "got a request: #{request}"
+  reply = request # Echo is complex… :-)
+end

data/lib/MDP.rb

@@ -0,0 +1,12 @@
+
+module MDP
+  W_READY     = "\x01"
+  W_REQUEST   = "\x02"
+  W_REPLY     = "\x03"
+  W_HEARTBEAT = "\x04"
+  W_WORKER    = 'MDPW01'
+
+  C_CLIENT    = 'MDPC01'
+  
+  
+end

data/lib/majordomo.rb

@@ -0,0 +1,13 @@
+require "majordomo/version"
+
+require 'majordomo/worker'
+require 'majordomo/client'
+module Majordomo
+  W_READY     = "\x01"
+  W_REQUEST   = "\x02"
+  W_REPLY     = "\x03"
+  W_HEARTBEAT = "\x04"
+  W_WORKER    = 'MDPW01'
+
+  C_CLIENT    = 'MDPC01'
+end

data/lib/majordomo/client.rb

@@ -0,0 +1,79 @@
+# -*- coding: utf-8 -*-
+"""Majordomo Protocol Client API, Python version.
+
+Implements the MDP/Worker spec at http:#rfc.zeromq.org/spec:7.
+
+Author: Min RK <benjaminrk@gmail.com>
+Based on Java example by Arkadiusz Orzechowski
+"""
+
+require 'ffi-rzmq'
+
+class Majordomo::Client
+  def initialize broker, verbose=false
+    @broker = broker
+    @verbose = verbose
+    @ctx = ZMQ::Context.new
+    @poller = ZMQ::Poller.new
+    @retries = 3
+    @timeout = 2500
+    reconnect_to_broker()
+  end
+
+  # Connect or reconnect to broker
+  def reconnect_to_broker
+    if @client
+      @poller.unregister(@client)
+      @client.close()
+    end
+    @client = @ctx.socket(ZMQ::REQ)
+    @client.setsockopt(ZMQ::LINGER, 0)
+    @client.connect(@broker)
+    @poller.register(@client, ZMQ::POLLIN)
+    warn "I: connecting to broker at #{@broker}…" if @verbose
+  end
+  
+  # Send request to broker and get reply by hook or crook.
+  # Takes ownership of request message and destroys it when sent.
+  # Returns the reply message or None if there was no reply.
+  def mdp_send  service, request
+    request = [Majordomo::C_CLIENT, service, request]
+    warn "I: send request to '#{service}' service: #{request}"    if @verbose
+    reply = nil
+    retries = @retries
+    while retries > 0
+      warn request
+      @client.send_strings(request)
+      begin
+        items = @poller.poll(@timeout)
+      rescue => e
+        break # interrupted
+      end
+      
+      if items
+        msg = []
+        @client.recv_strings(msg)
+        warn "I: received reply: #{msg}" if @verbose
+        
+        # Don't try to handle errors, just assert noisily
+        raise "expected at least three parts" unless msg.length >= 3
+        header, reply_service, *rest = *msg
+        raise "bad header #{header}" unless Majordomo::C_CLIENT == header
+        raise "bad service #{reply_service}" unless service == reply_service
+        
+        reply = rest
+        break
+      else
+        if retries
+          warn "W: no reply, reconnecting…"
+          reconnect_to_broker
+        else
+          warn "W: permanent error, abandoning"
+          break
+        end
+        retries -= 1
+      end
+    end
+    return reply
+  end
+end

data/lib/majordomo/version.rb

@@ -0,0 +1,3 @@
+module Majordomo
+  VERSION = "0.0.1"
+end

data/lib/majordomo/worker.rb

@@ -0,0 +1,163 @@
+# -*- coding: utf-8 -*-
+# Majordomo Protocol Worker API, Ruby version
+
+# Implements the MDP/Worker spec at http:#rfc.zeromq.org/spec:7.
+
+# Author: Mark Wotton <mark@ninjablocks.com>
+# Based on Python example by Min RK <benjaminrk@gmail.com>
+
+
+require 'ffi-rzmq'
+
+class Majordomo::Worker
+  HEARTBEAT_LIVENESS = 3 # 3-5 is reasonable
+  def initialize(broker, service, verbose=false)
+    @heartbeat_at = 0 # When to send HEARTBEAT (relative to time.time(), so in seconds)
+    @liveness = 0 # How many attempts left
+    @heartbeat = 2500 # Heartbeat delay, msecs
+    @reconnect = 2500 # Reconnect delay, msecs
+    
+    # Internal state
+    @expect_reply = false # false only at start
+
+    @timeout = 2500 # poller timeout
+
+    # Return address, if any
+    @reply_to = nil
+    
+
+    @broker = broker
+    @service = service
+    @verbose = verbose
+    @ctx = ZMQ::Context.new
+    @poller = ZMQ::Poller.new
+
+    reconnect_to_broker
+  end
+
+  def reconnect_to_broker
+    if @worker
+      @poller.unregister(@worker)
+      @worker.close()
+    end
+    @worker = @ctx.socket(ZMQ::DEALER)
+
+    @worker.setsockopt(ZMQ::LINGER, 0)
+    @worker.connect @broker
+    @poller.register @worker, ZMQ::POLLIN
+    warn "I: connecting to broker at #{@broker}…" if @verbose
+    # Register service with broker
+    send_to_broker Majordomo::W_READY, @service, []
+        
+    # If liveness hits zero, queue is considered disconnected
+    @liveness = HEARTBEAT_LIVENESS
+    @heartbeat_at = Time.now + 1e-3 * @heartbeat
+  end
+
+  def send_to_broker command, option=nil, msg=[]
+#    @worker.send_string '', ZMQ::SNDMORE
+    # ffi-rzmq is a bit weird about copying in raw bytes. need to
+    # explode the int first
+    
+ #   @worker.send_msg
+ #   @worker.send_string command, ZMQ::SNDMORE
+    
+    msg = [option] + msg if option
+
+    
+    msg = ['', Majordomo::W_WORKER, command] + msg
+    if @verbose
+      warn "I: sending #{command} to broker"
+    end
+    @worker.send_strings msg
+  end
+  
+  def recv(reply=nil)
+    # Format and send the reply if we were provided one
+    raise "bad reply" unless (reply  or not @expect_reply)
+      
+    if reply
+      raise "not expecting reply" unless @reply_to
+      warn reply.inspect
+      warn reply.class
+      reply = [@reply_to, ''] + reply
+      send_to_broker Majordomo::W_REPLY, nil, reply
+      
+      @expect_reply = true
+    end
+    while true
+      # Poll socket for a reply, with timeout
+      begin
+        items = @poller.poll(@timeout)
+      rescue => e
+        break # Interrupted
+      end    
+      if items
+        if (result = handle_message)
+
+          warn "result from handle_message: |#{result}|"
+          return result
+        end
+      else
+        reduce_liveness
+      end
+      # Send HEARTBEAT if it's time
+      if Time.now > @heartbeat_at
+        send_to_broker(Majordomo::W_HEARTBEAT)
+        @heartbeat_at = Time.now + 1e-3*@heartbeat
+      end
+    end
+    logging.warn("W: interrupt received, killing worker…")
+    return nil
+  end
+
+  def handle_message
+    msg = []
+    @worker.recv_strings(msg)
+    warn "I: received message from broker: #{msg} " if @verbose
+        
+    @liveness = @HEARTBEAT_LIVENESS
+    # Don't try to handle errors, just assert noisily
+    raise "expected at least 3 parts" unless msg.length >= 3
+    warn "full message: #{msg}"
+    empty, header, command, *rest = *msg
+
+    raise "no null frame" unless empty == ''
+    raise "bad protocol" unless header == Majordomo::W_WORKER
+    case command
+    when Majordomo::W_REQUEST
+      warn "request body: #{rest}"
+      # We should pop and save as many addresses as there are
+      # up to a null part, but for now, just save one…
+      raise "bad message" unless rest.length >= 2
+      @reply_to, empty, *body = *rest
+      warn "replyto = #{@reply_to}, body=#{body}"
+      # pop empty
+      raise "no null frame" unless empty == ''
+      
+      return body # We have a request to process
+    when Majordomo::W_HEARTBEAT
+      # Do nothing for heartbeats
+    when Majordomo::W_DISCONNECT
+      @reconnect_to_broker
+    else
+      warn "E: invalid input message: #{msg}"
+    end
+    return nil # only return message if we found one
+  end
+
+  def reduce_liveness
+    @liveness -= 1
+    if @liveness == 0
+      if @verbose
+        logging.warn("W: disconnected from broker - retrying…")
+      end
+      begin
+        time.sleep(1e-3*@reconnect)
+      rescue => e # KeyboardInterrupt:
+        return nil
+      end
+      reconnect_to_broker
+    end
+  end
+end

data/majordomo.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "majordomo/version"
+
+Gem::Specification.new do |s|
+  s.name        = "majordomo"
+  s.version     = Majordomo::VERSION
+  s.authors     = ["Mark Wotton"]
+  s.email       = ["mark@ninjablocks.com"]
+  s.homepage    = ""
+  s.summary     = %q{Majordomo for Ruby}
+  s.description = %q{Majordomo for Ruby}
+
+  s.rubyforge_project = "majordomo"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  s.add_runtime_dependency "ffi-rzmq"
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: majordomo
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Mark Wotton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi-rzmq
+  requirement: &14326140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *14326140
+description: Majordomo for Ruby
+email:
+- mark@ninjablocks.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Rakefile
+- examples/sample_client.rb
+- examples/sample_worker.rb
+- lib/MDP.rb
+- lib/majordomo.rb
+- lib/majordomo/client.rb
+- lib/majordomo/version.rb
+- lib/majordomo/worker.rb
+- majordomo.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: majordomo
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Majordomo for Ruby
+test_files: []