kgio.git  about / heads / tags
kinder, gentler I/O for Ruby
$ git log --pretty=format:'%h %s (%cs)%d' rbx-wip --
806c366 split read_write.c into {read,write,writev}.c (2013-11-21)
	(rbx-wip)
d4bc004 set RSTRING_MODIFIED where appropriate for Rubinius (2013-11-21)
e359d89 connect: constify RSTRING-related things (2013-11-21)
a8cb03f Rakefile: kill raa_update task (2013-09-30)
fc91f1d my_writev: stylistic fixes (2013-09-25)
13725d9 read_write: remove the rest of RARRAY_PTR usage (2013-09-25)
e0d3b3c tryopen: remove RARRAY_PTR usage in init (2013-09-25)
98bbc4b test_poll: remove race prone test_poll_EINTR_changed test (2013-09-25)
9bde3ab kgio 2.8.1 - minor improvements and test fixes (2013-09-11)
	(tag: v2.8.1)
c3be428 Close tempfile and unlink it immediately. (2013-09-07)
...

$ git cat-file blob rbx-wip:README
= kgio - kinder, gentler I/O for Ruby

kgio provides non-blocking I/O methods for Ruby without raising
exceptions on EAGAIN and EINPROGRESS.  It is intended for use with the
Unicorn and Rainbows! Rack servers, but may be used by other
applications (that run on Unix-like platforms).

== Features

* Can avoid expensive exceptions on common EAGAIN/EINPROGRESS errors,
  returning :wait_readable or :wait_writable instead.
  These exceptions got more expensive to hit under Ruby 1.9.2
  (but should be fixed in Ruby 1.9.3 to 1.9.1 performance levels)

* Returns the unwritten portion of the string on partial writes,
  making it ideal for buffering unwritten data.

* May call any method defined to be "kgio_wait_writable" or
  "kgio_wait_readable" methods to allow socket/pipe objects to make custom
  callbacks (such as adding the file descriptor to a poll set and yielding
  the current Fiber).

* Uses
  {accept4}[http://kernel.org/doc/man-pages/online/pages/man2/accept4.2.html]
  on new GNU/Linux systems to avoid unnecessary fcntl() calls

* Uses MSG_DONTWAIT on GNU/Linux to further avoid unnecessary fcntl() calls

* Compatible with existing Ruby IO objects and Ruby threading.

== Install

The library consists of a C extension so you'll need a Unix-like system
with a C compiler and Ruby development libraries/headers.

http://rubyforge.org/frs/?group_id=8977

You may also install it via RubyGems.org:

  gem install kgio

You can get the latest source via git from the following locations
(these versions may not be stable):

  git://bogomips.org/kgio.git
  git://repo.or.cz/kgio.git (mirror)

You may browse the code from the web and download the latest snapshot
tarballs here:

* http://bogomips.org/kgio.git (cgit)
* http://repo.or.cz/w/kgio.git (gitweb)

See the HACKING guide on how to contribute and build prerelease gems
from git.

== Contact

All feedback (bug reports, user/development dicussion, patches, pull
requests) go to the mailing list/newsgroup.  See the ISSUES document for
information on the {kgio mailing list}[mailto:kgio@librelist.org]

For the latest on kgio releases, you may check our NEWS page (and
subscribe to our Atom feed).

# heads (aka `branches'):
$ git for-each-ref --sort=-creatordate refs/heads \
	--format='%(HEAD) %(refname:short) %(subject) (%(creatordate:short))'
* master       drop remaining 1.8 and fragile autopush code paths (2023-09-10)
  rbx-wip      split read_write.c into {read,write,writev}.c (2013-11-21)
  2.4-stable   kgio 2.4.2 - OpenSolaris build fix (2011-06-14)

# tags:
$ git for-each-ref --sort=-creatordate refs/tags \
	--format='%(refname:short) %(subject) (%(creatordate:short))'
v2.11.4      kgio 2.11.4 (2021-05-25) tar.gz
v2.11.3      kgio 2.11.3 (2020-01-08) tar.gz
v2.11.2      kgio 2.11.2 - fix Ruby 2.5 compatibility for accept_class (2018-01-30) tar.gz
v2.11.1      kgio 2.11.1 - fix Ruby 2.5.0dev compatibility (2017-12-15) tar.gz
v2.11.0      kgio 2.11.0 - reverting 2.10.0 breakage (2016-12-16) tar.gz
v2.10.0      kgio 2.10.0 - slimming down... (2015-09-06) tar.gz
v2.9.3       kgio 2.9.3 - minor cleanups and fixes (2015-01-12) tar.gz
v2.9.2       kgio 2.9.2 - avoid deprecated/removed function (2014-02-15) tar.gz
v2.9.1       kgio 2.9.1 - various Ruby 1.8.7 fixes (2014-02-05) tar.gz
v2.9.0       kgio 2.9.0 - cleanups, bug fixes, minor improvements (2014-02-04) tar.gz
...

# associated public inboxes:
# (number on the left is used for dev purposes)
            https://yhbt.net/kgio-public

git clone git://yhbt.net/kgio.git
git clone https://yhbt.net/kgio.git