kgio.git  about / heads / tags
kinder, gentler I/O for Ruby
$ git log --pretty=format:'%h %s (%cs)%d' v2.11.2 --
a0df956 kgio 2.11.2 - fix Ruby 2.5 compatibility for accept_class (2018-01-30)
	(tag: v2.11.2)
36ea339 accept: avoid passing unnecessary arg to rb_funcall (2018-01-19)
64118fb kgio 2.11.1 - fix Ruby 2.5.0dev compatibility (2017-12-15)
	(tag: v2.11.1)
aa1da2e wait: avoid passing unnecessary args to rb_funcall (2017-12-15)
9f9bf3b HACKING: fix linkifcation for Message-IDs (2016-12-16)
04433bc README: formatting fix (2016-12-16)
1ab0dee various documentation updates (2016-12-16)
8e17346 kgio 2.11.0 - reverting 2.10.0 breakage (2016-12-16)
	(tag: v2.11.0)
b5a3b17 test: increase test data sizes to fill socket buffers (2016-12-16)
696fdb1 TODO: update with Ruby 2.3 status (2016-12-16)
...

$ git cat-file blob v2.11.2:README
= kgio - kinder, gentler I/O for Ruby

This is a legacy project, do not use it for new projects.  Ruby
2.3 and later should make this obsolete.  kgio provides
non-blocking I/O methods for Ruby without raising exceptions on
EAGAIN and EINPROGRESS.

== 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 were fixed in Ruby 1.9.3 and later to 1.9.1 performance levels,
  which were still bad)

* 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://man7.org/linux/man-pages/man2/accept4.2.html]
  on newer 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.
You may 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:

* https://bogomips.org/kgio.git
* 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-public@bogomips.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