io-wait 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43e7f91045efd73e51af1a6e055afe646fc95d1b7c1a154453d915e6a213d223
-  data.tar.gz: 4d542bfb7bde6053c4069f451d41f39e05b77d0ebab5514532f601466ca57bba
+  metadata.gz: 630936f8af6e2cf9265ebff0794cab1daf10048933460b71306486aecb92a85a
+  data.tar.gz: 153bc0301fdb8fce6f4983d45879364509bb6534a81775d98e5f61b5ffe1923e
 SHA512:
-  metadata.gz: f78dc92e4500c196b69d87fb47f13f426f4a2d9b8532e69027d3c96a8dd93514d08c77adc421b8d3cac2e0aaf2f80d92327c98d95969a9816111b41c373fe10a
-  data.tar.gz: 4b2b4af88c93ddc7d12d1060f6f638aab6fc75178a32fe9810478a5b95e27575cbe1054c1e46964b7ca1eec1269f47b64bf823a990472363cb97c75236b4a438
+  metadata.gz: 07e0a9997d9e8dd84368feb0fdcd681282d7c583aea8d03d90abf031d6474224aa7a6f61050de11a03750cc0e20ba5759ac4eca28aae07891a778ef82cef24c6
+  data.tar.gz: 7294e823b4536cded39faead19916b437e4a8a4d398e35917c81e84d4618d5f99bd414aa9f6989cfad4bfb8bf0721fb7934b083a72576a7e95a60d7fcf35e853

data/ext/io/wait/wait.c

@@ -41,22 +41,17 @@
 #endif
 
 #ifndef HAVE_RB_IO_WAIT
-static VALUE io_ready_p _((VALUE io));
-static VALUE io_wait_readable _((int argc, VALUE *argv, VALUE io));
-static VALUE io_wait_writable _((int argc, VALUE *argv, VALUE io));
-void Init_wait _((void));
-
 static struct timeval *
 get_timeout(int argc, VALUE *argv, struct timeval *timerec)
 {
     VALUE timeout = Qnil;
     rb_check_arity(argc, 0, 1);
     if (!argc || NIL_P(timeout = argv[0])) {
-	return NULL;
+        return NULL;
     }
     else {
-	*timerec = rb_time_interval(timeout);
-	return timerec;
+        *timerec = rb_time_interval(timeout);
+        return timerec;
     }
 }
 
@@ -65,7 +60,7 @@ wait_for_single_fd(rb_io_t *fptr, int events, struct timeval *tv)
 {
     int i = rb_wait_for_single_fd(fptr->fd, events, tv);
     if (i < 0)
-	rb_sys_fail(0);
+        rb_sys_fail(0);
     rb_io_check_closed(fptr);
     return (i & events);
 }
@@ -100,21 +95,24 @@ io_nread(VALUE io)
 
 #ifdef HAVE_RB_IO_WAIT
 static VALUE
-io_wait_event(VALUE io, int event, VALUE timeout)
+io_wait_event(VALUE io, int event, VALUE timeout, int return_io)
 {
     VALUE result = rb_io_wait(io, RB_INT2NUM(event), timeout);
 
     if (!RB_TEST(result)) {
-	return Qnil;
+        return Qnil;
     }
 
     int mask = RB_NUM2INT(result);
 
     if (mask & event) {
-	return io;
+        if (return_io)
+            return io;
+        else
+            return result;
     }
     else {
-	return Qfalse;
+        return Qfalse;
     }
 }
 #endif
@@ -142,15 +140,15 @@ io_ready_p(VALUE io)
     if (rb_io_read_pending(fptr)) return Qtrue;
 
 #ifndef HAVE_RB_IO_WAIT
-    if (wait_for_single_fd(fptr, RB_WAITFD_IN, &tv))
-	return Qtrue;
+    return wait_for_single_fd(fptr, RB_WAITFD_IN, &tv) ? Qtrue : Qfalse;
 #else
-    if (RTEST(io_wait_event(io, RUBY_IO_READABLE, RB_INT2NUM(0))))
-	return Qtrue;
+    return io_wait_event(io, RUBY_IO_READABLE, RB_INT2NUM(0), 1);
 #endif
-    return Qfalse;
 }
 
