io-wait 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5ea39ff5c3815f098f8c15eb5b493e27408afda30a88d11cd00564ab85438639
+  data.tar.gz: 1a9ba20f028fe3259153bac2aa27b70870ef8e103d00c20cb6f7a267da94a6b5
+SHA512:
+  metadata.gz: bebdf7aba83d894c28fa9763b0048047c437c67962a939e3d29a6b4cbefe1ac690afd8ef8ed372d013204b1298f7fab0f01cd45c35ced0bb4d62e4234818f0ae
+  data.tar.gz: 0f9635692758b787c4dc873e449e0a3e893dee5427f122fbda17f9458d4f33916bd32c333bf76023a73285177ac70b4b576025504130423089467fdb703266b5

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.dll
+*.so

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.8.0
+before_install: gem install bundler -v 2.1.4

data/COPYING

@@ -0,0 +1,56 @@
+Ruby is copyrighted free software by Yukihiro Matsumoto <matz@netlab.jp>.
+You can redistribute it and/or modify it under either the terms of the
+2-clause BSDL (see the file BSDL), or the conditions below:
+
+1. You may make and give away verbatim copies of the source form of the
+   software without restriction, provided that you duplicate all of the
+   original copyright notices and associated disclaimers.
+
+2. You may modify your copy of the software in any way, provided that
+   you do at least ONE of the following:
+
+   a. place your modifications in the Public Domain or otherwise
+      make them Freely Available, such as by posting said
+      modifications to Usenet or an equivalent medium, or by allowing
+      the author to include your modifications in the software.
+
+   b. use the modified software only within your corporation or
+      organization.
+
+   c. give non-standard binaries non-standard names, with
+      instructions on where to get the original software distribution.
+
+   d. make other distribution arrangements with the author.
+
+3. You may distribute the software in object code or binary form,
+   provided that you do at least ONE of the following:
+
+   a. distribute the binaries and library files of the software,
+      together with instructions (in the manual page or equivalent)
+      on where to get the original distribution.
+
+   b. accompany the distribution with the machine-readable source of
+      the software.
+
+   c. give non-standard binaries non-standard names, with
+      instructions on where to get the original software distribution.
+
+   d. make other distribution arrangements with the author.
+
+4. You may modify and include the part of the software into any other
+   software (possibly commercial).  But some files in the distribution
+   are not written by the author, so that they are not under these terms.
+
+   For the list of those files and their copying conditions, see the
+   file LEGAL.
+
+5. The scripts and library files supplied as input to or produced as
+   output from the software do not automatically fall under the
+   copyright of the software, but belong to whomever generated them,
+   and may be sold commercially, and may be aggregated with this
+   software.
+
+6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+   IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+   WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+   PURPOSE.

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in etc.gemspec
+gemspec

data/README.md

@@ -0,0 +1,29 @@
+# io-wait
+
+This gem provides the feature for waiting until IO is readable or writable without blocking.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'io-wait'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install io-wait
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ruby/io-wait.

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test/lib"
+  t.ruby_opts << "-rhelper"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+require 'rake/extensiontask'
+Rake::ExtensionTask.new("io/wait")
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "io/wait"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ext/io/wait/depend

@@ -0,0 +1,18 @@
+# AUTOGENERATED DEPENDENCIES START
+wait.o: $(RUBY_EXTCONF_H)
+wait.o: $(arch_hdrdir)/ruby/config.h
+wait.o: $(hdrdir)/ruby.h
+wait.o: $(hdrdir)/ruby/assert.h
+wait.o: $(hdrdir)/ruby/backward.h
+wait.o: $(hdrdir)/ruby/defines.h
+wait.o: $(hdrdir)/ruby/encoding.h
+wait.o: $(hdrdir)/ruby/intern.h
+wait.o: $(hdrdir)/ruby/io.h
+wait.o: $(hdrdir)/ruby/missing.h
+wait.o: $(hdrdir)/ruby/onigmo.h
+wait.o: $(hdrdir)/ruby/oniguruma.h
+wait.o: $(hdrdir)/ruby/ruby.h
+wait.o: $(hdrdir)/ruby/st.h
+wait.o: $(hdrdir)/ruby/subst.h
+wait.o: wait.c
+# AUTOGENERATED DEPENDENCIES END

