celluloid-io 0.7.0 → 0.8.0

data/.travis.yml

@@ -1,7 +1,7 @@
 rvm:
   - 1.9.2
   - 1.9.3
-#  - rbx # crashing :(
+#  - rbx crashing :(
   - jruby
   - ruby-head
 

data/CHANGES.md

@@ -1,3 +1,8 @@
+0.8.0
+-----
+* Switch to nio4r-based reactor
+* Compatibility with Celluloid 0.8.0 API changes
+
 0.7.0
 -----
 * Initial release forked from Celluloid

data/README.md

@@ -35,36 +35,38 @@ Usage
 
 To use Celluloid::IO, define a normal Ruby class that includes Celluloid::IO:
 
-    require 'celluloid/io'
-
-	class MyServer
-	  include Celluloid::IO
-
-	  # Bind a TCP server to the given host and port
-	  def initialize(host, port)
-	    @server = TCPServer.new host, port
-	    run!
-	  end
-
-	  # Run the TCP server event loop
-	  def run
-	    while true
-	      wait_readable(@server)
-	      on_connect @server.accept
-	    end
-	  end
-
-	  # Terminate this server
-	  def terminate
-	    @server.close
-	    super
-	  end
-
-	  # Called whenever a new connection is opened
-	  def on_connect(connection)
-	    connection.close
-	  end
-	end
+```ruby
+require 'celluloid/io'
+
+class MyServer
+  include Celluloid::IO
+
+  # Bind a TCP server to the given host and port
+  def initialize(host, port)
+    @server = TCPServer.new host, port
+    run!
+  end
+
+  # Run the TCP server event loop
+  def run
+    while true
+      wait_readable(@server)
+      on_connect @server.accept
+    end
+  end
+
+  # Terminate this server
+  def terminate
+    @server.close
+    super
+  end
+
+  # Called whenever a new connection is opened
+  def on_connect(connection)
+    connection.close
+  end
+end
+```
 
 Contributing to Celluloid::IO
 -----------------------------

data/celluloid-io.gemspec

@@ -15,8 +15,9 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = Celluloid::IO::VERSION
 
-  gem.add_development_dependency('celluloid', '>= 0.7.0')
+  gem.add_dependency 'celluloid', '~> 0.8.0'
+  gem.add_dependency 'nio4r',     '>= 0.2.2'
   
-  gem.add_development_dependency('rake')
-  gem.add_development_dependency('rspec', ['>= 2.7.0'])
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec', '~> 2.7.0'
 end

data/lib/celluloid/io.rb

@@ -1,9 +1,9 @@
 require 'celluloid/io/version'
 
+require 'forwardable'
 require 'celluloid'
 require 'celluloid/io/mailbox'
 require 'celluloid/io/reactor'
-require 'celluloid/io/waker'
 
 module Celluloid
   # Actors with evented IO support
@@ -13,15 +13,9 @@ module Celluloid
       klass.use_mailbox Celluloid::IO::Mailbox
     end
 
-    # Wait for the given IO object to become readable
-    def wait_readable(io, &block)
-      # Law of demeter be damned!
-      current_actor.mailbox.reactor.wait_readable(io, &block)
-    end
+    extend Forwardable
 
-    # Wait for the given IO object to become writeable
-    def wait_writeable(io, &block)
-      current_actor.mailbox.reactor.wait_writeable(io, &block)
-    end
+    # Wait for the given IO object to become readable/writeable
+    def_delegators 'current_actor.mailbox.reactor', :wait_readable, :wait_writeable
   end
 end

data/lib/celluloid/io/mailbox.rb

@@ -1,24 +1,23 @@
 module Celluloid
   module IO
-    # An alternative implementation of Celluloid::Mailbox using Wakers
+    # An alternative implementation of Celluloid::Mailbox using Reactor
     class Mailbox < Celluloid::Mailbox
-      attr_reader :reactor, :waker
+      attr_reader :reactor
 
       def initialize
         @messages = []
         @lock  = Mutex.new
-        @waker = Waker.new
-        @reactor = Reactor.new(@waker)
+        @reactor = Reactor.new
       end
 
       # Add a message to the Mailbox
       def <<(message)
         @lock.synchronize do
           @messages << message
-          @waker.signal
+          @reactor.wakeup
         end
         nil
-      rescue DeadWakerError
+      rescue IOError
         raise MailboxError, "dead recipient"
       end
 
@@ -26,10 +25,10 @@ module Celluloid
       def system_event(event)
         @lock.synchronize do
           @messages.unshift event
-
+          
           begin
-            @waker.signal
-          rescue DeadWakerError
+            @reactor.wakeup
+          rescue IOError
             # Silently fail if messages are sent to dead actors
           end
         end
@@ -38,35 +37,33 @@ module Celluloid
 
       # Receive a message from the Mailbox
       def receive(timeout = nil, &block)
-        message = nil
+        message = next_message(&block)
 
-        begin
+        until message
           if timeout
-             now = Time.now
-             wait_until ||= now + timeout
-             wait_interval = wait_until - now
-             return if wait_interval < 0
-           else
-             wait_interval = nil
-           end
-
-          @reactor.run_once(wait_interval) do
-            @waker.wait
-            message = next_message(&block)
+            now = Time.now
+            wait_until ||= now + timeout
+            wait_interval = wait_until - now
+            return if wait_interval < 0
+          else
+            wait_interval = nil
           end
-        end until message
+          
+          @reactor.run_once(wait_interval)
+          message = next_message(&block)
+        end
 
         message
-      rescue IOError, DeadWakerError
+      rescue IOError
         shutdown # force shutdown of the mailbox
         raise MailboxShutdown, "mailbox shutdown called during receive"
       end
 
       # Cleanup any IO objects this Mailbox may be using
       def shutdown
-        @waker.cleanup
+        @reactor.shutdown
         super
       end
     end
   end
-end
+end

data/lib/celluloid/io/reactor.rb

@@ -1,45 +1,33 @@
+require 'nio'
+
 module Celluloid
   module IO
     # React to external I/O events. This is kinda sorta supposed to resemble the
     # Reactor design pattern.
     class Reactor
-      def initialize(waker)
-        @waker = waker
-        @readers = {}
-        @writers = {}
+      extend Forwardable
+
+      # Unblock the reactor (i.e. to signal it from another thread)
+      def_delegator :@selector, :wakeup
+      # Terminate the reactor
+      def_delegator :@selector, :close, :shutdown
+
+      def initialize
+        @selector = NIO::Selector.new
       end
 
       # Wait for the given IO object to become readable
       def wait_readable(io)
-        wait_for_io io, @readers
+        wait io, :r
       end
 
       # Wait for the given IO object to become writeable
       def wait_writeable(io)
-        wait_for_io io, @writers
-      end
-
-      # Run the reactor, waiting for events, and calling the given block if
-      # the reactor is awoken by the waker
-      def run_once(timeout = nil)
-        readers, writers = select(@readers.keys << @waker.io, @writers.keys, [], timeout)
-        return unless readers
-
-        yield if readers.include? @waker.io
-
-        [[readers, @readers], [writers, @writers]].each do |ios, registered|
-          ios.each do |io|
-            task = registered.delete io
-            task.resume if task
-          end
-        end
+        wait io, :w
       end
-
-      #######
-      private
-      #######
-
-      def wait_for_io(io, set)
+      
+      # Wait for the given IO operation to complete
+      def wait(io, set)
         # zomg ugly type conversion :(
         unless io.is_a?(IO)
           if IO.respond_to? :try_convert
@@ -49,14 +37,18 @@ module Celluloid
           else raise TypeError, "can't convert #{io.class} into IO"
           end
         end
-
-        if set.has_key? io
-          raise ArgumentError, "another method is already waiting on #{io.inspect}"
-        else
-          set[io] = Task.current
+        
+        monitor = @selector.register(io, set)
+        monitor.value = Task.current
+        Task.suspend :iowait
+      end
+      
+      # Run the reactor, waiting for events or wakeup signal
+      def run_once(timeout = nil)
+        @selector.select_each(timeout) do |monitor|
+          monitor.value.resume
+          @selector.deregister(monitor.io)
         end
-
-        Task.suspend
       end
     end
   end

data/lib/celluloid/io/version.rb

