celluloid-zmq 0.0.1 → 0.0.2

data/CHANGES.md

@@ -0,0 +1,7 @@
+0.0.2
+-----
+* Pure blocking 0MQ reactor using a ZMQ::PAIR socket as the waker
+
+0.0.1
+-----
+* Initial release

data/celluloid-zmq.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |gem|
 
   gem.add_development_dependency "rake"
   gem.add_development_dependency "rspec", ">= 2.7.0"
-  
+
   # Files
   ignores = File.read(".gitignore").split(/\r?\n/).reject{ |f| f =~ /^(#.+|\s*)$/ }.map {|f| Dir[f] }.flatten
   gem.files = (Dir['**/*','.gitignore'] - ignores).reject {|f| !File.file?(f) }

data/lib/celluloid/zmq.rb

@@ -4,13 +4,24 @@ require 'celluloid'
 require 'celluloid/zmq/mailbox'
 require 'celluloid/zmq/reactor'
 require 'celluloid/zmq/version'
+require 'celluloid/zmq/waker'
 
 module Celluloid
   # Actors which run alongside 0MQ sockets
   module ZMQ
-    def self.included(klass)
-      klass.send :include, ::Celluloid
-      klass.use_mailbox Celluloid::ZMQ::Mailbox
+    class << self
+      attr_writer :context
+
+      # Included hook to pull in Celluloid
+      def included(klass)
+        klass.send :include, ::Celluloid
+        klass.use_mailbox Celluloid::ZMQ::Mailbox
+      end
+
+      # Obtain a 0MQ context (or lazily initialize it)
+      def context
+        @context ||= ::ZMQ::Context.new(1)
+      end
     end
 
     # Wait for the given IO object to become readable

data/lib/celluloid/zmq/mailbox.rb

@@ -5,9 +5,9 @@ module Celluloid
       def initialize
         @messages = []
         @lock  = Mutex.new
-        @waker = Celluloid::IO::Waker.new
+        @waker = Celluloid::ZMQ::Waker.new
         @reactor = Reactor.new(@waker)
       end
     end
   end
-end
+end

data/lib/celluloid/zmq/reactor.rb

@@ -9,14 +9,10 @@ module Celluloid
         @readers = {}
         @writers = {}
 
-        # FIXME: The way things are presently implemented is super ghetto
-        # The ZMQ::Poller should be able to wait on the waker somehow
-        # but I can't get it to work :(
-        #result = @poller.register(nil, ::ZMQ::POLLIN, @waker.io.fileno)
-        #
-        #unless ::ZMQ::Util.resultcode_ok?(result)
-        #  raise "couldn't register waker with 0MQ poller"
-        #end
+        rc = @poller.register @waker.socket, ::ZMQ::POLLIN
+        unless ::ZMQ::Util.resultcode_ok? rc
+          raise "0MQ poll error: #{::ZMQ::Util.error_string}"
+        end
       end
 
       # Wait for the given ZMQ socket to become readable
@@ -47,26 +43,25 @@ module Celluloid
       # Run the reactor, waiting for events, and calling the given block if
       # the reactor is awoken by the waker
       def run_once(timeout = nil)
-        # FIXME: This approach is super ghetto. Find some way to make the
-        # ZMQ::Poller wait on the waker's file descriptor
-        if @poller.size == 0
-          readable, _ = select [@waker.io], [], [], timeout
-          yield if readable and readable.include? @waker.io
-        else
-          if ::ZMQ::Util.resultcode_ok? @poller.poll(100)
-            @poller.readables.each do |sock|
-              fiber = @readers.delete sock
-              fiber.resume if fiber
-            end
+        timeout ||= :blocking
+        rc = @poller.poll(timeout)
 
-            @poller.writables.each do |sock|
-              fiber = @writers.delete sock
-              fiber.resume if fiber
-            end
+        unless ::ZMQ::Util.resultcode_ok? rc
+          raise IOError, "0MQ poll error: #{::ZMQ::Util.error_string}"
+        end
+
+        @poller.readables.each do |sock|
+          if sock == @waker.socket
+            yield
+          else
+            fiber = @readers.delete sock
+            fiber.resume if fiber
           end
+        end
 
-          readable, _ = select [@waker.io], [], [], 0
-          yield if readable and readable.include? @waker.io
+        @poller.writables.each do |sock|
+          fiber = @writers.delete sock
+          fiber.resume if fiber
         end
       end
     end

data/lib/celluloid/zmq/version.rb

@@ -1,5 +1,5 @@
 module Celluloid
   module ZMQ
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

data/lib/celluloid/zmq/waker.rb

@@ -0,0 +1,54 @@
+module Celluloid
+  module ZMQ
+    class DeadWakerError < Celluloid::IO::DeadWakerError; end # You can't wake the dead
+
+    # Wakes up sleepy threads so that they can check their mailbox
+    # Works like a ConditionVariable, except it's implemented as a ZMQ socket
+    # so that it can be multiplexed alongside other ZMQ sockets
+    class Waker
+      PAYLOAD = "\0" # the payload doesn't matter, it's just a signal
+
+      def initialize
+        @sender   = ZMQ.context.socket(::ZMQ::PAIR)
+        @receiver = ZMQ.context.socket(::ZMQ::PAIR)
+
+        @addr = "inproc://waker-#{object_id}"
+        @sender.bind @addr
+        @receiver.connect @addr
+
+        @sender_lock = Mutex.new
+      end
+
+      # Wakes up the thread that is waiting for this Waker
+      def signal
+        @sender_lock.synchronize do
+          unless ::ZMQ::Util.resultcode_ok? @sender.send_string PAYLOAD
+            raise DeadWakerError, "error sending 0MQ message: #{::ZMQ::Util.error_string}"
+          end
+        end
+      end
+
+      # 0MQ socket to wait for messages on
+      def socket
+        @receiver
+      end
+
+      # Wait for another thread to signal this Waker
+      def wait
+        message = ''
+  	    rc = @receiver.recv_string message
+
+  	    unless ::ZMQ::Util.resultcode_ok? rc and message == PAYLOAD
+  	      raise DeadWakerError, "error receiving ZMQ string: #{::ZMQ::Util.error_string}"
+  	    end
+      end
+
+      # Clean up the IO objects associated with this waker
+      def cleanup
+        @sender_lock.synchronize { @sender.close rescue nil }
+        @receiver.close rescue nil
+        nil
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: celluloid-zmq
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: celluloid
-  requirement: &70334545596400 !ruby/object:Gem::Requirement
+  requirement: &70257579473040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 0.6.2
   type: :runtime
   prerelease: false
-  version_requirements: *70334545596400
+  version_requirements: *70257579473040
 - !ruby/object:Gem::Dependency
   name: ffi
-  requirement: &70334545595980 !ruby/object:Gem::Requirement
+  requirement: &70257579472580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70334545595980
+  version_requirements: *70257579472580
 - !ruby/object:Gem::Dependency
   name: ffi-rzmq
-  requirement: &70334545595500 !ruby/object:Gem::Requirement
+  requirement: &70257579472120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70334545595500
+  version_requirements: *70257579472120
 - !ruby/object:Gem::Dependency
   name: redis
-  requirement: &70334545595000 !ruby/object:Gem::Requirement
+  requirement: &70257579471700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70334545595000
+  version_requirements: *70257579471700
 - !ruby/object:Gem::Dependency
   name: redis-namespace
-  requirement: &70334545594480 !ruby/object:Gem::Requirement
+  requirement: &70257579471260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70334545594480
+  version_requirements: *70257579471260
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70334545593840 !ruby/object:Gem::Requirement
+  requirement: &70257579470560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70334545593840
+  version_requirements: *70257579470560
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70334545592940 !ruby/object:Gem::Requirement
+  requirement: &70257579469580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,7 @@ dependencies:
         version: 2.7.0
   type: :development
   prerelease: false
-  version_requirements: *70334545592940
+  version_requirements: *70257579469580
 description: Celluloid bindings to the ffi-rzmq library
 email:
 - tony.arcieri@gmail.com
@@ -96,10 +96,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - celluloid-zmq.gemspec
+- CHANGES.md
 - Gemfile
 - lib/celluloid/zmq/mailbox.rb
 - lib/celluloid/zmq/reactor.rb
 - lib/celluloid/zmq/version.rb
+- lib/celluloid/zmq/waker.rb
 - lib/celluloid/zmq.rb
 - Rakefile
 - README.md