io-epoll 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c4f6bb1879b7524f23926e37da7c5fe53dec55b4
-  data.tar.gz: a0b1c12561b78414aa9f9fb3b567be508daf2685
+  metadata.gz: f1d5379f3b1a1f7630975f462c9580f0156d53b0
+  data.tar.gz: f9627c3a392a839c64b204aeae939d1fbf8da753
 SHA512:
-  metadata.gz: be6db2e498ced13bb8d5219f1d2ab60386cd00b8d3311887ad9dbf13feae7d902a59e8a096103cb16007a4c6944020ba58de827f46691e30316c7db9fa004c65
-  data.tar.gz: 736de758a7a0a143b51fca8831d5679bac11c66033e40c6d6cfcba14fc5cceefabe1a5a649007c13dfd5a66b884094090b3c4864931b1fe3aaae41ece987b946
+  metadata.gz: 10dfbf4366e5c54dbad66a2bf33d822851d9e2481eda47007348b7446c7939433efd0272bb65a918bec2c6c4486b57a9f1a067c045222d84eeb9831852bf1cd4
+  data.tar.gz: 0bf8d0e53cfb0bd207ed962341481c30c561301752b8f50e4a7767adef959950cd80f4d55644eddcdd7a09711804ffa6e8c2e8b3c1cb7aa5ac7fced2c23e46f5

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.4
+  - 2.2.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    io-epoll (0.0.1)
+    io-epoll (0.0.2)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,6 +1,8 @@
 io-epoll
 ===
 