+/* Ruby 3.2+ can define these methods. This macro indicates that case. */
+#ifndef RUBY_IO_WAIT_METHODS
+
 /*
  * call-seq:
  *   io.wait_readable          -> truthy or falsy
@@ -182,14 +180,14 @@ io_wait_readable(int argc, VALUE *argv, VALUE io)
 
 #ifndef HAVE_RB_IO_WAIT
     if (wait_for_single_fd(fptr, RB_WAITFD_IN, tv)) {
-	return io;
+        return io;
     }
     return Qnil;
 #else
     rb_check_arity(argc, 0, 1);
     VALUE timeout = (argc == 1 ? argv[0] : Qnil);
 
-    return io_wait_event(io, RUBY_IO_READABLE, timeout);
+    return io_wait_event(io, RUBY_IO_READABLE, timeout, 1);
 #endif
 }
 
@@ -218,14 +216,14 @@ io_wait_writable(int argc, VALUE *argv, VALUE io)
 #ifndef HAVE_RB_IO_WAIT
     tv = get_timeout(argc, argv, &timerec);
     if (wait_for_single_fd(fptr, RB_WAITFD_OUT, tv)) {
-	return io;
+        return io;
     }
     return Qnil;
 #else
     rb_check_arity(argc, 0, 1);
     VALUE timeout = (argc == 1 ? argv[0] : Qnil);
 
-    return io_wait_event(io, RUBY_IO_WRITABLE, timeout);
+    return io_wait_event(io, RUBY_IO_WRITABLE, timeout, 1);
 #endif
 }
 
@@ -236,7 +234,8 @@ io_wait_writable(int argc, VALUE *argv, VALUE io)
  *   io.wait_priority(timeout) -> truthy or falsy
  *
  * Waits until IO is priority and returns a truthy value or a falsy
- * value when times out.
+ * value when times out. Priority data is sent and received using
+ * the Socket::MSG_OOB flag and is typically limited to streams.
  *
  * You must require 'io/wait' to use this method.
  */
@@ -253,7 +252,7 @@ io_wait_priority(int argc, VALUE *argv, VALUE io)
     rb_check_arity(argc, 0, 1);
     VALUE timeout = argc == 1 ? argv[0] : Qnil;
 
-    return io_wait_event(io, RUBY_IO_PRIORITY, timeout);
+    return io_wait_event(io, RUBY_IO_PRIORITY, timeout, 1);
 }
 #endif
 
@@ -261,40 +260,52 @@ static int
 wait_mode_sym(VALUE mode)
 {
     if (mode == ID2SYM(rb_intern("r"))) {
-	return RB_WAITFD_IN;
+        return RB_WAITFD_IN;
     }
     if (mode == ID2SYM(rb_intern("read"))) {
-	return RB_WAITFD_IN;
+        return RB_WAITFD_IN;
     }
     if (mode == ID2SYM(rb_intern("readable"))) {
-	return RB_WAITFD_IN;
+        return RB_WAITFD_IN;
     }
     if (mode == ID2SYM(rb_intern("w"))) {
-	return RB_WAITFD_OUT;
+        return RB_WAITFD_OUT;
     }
     if (mode == ID2SYM(rb_intern("write"))) {
-	return RB_WAITFD_OUT;
+        return RB_WAITFD_OUT;
     }
     if (mode == ID2SYM(rb_intern("writable"))) {
-	return RB_WAITFD_OUT;
+        return RB_WAITFD_OUT;
     }
     if (mode == ID2SYM(rb_intern("rw"))) {
-	return RB_WAITFD_IN|RB_WAITFD_OUT;
+        return RB_WAITFD_IN|RB_WAITFD_OUT;
     }
     if (mode == ID2SYM(rb_intern("read_write"))) {
-	return RB_WAITFD_IN|RB_WAITFD_OUT;
+        return RB_WAITFD_IN|RB_WAITFD_OUT;
     }
     if (mode == ID2SYM(rb_intern("readable_writable"))) {
-	return RB_WAITFD_IN|RB_WAITFD_OUT;
+        return RB_WAITFD_IN|RB_WAITFD_OUT;
     }
     rb_raise(rb_eArgError, "unsupported mode: %"PRIsVALUE, mode);
     return 0;
 }
 
+#ifdef HAVE_RB_IO_WAIT
+static inline rb_io_event_t
+io_event_from_value(VALUE value)
+{
+    int events = RB_NUM2INT(value);
+
+    if (events <= 0) rb_raise(rb_eArgError, "Events must be positive integer!");
+
+    return events;
+}
+#endif
+
 /*
  * call-seq:
- *   io.wait(events, timeout) -> truthy or falsy
- *   io.wait(timeout = nil, mode = :read) -> truthy or falsy.
+ *   io.wait(events, timeout) -> event mask, false or nil
+ *   io.wait(timeout = nil, mode = :read) -> self, true, or false
  *
  * Waits until the IO becomes ready for the specified events and returns the
  * subset of events that become ready, or a falsy value when times out.
@@ -322,61 +333,77 @@ io_wait(int argc, VALUE *argv, VALUE io)
 
     GetOpenFile(io, fptr);
     for (i = 0; i < argc; ++i) {
-	if (SYMBOL_P(argv[i])) {
-	    event |= wait_mode_sym(argv[i]);
-	}
-	else {
-	    *(tv = &timerec) = rb_time_interval(argv[i]);
-	}
+        if (SYMBOL_P(argv[i])) {
+            event |= wait_mode_sym(argv[i]);
+        }
+        else {
+            *(tv = &timerec) = rb_time_interval(argv[i]);
+        }
     }
     /* rb_time_interval() and might_mode() might convert the argument */
     rb_io_check_closed(fptr);
     if (!event) event = RB_WAITFD_IN;
     if ((event & RB_WAITFD_IN) && rb_io_read_pending(fptr))