data/ext/io/wait/extconf.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: false
+require 'mkmf'
+target = "io/wait"
+
+unless macro_defined?("DOSISH", "#include <ruby.h>")
+  have_header(ioctl_h = "sys/ioctl.h") or ioctl_h = nil
+  fionread = %w[sys/ioctl.h sys/filio.h sys/socket.h].find do |h|
+    have_macro("FIONREAD", [h, ioctl_h].compact)
+  end
+  if fionread
+    $defs << "-DFIONREAD_HEADER=\"<#{fionread}>\""
+    create_makefile(target)
+  end
+else
+  if have_func("rb_w32_ioctlsocket", "ruby.h")
+    have_func("rb_w32_is_socket", "ruby.h")
+    create_makefile(target)
+  end
+end

data/ext/io/wait/wait.c

@@ -0,0 +1,253 @@
+/**********************************************************************
+
+  io/wait.c -
+
+  $Author$
+  created at: Tue Aug 28 09:08:06 JST 2001
+
+  All the files in this distribution are covered under the Ruby's
+  license (see the file COPYING).
+
+**********************************************************************/
+
+#include "ruby.h"
+#include "ruby/io.h"
+
+#include <sys/types.h>
+#if defined(HAVE_UNISTD_H) && (defined(__sun))
+#include <unistd.h>
+#endif
+#if defined(HAVE_SYS_IOCTL_H)
+#include <sys/ioctl.h>
+#endif
+#if defined(FIONREAD_HEADER)
+#include FIONREAD_HEADER
+#endif
+
+#ifdef HAVE_RB_W32_IOCTLSOCKET
+#define ioctl ioctlsocket
+#define ioctl_arg u_long
+#define ioctl_arg2num(i) ULONG2NUM(i)
+#else
+#define ioctl_arg int
+#define ioctl_arg2num(i) INT2NUM(i)
+#endif
+
+#ifdef HAVE_RB_W32_IS_SOCKET
+#define FIONREAD_POSSIBLE_P(fd) rb_w32_is_socket(fd)
+#else
+#define FIONREAD_POSSIBLE_P(fd) ((void)(fd),Qtrue)
+#endif
+
+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;
+    }
+    else {
+	*timerec = rb_time_interval(timeout);
+	return timerec;
+    }
+}
+
+static int
+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_io_check_closed(fptr);
+    return (i & events);
+}
+
+/*
+ * call-seq:
+ *   io.nread -> int
+ *
+ * Returns number of bytes that can be read without blocking.
+ * Returns zero if no information available.
+ */
+
+static VALUE
+io_nread(VALUE io)
+{
+    rb_io_t *fptr;
+    int len;
+    ioctl_arg n;
+
+    GetOpenFile(io, fptr);
+    rb_io_check_readable(fptr);
+    len = rb_io_read_pending(fptr);
+    if (len > 0) return INT2FIX(len);
+    if (!FIONREAD_POSSIBLE_P(fptr->fd)) return INT2FIX(0);
+    if (ioctl(fptr->fd, FIONREAD, &n)) return INT2FIX(0);
+    if (n > 0) return ioctl_arg2num(n);
+    return INT2FIX(0);
+}
+
+/*
+ * call-seq:
+ *   io.ready? -> true or false
+ *
+ * Returns true if input available without blocking, or false.
+ */
+
+static VALUE
+io_ready_p(VALUE io)
+{
+    rb_io_t *fptr;
+    struct timeval tv = {0, 0};
+
+    GetOpenFile(io, fptr);
+    rb_io_check_readable(fptr);
+    if (rb_io_read_pending(fptr)) return Qtrue;
+    if (wait_for_single_fd(fptr, RB_WAITFD_IN, &tv))
+	return Qtrue;
+    return Qfalse;
+}
+
+/*
+ * call-seq:
+ *   io.wait_readable          -> IO, true or nil
+ *   io.wait_readable(timeout) -> IO, true or nil
+ *
+ * Waits until IO is readable without blocking and returns +self+, or
+ * +nil+ when times out.
+ * Returns +true+ immediately when buffered data is available.
+ */
+
+static VALUE
+io_wait_readable(int argc, VALUE *argv, VALUE io)
+{
+    rb_io_t *fptr;
+    struct timeval timerec;
+    struct timeval *tv;
+
+    GetOpenFile(io, fptr);
+    rb_io_check_readable(fptr);
+    tv = get_timeout(argc, argv, &timerec);
+    if (rb_io_read_pending(fptr)) return Qtrue;
+    if (wait_for_single_fd(fptr, RB_WAITFD_IN, tv)) {
+	return io;
+    }
+    return Qnil;
+}
+
+/*
+ * call-seq:
+ *   io.wait_writable          -> IO
+ *   io.wait_writable(timeout) -> IO or nil
+ *
+ * Waits until IO is writable without blocking and returns +self+ or
+ * +nil+ when times out.
+ */
+static VALUE
+io_wait_writable(int argc, VALUE *argv, VALUE io)
+{
+    rb_io_t *fptr;
+    struct timeval timerec;
+    struct timeval *tv;
+
+    GetOpenFile(io, fptr);
+    rb_io_check_writable(fptr);
+    tv = get_timeout(argc, argv, &timerec);
+    if (wait_for_single_fd(fptr, RB_WAITFD_OUT, tv)) {
+	return io;
+    }
+    return Qnil;
+}
+
+static int
+wait_mode_sym(VALUE mode)
+{
+    if (mode == ID2SYM(rb_intern("r"))) {
+	return RB_WAITFD_IN;
+    }
+    if (mode == ID2SYM(rb_intern("read"))) {
+	return RB_WAITFD_IN;
+    }
+    if (mode == ID2SYM(rb_intern("readable"))) {
+	return RB_WAITFD_IN;
+    }
+    if (mode == ID2SYM(rb_intern("w"))) {
+	return RB_WAITFD_OUT;
+    }
+    if (mode == ID2SYM(rb_intern("write"))) {
+	return RB_WAITFD_OUT;
+    }
+    if (mode == ID2SYM(rb_intern("writable"))) {
+	return RB_WAITFD_OUT;
+    }
+    if (mode == ID2SYM(rb_intern("rw"))) {
+	return RB_WAITFD_IN|RB_WAITFD_OUT;
+    }
+    if (mode == ID2SYM(rb_intern("read_write"))) {
+	return RB_WAITFD_IN|RB_WAITFD_OUT;
+    }
+    if (mode == ID2SYM(rb_intern("readable_writable"))) {
+	return RB_WAITFD_IN|RB_WAITFD_OUT;
+    }
+    rb_raise(rb_eArgError, "unsupported mode: %"PRIsVALUE, mode);
+    return 0;
+}
+
+/*
+ * call-seq:
+ *   io.wait(timeout = nil, mode = :read) -> IO, true or nil
+ *
+ * Waits until IO is readable or writable without blocking and returns
+ * +self+, or +nil+ when times out.
+ * Returns +true+ immediately when buffered data is available.
+ * Optional parameter +mode+ is one of +:read+, +:write+, or
+ * +:read_write+.
+ */
+
+static VALUE
+io_wait_readwrite(int argc, VALUE *argv, VALUE io)
+{
+    rb_io_t *fptr;
+    struct timeval timerec;
+    struct timeval *tv = NULL;
+    int event = 0;
+    int i;
+
+    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]);
+	}
+    }
+    /* 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;
+    if (wait_for_single_fd(fptr, event, tv))
+	return io;
+    return Qnil;
+}
+
+/*
+ * IO wait methods
+ */
+
+void
+Init_wait(void)
+{
+    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_readwrite, -1);
+    rb_define_method(rb_cIO, "wait_readable", io_wait_readable, -1);
+    rb_define_method(rb_cIO, "wait_writable", io_wait_writable, -1);
+}

data/io-wait.gemspec

@@ -0,0 +1,22 @@
+Gem::Specification.new do |spec|
+  spec.name          = "io-wait"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Nobu Nakada"]
+  spec.email         = ["nobu@ruby-lang.org"]
+
+  spec.summary       = %q{Waits until IO is readable or writable without blocking.}
+  spec.description   = %q{Waits until IO is readable or writable without blocking.}
+  spec.homepage      = "https://github.com/ruby/io-wait"
+  spec.licenses      = ["Ruby", "BSD-2-Clause"]
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: io-wait
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nobu Nakada
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-09-18 00:00:00.000000000 Z
+dependencies: []
+description: Waits until IO is readable or writable without blocking.
+email:
+- nobu@ruby-lang.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- COPYING
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ext/io/wait/depend
+- ext/io/wait/extconf.rb
+- ext/io/wait/wait.c
+- io-wait.gemspec
+homepage: https://github.com/ruby/io-wait
+licenses:
+- Ruby
+- BSD-2-Clause
+metadata:
+  homepage_uri: https://github.com/ruby/io-wait
+  source_code_uri: https://github.com/ruby/io-wait
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.0.rc.1
+signing_key:
+specification_version: 4
+summary: Waits until IO is readable or writable without blocking.
+test_files: []