summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authornobu <nobu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2012-11-21 13:40:00 +0000
committernobu <nobu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2012-11-21 13:40:00 +0000
commite786aa711da8e64734d20acfd9c6b8df0b4515c5 (patch)
treede792c01c3a6f363bc09ec0c3ba4a9c7b709970b
parent7d0cabb8f881798da1332becf60096a09fbb6c01 (diff)
io/wait: add IO#wait_writable method
* ext/io/wait/wait.c (io_wait_writable): this is easier to use than IO.select for a single IO object and is immune to the limitations/innefficiency of select() on platforms where poll/ppoll is available. patched by Eric Wong. [Feature #4646] git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@37785 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
-rw-r--r--ChangeLog7
-rw-r--r--ext/io/wait/wait.c38
-rw-r--r--test/io/wait/test_io_wait.rb36
3 files changed, 81 insertions, 0 deletions
diff --git a/ChangeLog b/ChangeLog
index 15c5dccdb4..5a97441d06 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+Wed Nov 21 22:39:28 2012 Nobuyoshi Nakada <nobu@ruby-lang.org>
+
+ * ext/io/wait/wait.c (io_wait_writable): this is easier to use than
+ IO.select for a single IO object and is immune to the
+ limitations/innefficiency of select() on platforms where poll/ppoll
+ is available. patched by Eric Wong. [Feature #4646]
+
Wed Nov 21 22:27:52 2012 Narihiro Nakamura <authornari@gmail.com>
* gc.c (garbage_collect): remove a duplicative probe.
diff --git a/ext/io/wait/wait.c b/ext/io/wait/wait.c
index 197d9b6173..531b7efef2 100644
--- a/ext/io/wait/wait.c
+++ b/ext/io/wait/wait.c
@@ -133,6 +133,43 @@ io_wait(int argc, VALUE *argv, VALUE io)
}
/*
+ * call-seq:
+ * io.wait_writable -> IO
+ * io.wait_writable(timeout) -> IO or nil
+ *
+ * Waits until IO writable is available or times out and returns self or
+ * nil when EOF is reached.
+ */
+static VALUE
+io_wait_writable(int argc, VALUE *argv, VALUE io)
+{
+ rb_io_t *fptr;
+ int i;
+ VALUE timeout;
+ struct timeval timerec;
+ struct timeval *tv;
+
+ GetOpenFile(io, fptr);
+ rb_io_check_writable(fptr);
+ rb_scan_args(argc, argv, "01", &timeout);
+ if (NIL_P(timeout)) {
+ tv = NULL;
+ }
+ else {
+ timerec = rb_time_interval(timeout);
+ tv = &timerec;
+ }
+
+ i = rb_wait_for_single_fd(fptr->fd, RB_WAITFD_OUT, tv);
+ if (i < 0)
+ rb_sys_fail(0);
+ rb_io_check_closed(fptr);
+ if (i & RB_WAITFD_OUT)
+ return io;
+ return Qnil;
+}
+
+/*
* IO wait methods
*/
@@ -142,4 +179,5 @@ Init_wait()
rb_define_method(rb_cIO, "nread", io_nread, 0);
rb_define_method(rb_cIO, "ready?", io_ready_p, 0);
rb_define_method(rb_cIO, "wait", io_wait, -1);
+ rb_define_method(rb_cIO, "wait_writable", io_wait_writable, -1);
}
diff --git a/test/io/wait/test_io_wait.rb b/test/io/wait/test_io_wait.rb
index 3cf967e467..676809cfc7 100644
--- a/test/io/wait/test_io_wait.rb
+++ b/test/io/wait/test_io_wait.rb
@@ -1,3 +1,4 @@
+# -*- coding: us-ascii -*-
require 'test/unit'
require 'timeout'
require 'socket'
@@ -69,4 +70,39 @@ class TestIOWait < Test::Unit::TestCase
Thread.new { sleep 0.01; @w.close }
assert_nil @r.wait
end
+
+ def test_wait_writable
+ assert_equal @w, @w.wait_writable
+ end
+
+ def test_wait_writable_timeout
+ assert_equal @w, @w.wait_writable(0.001)
+ written = fill_pipe
+ assert_nil @w.wait_writable(0.001)
+ @r.read(written)
+ assert_equal @w, @w.wait_writable(0.001)
+ end
+
+ def test_wait_writable_EPIPE
+ fill_pipe
+ @r.close
+ assert_equal @w, @w.wait_writable
+ end
+
+ def test_wait_writable_closed
+ @w.close
+ assert_raises(IOError) { @w.wait_writable }
+ end
+
+private
+
+ def fill_pipe
+ written = 0
+ buf = " " * 4096
+ begin
+ written += @w.write_nonblock(buf)
+ rescue Errno::EAGAIN
+ return written
+ end while true
+ end
end if IO.method_defined?(:wait)