-	return Qtrue;
+        return Qtrue;
     if (wait_for_single_fd(fptr, event, tv))
-	return io;
+        return io;
     return Qnil;
 #else
     VALUE timeout = Qundef;
     rb_io_event_t events = 0;
+    int i, return_io = 0;
 
+    /* The documented signature for this method is actually incorrect.
+     * A single timeout is allowed in any position, and multiple symbols can be given.
+     * Whether this is intentional or not, I don't know, and as such I consider this to
+     * be a legacy/slow path. */
     if (argc != 2 || (RB_SYMBOL_P(argv[0]) || RB_SYMBOL_P(argv[1]))) {
-	for (int i = 0; i < argc; i += 1) {
-	    if (RB_SYMBOL_P(argv[i])) {
-		events |= wait_mode_sym(argv[i]);
-	    }
-	    else if (timeout == Qundef) {
-		rb_time_interval(timeout = argv[i]);
-	    }
-	    else {
-		rb_raise(rb_eArgError, "timeout given more than once");
-	    }
-	}
-	if (timeout == Qundef) timeout = Qnil;
+        /* We'd prefer to return the actual mask, but this form would return the io itself: */
+        return_io = 1;
+
+        /* Slow/messy path: */
+        for (i = 0; i < argc; i += 1) {
+            if (RB_SYMBOL_P(argv[i])) {
+                events |= wait_mode_sym(argv[i]);
+            }
+            else if (timeout == Qundef) {
+                rb_time_interval(timeout = argv[i]);
+            }
+            else {
+                rb_raise(rb_eArgError, "timeout given more than once");
+            }
+        }
+
+        if (timeout == Qundef) timeout = Qnil;
+
+        if (events == 0) {
+            events = RUBY_IO_READABLE;
+        }
     }
-    else /* argc == 2 */ {
-	events = RB_NUM2UINT(argv[0]);
-	timeout = argv[1];
-    }
-
-    if (events == 0) {
-	events = RUBY_IO_READABLE;
+    else /* argc == 2 and neither are symbols */ {
+        /* This is the fast path: */
+        events = io_event_from_value(argv[0]);
+        timeout = argv[1];
     }
 
     if (events & RUBY_IO_READABLE) {
-	rb_io_t *fptr = NULL;
-	RB_IO_POINTER(io, fptr);
-
-	if (rb_io_read_pending(fptr)) {
-	    return Qtrue;
-	}
+        rb_io_t *fptr = NULL;
+        RB_IO_POINTER(io, fptr);
+
+        if (rb_io_read_pending(fptr)) {
+            /* This was the original behaviour: */
+            if (return_io) return Qtrue;
+            /* New behaviour always returns an event mask: */
+            else return RB_INT2NUM(RUBY_IO_READABLE);
+        }
     }
 
-    return io_wait_event(io, events, timeout);
+    return io_wait_event(io, events, timeout, return_io);
 #endif
 }
 
+#endif /* RUBY_IO_WAIT_METHODS */
+
 /*
  * IO wait methods
  */
@@ -391,6 +418,7 @@ Init_wait(void)
     rb_define_method(rb_cIO, "nread", io_nread, 0);
     rb_define_method(rb_cIO, "ready?", io_ready_p, 0);
 
+#ifndef RUBY_IO_WAIT_METHODS
     rb_define_method(rb_cIO, "wait", io_wait, -1);
 
     rb_define_method(rb_cIO, "wait_readable", io_wait_readable, -1);
@@ -398,4 +426,5 @@ Init_wait(void)
 #ifdef HAVE_RB_IO_WAIT
     rb_define_method(rb_cIO, "wait_priority", io_wait_priority, -1);
 #endif
+#endif
 }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: io-wait
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Nobu Nakada
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-09 00:00:00.000000000 Z
+date: 2022-12-16 00:00:00.000000000 Z
 dependencies: []
 description: Waits until IO is readable or writable without blocking.
 email: