$ git log --pretty=format:'%h %s (%cs)%d' v2.3.0 --
55a21d4 Ruby posix_mq 2.3.0 - updates for Ruby 2.3+ (2016-02-02)
(tag: v2.3.0)
b35f162 build: use '--local' domain for dev gem install (2016-02-02)
6ae89b5 README: remove cgit and ssoma references (2016-02-02)
f143567 support idempotent POSIX_MQ#close (2016-02-02)
879bcce enable frozen_string_literal for Ruby 2.3+ (2016-02-02)
a95c893 Ruby posix_mq 2.2.0 - support FD adoption (2015-01-16)
(tag: v2.2.0)
75eb7da GNUmakefile: ordering fix for building gem (2015-01-16)
060ec92 POSIX_MQ#autoclose= propagates to IO (2015-01-16)
15a1f21 misc doc updates (2015-01-12)
c8c5962 gemspec: use SPDX license abbreviation (2015-01-12)
...
$ git cat-file blob v2.3.0:README
= posix_mq - POSIX Message Queues for Ruby
POSIX message queues allow local processes to exchange data in the form
of messages. This API is distinct from that provided by System V
message queues, but provides similar functionality.
POSIX message queues may be implemented in the kernel for fast,
low-latency communication between processes on the same machine.
POSIX message queues are not intended to replace userspace,
network-aware message queue implementations.
== Features
* Supports message notifications via signals on all platforms
* Supports portable non-blocking operation. Under Linux 2.6.6+ and
FreeBSD 7.2+, POSIX_MQ objects may even be used with event
notification mechanisms such as IO.select.
* Supports notifications via block execution in a separate thread
on platforms that implement SIGEV_THREAD for mq_notify(3),
currently only GNU/Linux.
* Optional timeouts may be applied to send and receive operations.
* Thread-safe blocking operations under Ruby 1.9+, releases GVL
before blocking operations.
* Works under Ruby 1.9 and later.
* Documented library API
* Includes a generic "posix-mq-rb" command-line tool with manpage.
* {EventMachine}[http://rubyeventmachine.com/] integration via
{em-posixmq}[https://github.com/ibc/em-posixmq]
== Install
Operating system support (or library emulation) for POSIX message queues
is required. Most modern GNU/Linux distributions support this
out-of-the-box.
If you're using a packaged Ruby distribution, make sure you have a C
compiler and the matching Ruby development libraries and headers.
If you plan on using the command-line client, a tarball installation
starts up faster and is recommended. Just grab the tarball from:
http://bogomips.org/ruby_posix_mq/files/
Unpack it, and run "ruby setup.rb"
Otherwise, via RubyGems: gem install posix_mq
== Usage
The Linux mq_overview(7)
{manpage}[http://kernel.org/doc/man-pages/online/pages/man7/mq_overview.7.html]
provides a good overview of programming with POSIX message queues.
Under FreeBSD, you must load the
{mqueuefs(5)}[http://freebsd.org/cgi/man.cgi?query=mqueuefs]
kernel module before attempting to use POSIX message queues:
kldload mqueuefs
Our API matches the POSIX C API closely, see the RDoc for full API
documentation. Here is an example of a process communicating
with itself. In practice, processes that send will be different
from processes that receive.
require 'posix_mq'
mq = POSIX_MQ.new("/foo", :rw)
# hello world
mq << "hello world"
puts mq.receive.first # => should print "hello world"
# non-blocking operation
mq.nonblock = true
begin
mq.receive
rescue Errno::EAGAIN
end
trap(:USR1) { puts mq.receive.first }
mq.notify = :USR1
mq.send "fire USR1 handler"
# "fire USR1 handler" should be printed now
== Development
You can get the latest source via git from the following locations:
git://bogomips.org/ruby_posix_mq.git
git://repo.or.cz/ruby_posix_mq.git (mirror)
You may also browse the code from the web:
* http://bogomips.org/ruby_posix_mq.git
* http://repo.or.cz/w/ruby_posix_mq.git (gitweb)
Inline patches (from "git format-patch") to the mailing list are
preferred because they allow code review and comments in the reply to
the patch.
We will adhere to mostly the same conventions for patch submissions as
git itself. See the Documentation/SubmittingPatches document
distributed with git on patch submission guidelines to follow:
https://git.kernel.org/cgit/git/git.git/plain/Documentation/SubmittingPatches
Just don't mail the git list or maintainer with Ruby posix_mq patches.
== Contact
All feedback (bug reports, user/development discussion, patches, pull
requests) go to the mailing list: mailto:ruby-posix-mq@bogomips.org
Send patches (from "git format-patch") with "git send-email" and do not
send HTML email or attachments. We are very responsive to email and you
will usually get a response within 24-72 hours.
Subscription is optional: mailto:ruby-posix-mq+subscribe@bogomips.org
Read-only mail archives are available over HTTP and NNTP:
http://bogomips.org/ruby-posix-mq/
nntp://news.public-inbox.org/inbox.comp.lang.ruby.posix-mq
# heads (aka `branches'):
$ git for-each-ref --sort=-creatordate refs/heads \
--format='%(HEAD) %(refname:short) %(subject) (%(creatordate:short))'
* master Ruby posix_mq 2.4.1 (2018-01-30)
pu TypedData C-API conversion (2017-03-18)
# tags:
$ git for-each-ref --sort=-creatordate refs/tags \
--format='%(refname:short) %(subject) (%(creatordate:short))'
v2.4.1 Ruby posix_mq 2.4.1 (2018-01-31) tar.gz
v2.4.0 Ruby posix_mq 2.4.0 (2017-03-20) tar.gz
v2.3.0 Ruby posix_mq 2.3.0 - updates for Ruby 2.3+ (2016-02-02) tar.gz
v2.2.0 Ruby posix_mq 2.2.0 - support FD adoption (2015-01-16) tar.gz
v2.1.0 posix_mq 2.1.0 - ensure compatibility with future Rubies (2014-02-15) tar.gz
v2.0.0 posix_mq 2.0.0 - a minor API change + FreeBSD fixes (2012-08-06) tar.gz
v1.0.0 posix_mq 1.0.0 - kinder, gentler message queues (2011-03-01) tar.gz
v0.8.0pre posix_mq 0.8.0pre - kinder, gentler and less exceptional (2011-02-27) tar.gz
v0.7.0 posix_mq 0.7.0 - cleanups + portability fixes (2011-02-23) tar.gz
v0.6.0 posix_mq 0.6.0 - Rubinius support (2010-12-25) tar.gz
...
# associated public inboxes:
# (number on the left is used for dev purposes)
https://yhbt.net/ruby-posix-mq
git clone https://yhbt.net/ruby_posix_mq.git