@@ -1,5 +1,5 @@
 module Celluloid
   module IO
-    VERSION = "0.7.0"
+    VERSION = "0.8.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: celluloid-io
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,22 +9,33 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-29 00:00:00.000000000 Z
+date: 2012-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: celluloid
-  requirement: &70176481988080 !ruby/object:Gem::Requirement
+  requirement: &70254645083180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70254645083180
+- !ruby/object:Gem::Dependency
+  name: nio4r
+  requirement: &70254645082660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.7.0
-  type: :development
+        version: 0.2.2
+  type: :runtime
   prerelease: false
-  version_requirements: *70176481988080
+  version_requirements: *70254645082660
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70176481987440 !ruby/object:Gem::Requirement
+  requirement: &70254645082180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,18 +43,18 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70176481987440
+  version_requirements: *70254645082180
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70176481986860 !ruby/object:Gem::Requirement
+  requirement: &70254645081480 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 2.7.0
   type: :development
   prerelease: false
-  version_requirements: *70176481986860
+  version_requirements: *70254645081480
 description: Evented IO for Celluloid actors
 email:
 - tony.arcieri@gmail.com
@@ -64,10 +75,8 @@ files:
 - lib/celluloid/io/mailbox.rb
 - lib/celluloid/io/reactor.rb
 - lib/celluloid/io/version.rb
-- lib/celluloid/io/waker.rb
 - spec/celluloid/io/actor_spec.rb
 - spec/celluloid/io/mailbox_spec.rb
-- spec/celluloid/io/waker_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/tarcieri/celluloid-io
 licenses: []
@@ -97,5 +106,5 @@ summary: Celluloid::IO allows you to monitor multiple IO objects within a Cellul
 test_files:
 - spec/celluloid/io/actor_spec.rb
 - spec/celluloid/io/mailbox_spec.rb
-- spec/celluloid/io/waker_spec.rb
 - spec/spec_helper.rb
+has_rdoc: 

data/lib/celluloid/io/waker.rb

@@ -1,43 +0,0 @@
-module Celluloid
-  module IO
-    class DeadWakerError < StandardError; 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 an IO object so
-    # that it can be multiplexed alongside other IO objects.
-    class Waker
-      PAYLOAD = "\0" # the payload doesn't matter. each byte is a signal
-      def initialize
-        @receiver, @sender = ::IO.pipe
-      end
-
-      # Wakes up the thread that is waiting for this Waker
-      def signal
-        @sender << PAYLOAD
-        nil
-      rescue IOError, Errno::EPIPE, Errno::EBADF
-        raise DeadWakerError, "waker is already dead"
-      end
-
-      # Wait for another thread to signal this Waker
-      def wait
-          byte = @receiver.read(1)
-          raise DeadWakerError, "can't wait on a dead waker" unless byte == PAYLOAD
-      rescue IOError, RuntimeError
-          raise DeadWakerError, "can't wait on a dead waker"
-      end
-
-      # Return the IO object which will be readable when this Waker is signaled
-      def io
-        @receiver
-      end
-
-      # Clean up the IO objects associated with this waker
-      def cleanup
-        @receiver.close rescue nil
-        @sender.close rescue nil
-        nil
-      end
-    end
-  end
-end

data/spec/celluloid/io/waker_spec.rb

@@ -1,34 +0,0 @@
-require 'spec_helper'
-
-describe Celluloid::IO::Waker do
-  it "blocks until awoken" do
-    waker = Celluloid::IO::Waker.new
-    thread = Thread.new do
-      waker.wait
-      :done
-    end
-
-    # Assert that the thread can't be joined at this point
-    thread.join(0).should be_nil
-
-    waker.signal
-    thread.value.should == :done
-  end
-
-  it "returns an IO object that can be multiplexed with IO.select" do
-    waker = Celluloid::IO::Waker.new
-    waker.io.should be_an_instance_of(IO)
-
-    thread = Thread.new do
-      readable, _, _ = select [waker.io]
-      waker.wait
-      :done
-    end
-
-    # Assert that the thread can't be joined at this point
-    thread.join(0).should be_nil
-
-    waker.signal
-    thread.value.should == :done
-  end
-end