initial commit
[ruby_posix_mq.git] / README
blob91279db047177ea403ec31f1a43afc80e50659ed
1 = posix_mq - POSIX Message Queues for Ruby
3 POSIX message queues allow local processes to exchange data in the form
4 of messages.  This API is distinct from that provided by System V
5 message queues, but provides similar functionality.
7 POSIX message queues may be implemented in the kernel for fast,
8 low-latency communication between processes on the same machine.
9 POSIX message queues are not intended to replace userspace,
10 network-aware message queue implementations.
12 == Features
14 * Supports message notifications via signals.
16 * Supports portable non-blocking operation.  Under Linux 2.6.6+ only,
17   POSIX_MQ objects may even be used with event notification mechanisms
18   such as IO.select.
20 * Optional timeouts may be applied to send and receive operations.
22 * Thread-safe under Ruby 1.9, releases GVL before blocking operations.
24 * Documented library API
26 * Includes a generic "posix-mq.rb" command-line tool with manpage.
28 == Install
30 Operating system support (or library emulation) for POSIX message queues
31 is required.  Most modern GNU/Linux distributions support this
32 out-of-the-box.
34 If you're using a packaged Ruby distribution, make sure you have a C
35 compiler and the matching Ruby development libraries and headers.
37 If you plan on using the command-line client, a tarball installation
38 starts up faster and is recommended.  Just grab the tarball from:
40 http://bogomips.org/ruby_posix_mq/files/
41 Unpack it, and run "ruby setup.rb"
43 Otherwise, via RubyGems: gem install posix_mq
45 == Development
47 You can get the latest source via git from the following locations:
49   git://git.bogomips.org/ruby_posix_mq.git
50   git://repo.or.cz/ruby_posix_mq.git (mirror)
52 You may browse the code from the web and download the latest snapshot
53 tarballs here:
55 * http://git.bogomips.org/cgit/ruby_posix_mq.git (cgit)
56 * http://repo.or.cz/w/ruby_posix_mq.git (gitweb)
58 Inline patches (from "git format-patch") to the mailing list are
59 preferred because they allow code review and comments in the reply to
60 the patch.
62 We will adhere to mostly the same conventions for patch submissions as
63 git itself.  See the Documentation/SubmittingPatches document
64 distributed with git on on patch submission guidelines to follow.  Just
65 don't email the git mailing list or maintainer with posix_mq patches.
67 == Contact
69 All feedback (bug reports, user/development discussion, patches, pull
70 requests) go to the mailing list: mailto:ruby.posix.mq@librelist.com