em-zeromq 0.2.1 → 0.2.2

data/README.md

@@ -1,65 +1,62 @@
 # em-zeromq #
 
-Low level event machine support for ZeroMQ
-
 ## Description: ##
 
-This seems to work fine, no memory leaks, and it runs fast.
-It may not be perfect though, and the API is extremely minimal, just the bare minumum
-to make ZeroMQ work with EventMachine.
+EventMachine support for ZeroMQ
 
-## Using: ##
+## Usage: ##
 
-You must use either rubinius, jruby, or 1.9.x. 1.8.7 does not work with libzmq.
+Tested and functional with Rubinius, jRuby, and 1.9.2.
 
-This only works with ZeroMQ 2.1.x which is still unreleased
-Build+Install ZeroMQ 2.1 from HEAD ( https://github.com/zeromq/zeromq2 ) 
+If using 1.9.2 you must `gem install ffi` before using.
 
-Run the specs, see specs for examples
+MRI 1.8.7 does not work with libzmq.
 
 Want to help out? Ask!
 
 ## Example ##
-    require 'rubygems'
-    require 'em-zeromq'
-        
-    Thread.abort_on_exception = true
-
-    class EMTestPullHandler
-      attr_reader :received
-      def on_readable(socket, messages)
-        messages.each do |m|
-          puts m.copy_out_string
-        end
-      end
-    end
-
-    EM.run do
-      ctx = EM::ZeroMQ::Context.new(1)
-      
-      # setup push sockets
-      push_socket1 = ctx.bind( ZMQ::PUSH, 'tcp://127.0.0.1:2091')
-      push_socket2 = ctx.bind( ZMQ::PUSH, 'ipc:///tmp/a')
-      push_socket3 = ctx.bind( ZMQ::PUSH, 'inproc://simple_test')
-      
-      # setup one pull sockets listening to both push sockets
-      pull_socket = ctx.connect( ZMQ::PULL, 'tcp://127.0.0.1:2091', EMTestPullHandler.new)
-      pull_socket.connect('ipc:///tmp/a')
-      pull_socket.connect('inproc://simple_test')
-      
-      n = 0
-      
-      # push_socket.hwm = 40
-      # puts push_socket.hwm
-      # puts pull_socket.hwm
-      
-      EM::PeriodicTimer.new(0.1) do
-        puts '.'
-        push_socket1.send_msg("t#{n += 1}_")
-        push_socket2.send_msg("i#{n += 1}_")
-        push_socket3.send_msg("p#{n += 1}_")
-      end
+```ruby
+require 'rubygems'
+require 'em-zeromq'
+    
+Thread.abort_on_exception = true
+
+class EMTestPullHandler
+  attr_reader :received
+  def on_readable(socket, messages)
+    messages.each do |m|
+      puts m.copy_out_string
     end
+  end
+end
+
+EM.run do
+  ctx = EM::ZeroMQ::Context.new(1)
+  
+  # setup push sockets
+  push_socket1 = ctx.bind( ZMQ::PUSH, 'tcp://127.0.0.1:2091')
+  push_socket2 = ctx.bind( ZMQ::PUSH, 'ipc:///tmp/a')
+  push_socket3 = ctx.bind( ZMQ::PUSH, 'inproc://simple_test')
+  
+  # setup one pull sockets listening to both push sockets
+  pull_socket = ctx.connect( ZMQ::PULL, 'tcp://127.0.0.1:2091', EMTestPullHandler.new)
+  pull_socket.connect('ipc:///tmp/a')
+  pull_socket.connect('inproc://simple_test')
+  
+  n = 0
+  
+  # push_socket.hwm = 40
+  # puts push_socket.hwm
+  # puts pull_socket.hwm
+  
+  EM::PeriodicTimer.new(0.1) do
+    puts '.'
+    push_socket1.send_msg("t#{n += 1}_")
+    push_socket2.send_msg("i#{n += 1}_")
+    push_socket3.send_msg("p#{n += 1}_")
+  end
+end
+```
 
 ## License: ##
 

data/em-zeromq.gemspec

@@ -15,10 +15,12 @@ Gem::Specification.new do |s|
 
   s.rubyforge_project = "em-zeromq"
 
-  s.add_dependency 'eventmachine', '>= 1.0.0.beta.3'
-  s.add_dependency 'ffi-rzmq', '>= 0.7.2'
+  s.add_dependency 'eventmachine', '>= 1.0.0.beta.4'
+  s.add_dependency 'ffi', '>= 1.0.0'
+  s.add_dependency 'ffi-rzmq', '~> 0.9.0'
 
   s.add_development_dependency 'rspec', '>= 2.5.0'
+  s.add_development_dependency 'rake'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/example/simple.rb

@@ -1,5 +1,5 @@
 require 'rubygems'
-$LOAD_PATH << File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'em-zeromq'
     
 Thread.abort_on_exception = true
@@ -13,6 +13,12 @@ class EMTestPullHandler
   end
 end
 
+trap('INT') do
+  EM::stop()
+end
+
+puts "Started (with zmq #{ZMQ::Util.version.join('.')})."
+
 EM.run do
   ctx = EM::ZeroMQ::Context.new(1)
   
@@ -21,16 +27,15 @@ EM.run do
   push_socket2 = ctx.bind( ZMQ::PUSH, 'ipc:///tmp/a')
   push_socket3 = ctx.bind( ZMQ::PUSH, 'inproc://simple_test')
   
-  # setup one pull sockets listening to both push sockets
+  # setup one pull sockets listening to all push sockets
   pull_socket = ctx.connect( ZMQ::PULL, 'tcp://127.0.0.1:2091', EMTestPullHandler.new)
   pull_socket.connect('ipc:///tmp/a')
   pull_socket.connect('inproc://simple_test')
   
   n = 0
   
-  # push_socket.hwm = 40
-  # puts push_socket.hwm
-  # puts pull_socket.hwm
+  push_socket1.hwm = 40
+  puts "HWM: #{push_socket1.hwm}"
   
   EM::PeriodicTimer.new(0.1) do
     puts '.'
@@ -39,3 +44,5 @@ EM.run do
     push_socket3.send_msg("p#{n += 1}_")
   end
 end
+
+puts "Completed."

data/lib/em-zeromq/connection.rb

@@ -69,7 +69,6 @@ module EventMachine
           # all the previous parts were queued, send
           # the last one
           @socket.send_string(parts[-1], ZMQ::NOBLOCK)
-          true
         else
           # error while sending the previous parts
           # register the socket for writability
@@ -143,8 +142,6 @@ module EventMachine
           @handler.on_writable(self)
         end
       end
-    private
-      # internal methods
       def readable?
         (@socket.getsockopt(ZMQ::EVENTS) & ZMQ::POLLIN) == ZMQ::POLLIN
       end
@@ -154,6 +151,10 @@ module EventMachine
         # ZMQ::EVENTS has issues in ZMQ HEAD, we'll ignore this till they're fixed
         # (@socket.getsockopt(ZMQ::EVENTS) & ZMQ::POLLOUT) == ZMQ::POLLOUT
       end
+     
+    private
+    
+      # internal methods
 
       def get_message
         msg       = ZMQ::Message.new

data/lib/em-zeromq/context.rb

@@ -7,8 +7,8 @@
 module EventMachine
   module ZeroMQ
     class Context
-      READABLES = [ ZMQ::SUB, ZMQ::PULL, ZMQ::XREQ, ZMQ::XREP, ZMQ::REP, ZMQ::REQ ]
-      WRITABLES = [ ZMQ::PUB, ZMQ::PUSH, ZMQ::XREQ, ZMQ::XREP, ZMQ::REP, ZMQ::REQ ]
+      READABLES = [ ZMQ::SUB, ZMQ::PULL, ZMQ::ROUTER, ZMQ::DEALER, ZMQ::REP, ZMQ::REQ ]
+      WRITABLES = [ ZMQ::PUB, ZMQ::PUSH, ZMQ::ROUTER, ZMQ::DEALER, ZMQ::REP, ZMQ::REQ ]
       
       def initialize(threads_or_context)
         if threads_or_context.is_a?(ZMQ::Context)
@@ -44,8 +44,9 @@ module EventMachine
         else
           socket.connect(address)
         end
-
-        conn = EM.watch(socket.getsockopt(ZMQ::FD), EventMachine::ZeroMQ::Connection, socket, socket_type, address, handler)
+        
+        fd = socket.getsockopt(ZMQ::FD)
+        conn = EM.watch(fd, EventMachine::ZeroMQ::Connection, socket, socket_type, address, handler)
 
         if READABLES.include?(socket_type)
           conn.register_readable

data/lib/em-zeromq/rzmq_compat.rb

@@ -0,0 +1,52 @@
+module RZMQCompat
+  class ZMQError < RuntimeError; end
+  class ZMQOperationFailed < ZMQError; end
+  
+  def self.included(klass)
+    klass.instance_eval do
+      %w(getsockopt recv).each do |m|
+        alias_method :"#{m}_without_raise", m.to_sym
+        alias_method m.to_sym, :"#{m}_with_raise"
+      end
+    end
+  end
+  
+  def getsockopt_with_raise(opt, *args)
+    arity = method(:getsockopt_without_raise).arity
+    if args.empty?
+      case arity
+      when 1
+        getsockopt_without_raise(opt)
+        
+      when 2
+        ret = []
+        rc = getsockopt_without_raise(opt, ret)
+        unless ZMQ::Util.resultcode_ok?(rc)
+          raise ZMQOperationFailed, "getsockopt: #{ZMQ.errno}"
+        end
+    
+        (ret.size == 1) ? ret[0] : ret
+  
+      else
+        raise "Unsupported version of ffi-rzmq, getsockopt takes #{arity} arguments"
+      end
+    
+    else
+      # just pass the call to the original method  
+      getsockopt_without_raise(opt, *args)
+    end
+  end
+  
+  def recv_with_raise(msg, flags = 0)
+    ret = recv_without_raise(msg, flags)
+    if (ret == true) || (ret == 0)
+      true
+    else
+      false
+    end
+  end
+  
+  
+end
+
+ZMQ::Socket.send(:include, RZMQCompat)

data/lib/em-zeromq/version.rb

@@ -1,4 +1,4 @@
 # encoding: utf-8
 module EmZeromq
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

data/spec/context_spec.rb

@@ -13,11 +13,11 @@ describe 'Context' do
   
   it 'can create socket' do
     EM::run do
-      s1 = @ctx.bind(:xreq, 'tcp://127.0.0.1:5555')
-      s2 = @ctx.bind('xreq', 'tcp://127.0.0.1:5556')
-      s3 = @ctx.bind(ZMQ::XREQ, 'tcp://127.0.0.1:5557')
+      s1 = @ctx.bind(:router, 'tcp://127.0.0.1:5555')
+      s2 = @ctx.bind('router', 'tcp://127.0.0.1:5556')
+      s3 = @ctx.bind(ZMQ::ROUTER, 'tcp://127.0.0.1:5557')
     
-      s1.instance_variable_get('@socket').name.should == 'XREQ'
+      s1.instance_variable_get('@socket').name.should == 'ROUTER'
       EM::stop_event_loop
     end
   end

data/spec/router_dealer_spec.rb

@@ -0,0 +1,80 @@
+require File.join(File.dirname(__FILE__), %w[spec_helper])
+
+describe EventMachine::ZeroMQ do
+  class EMTestRouterHandler
+    attr_reader :received
+    def initialize
+      @received = []
+    end
+    def on_writable(socket)
+    end
+    def on_readable(socket, messages)
+      @received += messages
+    end
+  end
+
+  class EMTestDealerHandler
+    attr_reader :received
+    def initialize(&block)
+      @received = []
+      @on_writable_callback = block
+    end
+    def on_writable(socket)
+      @on_writable_callback.call(socket) if @on_writable_callback
+    end
+    def on_readable(socket, messages)
+      ident, delim, message = messages.map(&:copy_out_string)
+      ident.should == "dealer1"
+      @received += [ident, delim, message].map {|s| ZMQ::Message.new(s)}
+      
+      socket.send_msg(ident, delim, "re:#{message}")
+    end
+  end
+
+  it "Should instantiate a connection given valid opts for Router/Dealer" do
+    router_conn = nil
+    run_reactor(1) do
+      router_conn = SPEC_CTX.bind(ZMQ::ROUTER, rand_addr, EMTestRouterHandler.new)
+    end
+    router_conn.should be_a(EventMachine::ZeroMQ::Connection)
+  end
+
+  describe "sending/receiving a single message via Router/Dealer" do
+    before(:all) do
+      results = {}
+      @test_message = test_message = "M#{rand(999)}"
+      
+      run_reactor(0.5) do
+        results[:dealer_hndlr] = dealer_hndlr = EMTestDealerHandler.new
+        results[:router_hndlr] = router_hndlr = EMTestRouterHandler.new
+
+        addr = rand_addr
+        dealer_conn = SPEC_CTX.bind(ZMQ::DEALER, addr, dealer_hndlr, :identity => "dealer1")
+        router_conn = SPEC_CTX.connect(ZMQ::ROUTER, addr, router_hndlr, :identity => "router1")
+        router_conn.send_msg('x', test_message)
+         
+        EM::Timer.new(0.1) do
+          results[:specs_ran] = true
+        end
+      end
+      
+      @results = results
+    end
+
+    it "should run completely" do
+      @results[:specs_ran].should be_true
+    end
+    
+    it "should receive the message intact on the dealer" do
+      @results[:dealer_hndlr].received.should_not be_empty
+      @results[:dealer_hndlr].received.last.should be_a(ZMQ::Message)
+      @results[:dealer_hndlr].received.last.copy_out_string.should == @test_message
+    end
+
+    it "the router should be echoed its original message" do
+      @results[:router_hndlr].received.should_not be_empty
+      @results[:router_hndlr].received.last.should be_a(ZMQ::Message)
+      @results[:router_hndlr].received.last.copy_out_string.should == "re:#{@test_message}"
+    end
+  end
+end

metadata

@@ -1,61 +1,78 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: em-zeromq
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.2.2
   prerelease: 
-  version: 0.2.1
 platform: ruby
-authors: 
+authors:
 - Andrew Cholakian
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-03-03 00:00:00 -08:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-11-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: eventmachine
+  requirement: &7728660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.beta.4
+  type: :runtime
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: *7728660
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: &7728080 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.0.0.beta.3
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: ffi-rzmq
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *7728080
+- !ruby/object:Gem::Dependency
+  name: ffi-rzmq
+  requirement: &7727520 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 0.7.2
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *7727520
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &7726580 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 2.5.0
   type: :development
-  version_requirements: *id003
+  prerelease: false
+  version_requirements: *7726580
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &7725760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *7725760
 description: Low level event machine support for ZeroMQ
-email: 
+email:
 - andrew@andrewvc.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .bnsignore
 - .gitignore
 - Gemfile
@@ -67,40 +84,37 @@ files:
 - lib/em-zeromq.rb
 - lib/em-zeromq/connection.rb
 - lib/em-zeromq/context.rb
+- lib/em-zeromq/rzmq_compat.rb
 - lib/em-zeromq/version.rb
 - spec/context_spec.rb
 - spec/pub_sub_spec.rb
 - spec/push_pull_spec.rb
+- spec/router_dealer_spec.rb
 - spec/spec_helper.rb
-- spec/xreq_xrep_spec.rb
-has_rdoc: true
 homepage: https://github.com/andrewvc/em-zeromq
 licenses: []
-
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --main
 - README.md
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: em-zeromq
-rubygems_version: 1.6.0
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Low level event machine support for ZeroMQ
 test_files: []
-

data/spec/xreq_xrep_spec.rb

@@ -1,77 +0,0 @@
-require File.join(File.dirname(__FILE__), %w[spec_helper])
-
-describe EventMachine::ZeroMQ do
-  class EMTestXREQHandler
-    attr_reader :received
-    def initialize
-      @received = []
-    end
-    def on_readable(socket, messages)
-      @received += messages
-    end
-  end
-
-  class EMTestXREPHandler
-    attr_reader :received
-    def initialize(&block)
-      @received = []
-      @on_writable_callback = block
-    end
-    def on_writable(socket)
-      @on_writable_callback.call(socket) if @on_writable_callback
-    end
-    def on_readable(socket, messages)
-      ident, delim, message = messages.map(&:copy_out_string)
-      ident.should == "req1"
-      @received += [ident, delim, message].map {|s| ZMQ::Message.new(s)}
-      
-      socket.send_msg(ident, delim, "re:#{message}")
-    end
-  end
-
-  it "Should instantiate a connection given valid opts" do
-    xreq_conn = nil
-    run_reactor(1) do
-      xreq_conn = SPEC_CTX.bind(ZMQ::XREQ, rand_addr, EMTestXREQHandler.new)
-    end
-    xreq_conn.should be_a(EventMachine::ZeroMQ::Connection)
-  end
-
-  describe "sending/receiving a single message via Xreq/Xrep" do
-    before(:all) do
-      results = {}
-      @test_message = test_message = "M#{rand(999)}"
-      
-      run_reactor(0.5) do
-        results[:xrep_hndlr] = xrep_hndlr = EMTestXREPHandler.new
-        results[:xreq_hndlr] = xreq_hndlr = EMTestXREQHandler.new
-        xreq_conn = SPEC_CTX.connect(ZMQ::XREQ, rand_addr, xreq_hndlr, :identity => "req1")
-        xreq_conn.send_msg('', test_message)
-        
-        xrep_conn = SPEC_CTX.bind(ZMQ::XREP, xreq_conn.address, xrep_hndlr, :identity => "rep1")
-         
-        EM::Timer.new(0.1) do
-          results[:specs_ran] = true
-        end
-      end
-      
-      @results = results
-    end
-
-    it "should run completely" do
-      @results[:specs_ran].should be_true
-    end
-    
-    it "should receive the message intact on the xrep" do
-      @results[:xrep_hndlr].received.should_not be_empty
-      @results[:xrep_hndlr].received.last.should be_a(ZMQ::Message)
-      @results[:xrep_hndlr].received.last.copy_out_string.should == @test_message
-    end
-
-    it "the xreq should be echoed its original message" do
-      @results[:xreq_hndlr].received.should_not be_empty
-      @results[:xreq_hndlr].received.last.should be_a(ZMQ::Message)
-      @results[:xreq_hndlr].received.last.copy_out_string.should == "re:#{@test_message}"
-    end
-  end
-end