nio4r 0.3.0 → 0.3.1

data/README.md

@@ -156,10 +156,11 @@ top of. nio4r provides a minimal API such that individual Ruby implementers
 may choose to produce optimized versions for their platform, without having
 to maintain a large codebase.
 
-As of the time of writing, the current implementation is
-* ~200 lines of Ruby code
-* ~700 lines of "custom" C code (not counting libev)
-* ~400 lines of Java code
+As of the time of writing, the current implementation is (approximately):
+
+* 200 lines of Ruby code
+* 700 lines of "custom" C code (not counting libev)
+* 400 lines of Java code
 
 nio4r is also not a replacement for Kinder Gentler IO (KGIO), a set of
 advanced Ruby IO APIs. At some point in the future nio4r might provide a

data/ext/nio4r/org/nio4r/Nio4r.java

@@ -1,6 +1,8 @@
 package org.nio4r;
 
 import java.util.Iterator;
+import java.util.Map;
+import java.util.HashMap;
 import java.io.IOException;
 import java.nio.channels.Channel;
 import java.nio.channels.SocketChannel;
@@ -94,6 +96,7 @@ public class Nio4r implements Library {
 
     public class Selector extends RubyObject {
         private java.nio.channels.Selector selector;
+        private HashMap<SelectableChannel,SelectionKey> cancelledKeys;
 
         public Selector(final Ruby ruby, RubyClass rubyClass) {
             super(ruby, rubyClass);
@@ -101,8 +104,9 @@ public class Nio4r implements Library {
 
         @JRubyMethod
         public IRubyObject initialize(ThreadContext context) {
+            this.cancelledKeys = new HashMap<SelectableChannel,SelectionKey>();
             try {
-                selector = java.nio.channels.Selector.open();
+                this.selector = java.nio.channels.Selector.open();
             } catch(IOException ie) {
                 throw context.runtime.newIOError(ie.getLocalizedMessage());
             }
@@ -113,7 +117,7 @@ public class Nio4r implements Library {
         @JRubyMethod
         public IRubyObject close(ThreadContext context) {
             try {
-                selector.close();
+                this.selector.close();
             } catch(IOException ie) {
                 throw context.runtime.newIOError(ie.getLocalizedMessage());
             }
@@ -124,7 +128,7 @@ public class Nio4r implements Library {
         @JRubyMethod(name = "closed?")
         public IRubyObject isClosed(ThreadContext context) {
             Ruby runtime = context.getRuntime();
-            return selector.isOpen() ? runtime.getFalse() : runtime.getTrue();
+            return this.selector.isOpen() ? runtime.getFalse() : runtime.getTrue();
         }
 
         @JRubyMethod
@@ -147,12 +151,18 @@ public class Nio4r implements Library {
             int interestOps = Nio4r.symbolToInterestOps(runtime, channel, interests);
             SelectionKey key;
 
-            try {
-                key = channel.register(selector, interestOps);
-            } catch(java.lang.IllegalArgumentException ia) {
-                throw runtime.newArgumentError("mode not supported for this object: " + interests);
-            } catch(java.nio.channels.ClosedChannelException cce) {
-                throw context.runtime.newIOError(cce.getLocalizedMessage());
+            key = this.cancelledKeys.remove(channel);
+
+            if(key != null) {
+                key.interestOps(interestOps);
+            } else {
+                try {
+                    key = channel.register(this.selector, interestOps);
+                } catch(java.lang.IllegalArgumentException ia) {
+                    throw runtime.newArgumentError("mode not supported for this object: " + interests);
+                } catch(java.nio.channels.ClosedChannelException cce) {
+                    throw context.runtime.newIOError(cce.getLocalizedMessage());
+                }
             }
 
             RubyClass monitorClass = runtime.getModule("NIO").getClass("Monitor");
@@ -172,13 +182,14 @@ public class Nio4r implements Library {
             }
 
             SelectableChannel channel = (SelectableChannel)raw_channel;
-            SelectionKey key = channel.keyFor(selector);
+            SelectionKey key = channel.keyFor(this.selector);
 
             if(key == null)
                 return context.nil;
 
             Monitor monitor = (Monitor)key.attachment();
-            monitor.close(context);
+            monitor.close(context, runtime.getFalse());
+            cancelledKeys.put(channel, key);
 
             return monitor;
         }
@@ -193,7 +204,7 @@ public class Nio4r implements Library {
             }
 
             SelectableChannel channel = (SelectableChannel)raw_channel;
-            SelectionKey key = channel.keyFor(selector);
+            SelectionKey key = channel.keyFor(this.selector);
 
             if(key == null)
                 return context.nil;
@@ -222,11 +233,11 @@ public class Nio4r implements Library {
 
             RubyArray array = null;
             if(!block.isGiven()) {
-                array = runtime.newArray(selector.selectedKeys().size());
+                array = runtime.newArray(this.selector.selectedKeys().size());
             }
 
-            Iterator selectedKeys = selector.selectedKeys().iterator();
-            while (selectedKeys.hasNext()) {
+            Iterator selectedKeys = this.selector.selectedKeys().iterator();
+            while(selectedKeys.hasNext()) {
                 SelectionKey key = (SelectionKey)selectedKeys.next();
                 processKey(key);
                 selectedKeys.remove();
@@ -259,7 +270,7 @@ public class Nio4r implements Library {
             if(ready <= 0)
                 return context.nil;
 
-            Iterator selectedKeys = selector.selectedKeys().iterator();
+            Iterator selectedKeys = this.selector.selectedKeys().iterator();
             while (selectedKeys.hasNext()) {
                 SelectionKey key = (SelectionKey)selectedKeys.next();
                 processKey(key);
@@ -271,17 +282,25 @@ public class Nio4r implements Library {
         }
 
         private int doSelect(Ruby runtime, IRubyObject timeout) {
+            Iterator cancelledKeys = this.cancelledKeys.entrySet().iterator();
+            while(cancelledKeys.hasNext()) {
+                Map.Entry entry = (Map.Entry)cancelledKeys.next();
+                SelectionKey key = (SelectionKey)entry.getValue();
+                key.cancel();
+                cancelledKeys.remove();
+            }
+
             try {
                 if(timeout.isNil()) {
-                    return selector.select();
+                    return this.selector.select();
                 } else {
                     double t = RubyNumeric.num2dbl(timeout);
                     if(t == 0) {
-                        return selector.selectNow();
+                        return this.selector.selectNow();
                     } else if(t < 0) {
                         throw runtime.newArgumentError("time interval must be positive");
                     } else {
-                        return selector.select((long)(t * 1000));
+                        return this.selector.select((long)(t * 1000));
                     }
                 }
             } catch(IOException ie) {
@@ -304,11 +323,11 @@ public class Nio4r implements Library {
 
         @JRubyMethod
         public IRubyObject wakeup(ThreadContext context) {
-            if(!selector.isOpen()) {
+            if(!this.selector.isOpen()) {
                 throw context.getRuntime().newIOError("selector is closed");
             }
 
-            selector.wakeup();
+            this.selector.wakeup();
             return context.nil;
         }
     }
@@ -328,14 +347,14 @@ public class Nio4r implements Library {
             this.interests = interests;
             this.selector  = selector;
 
-            value  = context.nil;
-            closed = context.getRuntime().getFalse();
+            this.value  = context.nil;
+            this.closed = context.getRuntime().getFalse();
 
             return context.nil;
         }
 
-        public void setSelectionKey(SelectionKey k) {
-            key = k;
+        public void setSelectionKey(SelectionKey key) {
+            this.key = key;
             key.attach(this);
         }
 
@@ -362,7 +381,7 @@ public class Nio4r implements Library {
         @JRubyMethod(name = "readable?")
         public IRubyObject isReadable(ThreadContext context) {
             Ruby runtime  = context.getRuntime();
-            int  readyOps = key.readyOps();
+            int  readyOps = this.key.readyOps();
 
             if((readyOps & SelectionKey.OP_READ) != 0 || (readyOps & SelectionKey.OP_ACCEPT) != 0) {
                 return runtime.getTrue();
@@ -374,7 +393,7 @@ public class Nio4r implements Library {
         @JRubyMethod(name = {"writable?", "writeable?"})
         public IRubyObject writable(ThreadContext context) {
             Ruby runtime  = context.getRuntime();
-            int  readyOps = key.readyOps();
+            int  readyOps = this.key.readyOps();
 
             if((readyOps & SelectionKey.OP_WRITE) != 0 || (readyOps & SelectionKey.OP_CONNECT) != 0) {
                 return runtime.getTrue();
@@ -385,25 +404,35 @@ public class Nio4r implements Library {
 
         @JRubyMethod(name = "value")
         public IRubyObject getValue(ThreadContext context) {
-            return value;
+            return this.value;
         }
 
         @JRubyMethod(name = "value=")
         public IRubyObject setValue(ThreadContext context, IRubyObject obj) {
-            value = obj;
+            this.value = obj;
             return context.nil;
         }
 
         @JRubyMethod
         public IRubyObject close(ThreadContext context) {
-            key.cancel();
-            closed = context.getRuntime().getTrue();
+            return close(context, context.getRuntime().getTrue());
+        }
+
+        @JRubyMethod
+        public IRubyObject close(ThreadContext context, IRubyObject deregister) {
+            Ruby runtime = context.getRuntime();
+            this.closed = runtime.getTrue();
+
+            if(deregister == runtime.getTrue()) {
+                selector.callMethod(context, "deregister", io);
+            }
+
             return context.nil;
         }
 
         @JRubyMethod(name = "closed?")
         public IRubyObject isClosed(ThreadContext context) {
-            return closed;
+            return this.closed;
         }
     }
 }

data/ext/nio4r/selector.c

@@ -9,7 +9,6 @@
 #include <fcntl.h>
 
 static VALUE mNIO = Qnil;
-static VALUE cNIO_Channel  = Qnil;
 static VALUE cNIO_Monitor  = Qnil;
 static VALUE cNIO_Selector = Qnil;
 
@@ -52,8 +51,6 @@ static void NIO_Selector_wakeup_callback(struct ev_loop *ev_loop, struct ev_io *
 void Init_NIO_Selector()
 {
     mNIO = rb_define_module("NIO");
-    cNIO_Channel  = rb_define_class_under(mNIO, "Channel",  rb_cObject);
-    cNIO_Monitor  = rb_define_class_under(mNIO, "Monitor",  rb_cObject);
     cNIO_Selector = rb_define_class_under(mNIO, "Selector", rb_cObject);
     rb_define_alloc_func(cNIO_Selector, NIO_Selector_allocate);
 
@@ -66,6 +63,8 @@ void Init_NIO_Selector()
     rb_define_method(cNIO_Selector, "wakeup", NIO_Selector_wakeup, 0);
     rb_define_method(cNIO_Selector, "close", NIO_Selector_close, 0);
     rb_define_method(cNIO_Selector, "closed?", NIO_Selector_closed, 0);
+
+    cNIO_Monitor = rb_define_class_under(mNIO, "Monitor",  rb_cObject);
 }
 
 /* Create the libev event loop and incoming event buffer */

data/lib/nio/version.rb

@@ -1,3 +1,3 @@
 module NIO
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

data/spec/nio/selector_spec.rb

@@ -6,11 +6,13 @@ require 'spec_helper'
 TIMEOUT_PRECISION = 0.1
 
 describe NIO::Selector do
+  let(:pair)   { IO.pipe }
+  let(:reader) { pair.first }
+  let(:writer) { pair.last }
+
   context "register" do
     it "registers IO objects" do
-      pipe, _ = IO.pipe
-
-      monitor = subject.register(pipe, :r)
+      monitor = subject.register(reader, :r)
       monitor.should_not be_closed
     end
 
@@ -20,25 +22,37 @@ describe NIO::Selector do
   end
 
   it "knows which IO objects are registered" do
-    reader, writer = IO.pipe
     subject.register(reader, :r)
-
     subject.should be_registered(reader)
     subject.should_not be_registered(writer)
   end
 
   it "deregisters IO objects" do
-    pipe, _ = IO.pipe
+    subject.register(reader, :r)
 
-    subject.register(pipe, :r)
-    monitor = subject.deregister(pipe)
-    subject.should_not be_registered(pipe)
+    monitor = subject.deregister(reader)
+    subject.should_not be_registered(reader)
     monitor.should be_closed
   end
 
+  # This spec might seem a bit silly, but this actually something the
+  # Java NIO API specifically precludes that we need to work around
+  it "allows reregistration of the same IO object across select calls" do
+    monitor = subject.register(reader, :r)
+    writer << "ohai"
+
+    subject.select.should include monitor
+    reader.read(4).should == "ohai"
+    subject.deregister(reader)
+
+    new_monitor = subject.register(reader, :r)
+    writer << "thar"
+    subject.select.should include new_monitor
+    reader.read(4).should == "thar"
+  end
+
   context "timeouts" do
     it "waits for a timeout when selecting" do
-      reader, writer = IO.pipe
       monitor = subject.register(reader, :r)
 
       payload = "hi there"
@@ -56,7 +70,6 @@ describe NIO::Selector do
     end
 
     it "raises ArgumentError if given a negative timeout" do
-      reader, _ = IO.pipe
       subject.register(reader, :r)
 
       expect { subject.select(-1) }.to raise_exception(ArgumentError)
@@ -65,8 +78,7 @@ describe NIO::Selector do
 
   context "wakeup" do
     it "wakes up if signaled to from another thread" do
-      pipe, _ = IO.pipe
-      subject.register(pipe, :r)
+      subject.register(reader, :r)
 
       thread = Thread.new do
         started_at = Time.now
@@ -91,18 +103,16 @@ describe NIO::Selector do
 
   context "select" do
     it "selects IO objects" do
-      readable, writer = IO.pipe
       writer << "ohai"
+      unready, _ = IO.pipe
 
-      unreadable, _ = IO.pipe
-
-      readable_monitor   = subject.register(readable, :r)
-      unreadable_monitor = subject.register(unreadable, :r)
+      reader_monitor   = subject.register(reader, :r)
+      unready_monitor = subject.register(unready, :r)
 
       selected = subject.select(0)
       selected.size.should == 1
-      selected.should include(readable_monitor)
-      selected.should_not include(unreadable_monitor)
+      selected.should include(reader_monitor)
+      selected.should_not include(unready_monitor)
     end
 
     it "iterates across selected objects with a block" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nio4r
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler
-  requirement: &70285234600680 !ruby/object:Gem::Requirement
+  requirement: &70256512025560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70285234600680
+  version_requirements: *70256512025560
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70285234600040 !ruby/object:Gem::Requirement
+  requirement: &70256512024940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70285234600040
+  version_requirements: *70256512024940
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70285234599480 !ruby/object:Gem::Requirement
+  requirement: &70256512040740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70285234599480
+  version_requirements: *70256512040740
 description: New IO for Ruby
 email:
 - tony.arcieri@gmail.com