+[![Build Status](https://travis-ci.org/ksss/io-epoll.svg?branch=master)](https://travis-ci.org/ksss/io-epoll)
+
 An experimental binding of epoll(7).
 
 **epoll(7)** can use Linux only. (because must be installed sys/epoll.h)
@@ -14,24 +16,32 @@ IO.epoll([io1, io2, io3], Epoll::IN) do |ev|
   # ev is IO::Epoll::Event object like `struct epoll_event`
   # it's have data and events properties
 
-  # events is event flag bits (Fixnum)
+  # IO::Epoll::Event#events is event flag bits (Fixnum)
   events = ev.events
 
-  # data is notificated IO (IO)
+  # IO::Epoll::Event#data is notified IO (IO)
   data = ev.data
 end
 
+# or
+
+# evlist is Array of IO::Epoll::Event
+# it's just short hand for epoll_create(2) -> epoll_ctl(2) -> epoll_wait(2)
+evlist = IO.epoll([io1, io2, io3], Epoll::IN)
+
 # on other way, you can make instance of IO::Epoll
 
 Epoll = IO::Epoll
 
 # IO::Epoll.create
-#   run epoll_create(2)
+#   call epoll_create(2)
 #   it's just alias of `new`
+#   Epoll object stock a File Descriptor returned by epoll_create(2)
+#   return: instance of IO::Epoll
 epoll = Epoll.create
 
 # IO::Epoll#ctl(option, io, flag)
-#   run epoll_ctl(2)
+#   call epoll_ctl(2)
 #   option: you can choice epoll_ctl option in CTL_ADD, CTL_MOD and CTL_DEL.
 #     CTL_ADD: add io list to watching for created epoll fd
 #     CTL_MOD: you can change io events
@@ -39,6 +49,7 @@ epoll = Epoll.create
 #   io: set an IO object for watching.
 #   flag: set flag bits like Epoll::IN|Epoll::OUT|Epoll::ONESHOT etc...
 #     see also man epoll_ctl(2)
+#   return: self
 epoll.ctl(Epoll::CTL_ADD, io, Epoll::IN)
 
 # and you can use short way
@@ -47,13 +58,35 @@ epoll.mod(io, Epoll::OUT) # same way to epoll.ctl(Epoll::CTL_MOD, io, Epoll::IN)
 epoll.del(io)             # same way to epoll.ctl(Epoll::CTL_DEL, io)
 
 # IO::Epoll#wait(timeout=-1)
-#   run epoll_wait(2)
+#   call epoll_wait(2)
 #   timeout = -1: block until receive event or signals
 #   timeout = 0: return all io's can I/O on non block
 #   timeout > 0: block when timeout pass miri second or receive events or signals
+#   return: Array of IO::Epoll::Event
 evlist = epoll.wait
+
+# you can close File Descriptor for epoll when finish to use
+epoll.close #=> nil
+
+# and you can check closed
+epoll.closed? #=> true
 ```
 
+## Event flags
+
+event flags|ctl|wait|description
+---|---|---|---
+**IO::Epoll::IN**|o|o|readable
+**IO::Epoll::PRI**|o|o|high priority read
+**IO::Epoll::HUP**|o|o|peer socket was shutdown
+**IO::Epoll::OUT**|o|o|writable
+**IO::Epoll::ET**|o|x|use edge trigger
+**IO::Epoll:ONESHOT**|o|x|auto watching stop when notified(but stay in list)
+**IO::Epoll::ERR**|x|o|raise error
+**IO::Epoll::HUP**|x|o|raise hang up
+
+see also **man epoll(7)**
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/Rakefile

@@ -2,10 +2,11 @@ require "bundler/gem_tasks"
 require 'rake/extensiontask'
 require 'rake/testtask'
 
+task :default => [:compile, :test]
+
 Rake::ExtensionTask.new('epoll') do |ext|
   ext.name = 'epoll'
   ext.ext_dir = 'ext/io/epoll'
   ext.lib_dir = 'lib/io/epoll'
 end
 Rake::TestTask.new {|t| t.libs << 'test'}
-

data/ext/io/epoll/epoll.c

@@ -89,24 +89,26 @@ rb_epoll_ctl(int argc, VALUE *argv, VALUE self)
   VALUE flag;
   VALUE io;
   VALUE events;
+  rb_io_t *fptr;
   int fd;
 
   switch (rb_scan_args(argc, argv, "21", &flag, &io, &events)) {
   case 2:
-    if (FIX2INT(flag) != EPOLL_CTL_DEL) {
+    if (FIX2INT(flag) != EPOLL_CTL_DEL)
       rb_raise(rb_eArgError, "too few argument for CTL_ADD or CTL_MOD");
-    }
     break;
   case 3:
-    if (FIX2INT(flag) != EPOLL_CTL_ADD && FIX2INT(flag) != EPOLL_CTL_MOD) {
+    if (FIX2INT(flag) != EPOLL_CTL_ADD && FIX2INT(flag) != EPOLL_CTL_MOD)
       rb_raise(rb_eArgError, "too many argument for CTL_DEL");
-    }
-    ev.events = FIX2INT(events);
+    if ((FIX2LONG(events) & (EPOLLIN|EPOLLPRI|EPOLLRDHUP|EPOLLOUT|EPOLLET|EPOLLONESHOT)) == 0)
+      rb_raise(rb_eIOError, "undefined events");
+    ev.events = FIX2LONG(events);
     ev.data.ptr = (void*)io;
     break;
   }
 
-  fd = RFILE(io)->fptr->fd;
+  GetOpenFile(rb_io_get_io(io), fptr);
+  fd = fptr->fd;
 
   if (epoll_ctl(ptr->epfd, FIX2INT(flag), fd, &ev) == -1) {
     char buf[128];
@@ -148,15 +150,18 @@ rb_epoll_wait(int argc, VALUE *argv, VALUE self)
 {
   struct Epoll *ptr = get_epoll(self);
   VALUE ready_evlist;
+  VALUE cEvent;
   VALUE event;
   struct epoll_event *evlist;
   int i, ready;
   int timeout = -1;
   struct epoll_wait_args data;
 
-  if (argc == 1) {
+  if (argc == 1)
     timeout = FIX2INT(argv[0]);
-  }
+  if (ptr->ev_len <= 0)
+    rb_raise(rb_eIOError, "empty interest list");
+
   evlist = ruby_xmalloc(ptr->ev_len * sizeof(struct epoll_event));
 
   data.ptr = ptr;
@@ -176,10 +181,11 @@ RETRY:
   }
 
   ready_evlist = rb_ary_new_capa(ready);
+  cEvent = rb_path2class("IO::Epoll::Event");
   for (i = 0; i < ready; i++) {
-    event = rb_obj_alloc(rb_path2class("IO::Epoll::Event"));
+    event = rb_obj_alloc(cEvent);
     RSTRUCT_SET(event, 0, (VALUE) evlist[i].data.ptr);
-    RSTRUCT_SET(event, 1, INT2FIX(evlist[i].events));
+    RSTRUCT_SET(event, 1, LONG2FIX(evlist[i].events));
     rb_ary_store(ready_evlist, i, event);
   }
   ruby_xfree(evlist);

data/io-epoll.gemspec

@@ -1,11 +1,11 @@
 Gem::Specification.new do |spec|
   spec.name          = "io-epoll"
-  spec.version       = "0.0.1"
+  spec.version       = "0.0.2"
   spec.authors       = ["ksss"]
   spec.email         = ["co000ri@gmail.com"]
   spec.summary       = %q{An experimental binding of epoll(7)}
   spec.description   = %q{An experimental binding of epoll(7)}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/ksss/io-epoll"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

data/lib/io/epoll.rb

@@ -27,6 +27,7 @@ class IO
   end
 
   def self.epoll(ios, events)
+    ios = ios.to_a
     open_len = ios.length
     ep = Epoll.create
     ios.each do |io|
@@ -43,9 +44,11 @@ class IO
           end
         end
       end
-      nil
+      ep.close
     else
-      ep.wait
+      evlist = ep.wait
+      ep.close
+      evlist
     end
   end
 end

data/test/test_epoll.rb

@@ -5,32 +5,35 @@ require_relative '../lib/io/epoll'
 class TestIOEpoll < Test::Unit::TestCase
   def test_initalize
     assert_instance_of(IO::Epoll, IO::Epoll.new);
+    assert_instance_of(IO::Epoll, IO::Epoll.create);
   end
 
   def test_fileno
-    assert { 0 < IO::Epoll.new.fileno }
+    assert { 0 < IO::Epoll.create.fileno }
   end
 
   def test_ctl
-    ep = IO::Epoll.new
+    ep = IO::Epoll.create
     io = IO.new(1, 'w')
+    assert { ep == ep.ctl(IO::Epoll::CTL_ADD, io , IO::Epoll::OUT) }
     assert_raise(ArgumentError) { ep.ctl }
     assert_raise(ArgumentError) { ep.ctl(IO::Epoll::CTL_ADD) }
     assert_raise(ArgumentError) { ep.ctl(IO::Epoll::CTL_ADD, io) }
-    assert { ep == ep.ctl(IO::Epoll::CTL_ADD, io , IO::Epoll::OUT) }
     assert_raise(ArgumentError) { ep.ctl(-1, io) }
+    assert_raise(TypeError) { ep.ctl(nil, nil, nil) }
   end
 
   def test_add
-    ep = IO::Epoll.new
+    ep = IO::Epoll.create
     io = IO.new(1, 'w')
-    assert { ep == ep.add(io, IO::Epoll::OUT) }
+    assert_raise(IOError) { ep.add(io, 0) }
+    assert { ep == ep.add(io, IO::Epoll::IN|IO::Epoll::PRI|IO::Epoll::RDHUP|IO::Epoll::ET|IO::Epoll::OUT) }
     ep.close
     assert_raise(Errno::EBADF) { ep.add(io, IO::Epoll::OUT) }
   end
 
   def test_mod
-    ep = IO::Epoll.new
+    ep = IO::Epoll.create
     io = IO.new(1, 'w')
     assert_raise(Errno::ENOENT) { ep.mod(io, IO::Epoll::IN) }
     ep == ep.add(io, IO::Epoll::OUT)
@@ -40,7 +43,7 @@ class TestIOEpoll < Test::Unit::TestCase
   end
 
   def test_del
-    ep = IO::Epoll.new
+    ep = IO::Epoll.create
     io = IO.new(1, 'w')
     assert_raise(Errno::ENOENT) { ep.del(io) }
     ep.add(io, IO::Epoll::OUT)
@@ -50,15 +53,16 @@ class TestIOEpoll < Test::Unit::TestCase
   end
 
   def test_wait
-    ep = IO::Epoll.new
-    io1 = IO.new(1, 'w')
-    io2 = IO.new(2, 'w')
-    ep.add(io1, IO::Epoll::OUT)
-    assert { [IO::Epoll::Event.new(io1, IO::Epoll::OUT)] == ep.wait }
+    ep = IO::Epoll.create
+    io = IO.new(1, 'w')
+    ep.add(io, IO::Epoll::IN|IO::Epoll::PRI|IO::Epoll::RDHUP|IO::Epoll::ET|IO::Epoll::OUT)
+    assert { [IO::Epoll::Event.new(io, IO::Epoll::OUT)] == ep.wait }
+    assert_raise(TypeError) { ep.wait(nil) }
+    assert_raise(IOError) { IO::Epoll.create.wait }
   end
 
   def test_wait_with_timeout
-    ep = IO::Epoll.new
+    ep = IO::Epoll.create
     io = IO.new(1, 'w')
     ep.add(io, IO::Epoll::IN)
     assert { [] == ep.wait(0) }
@@ -69,7 +73,7 @@ class TestIOEpoll < Test::Unit::TestCase
   end
 
   def test_size
-    ep = IO::Epoll.new
+    ep = IO::Epoll.create
     io = IO.new(0, 'r')
     ep.add(io, IO::Epoll::IN)
     assert { 1 == ep.size }
@@ -78,7 +82,7 @@ class TestIOEpoll < Test::Unit::TestCase
   end
 
   def test_close_closed?
-    ep = IO::Epoll.new
+    ep = IO::Epoll.create
     assert { false == ep.closed? }
     assert { nil == ep.close }
     assert_raise(IOError){ ep.close }
@@ -96,6 +100,9 @@ class TestIOEpoll < Test::Unit::TestCase
     evs = IO.epoll([r], IO::Epoll::IN)
     assert { 'ok' == evs[0].data.read }
     assert { false == evs[0].data.closed? }
+    assert_raise(IOError) { IO.epoll(nil, nil) }
+    assert_raise(IOError) { IO.epoll([], nil) }
+    assert_raise(TypeError) { IO.epoll([nil], nil) }
   end
 
   def test_epoll_with_block
@@ -114,7 +121,7 @@ class TestIOEpoll < Test::Unit::TestCase
   end
 
   def test_thread
-    ep = IO::Epoll.new
+    ep = IO::Epoll.create
     io = IO.new(1, 'w')
     ep.add(io, IO::Epoll::OUT)
     ret = nil

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: io-epoll
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - ksss
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-30 00:00:00.000000000 Z
+date: 2014-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -75,6 +75,7 @@ extensions:
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -85,7 +86,7 @@ files:
 - io-epoll.gemspec
 - lib/io/epoll.rb
 - test/test_epoll.rb
-homepage: ''
+homepage: https://github.com/ksss/io-epoll
 licenses:
 - MIT
 metadata: {}