diff options
| author | Eric Wong <normalperson@yhbt.net> | 2011-02-23 16:31:16 -0800 |
|---|---|---|
| committer | Eric Wong <normalperson@yhbt.net> | 2011-02-23 16:31:50 -0800 |
| commit | 909cf19949cab04cd7c223830e93291f1d5517f5 (patch) | |
| tree | 660f06c2ba8c27ac0d995adf415870f09f88a618 | |
| parent | af97f65ef9968f3f365b85e262965b5fd3c6776c (diff) | |
| download | ruby_posix_mq-909cf19949cab04cd7c223830e93291f1d5517f5.tar.gz | |
| -rw-r--r-- | README | 2 | ||||
| -rw-r--r-- | lib/posix_mq.rb | 5 |
2 files changed, 6 insertions, 1 deletions
@@ -64,7 +64,7 @@ kernel module before attempting to use POSIX message queues: kldload mqueuefs -Our API matches the C api closely, see the RDoc for full API +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. diff --git a/lib/posix_mq.rb b/lib/posix_mq.rb index f232baa..b13bfda 100644 --- a/lib/posix_mq.rb +++ b/lib/posix_mq.rb @@ -1,4 +1,9 @@ # -*- encoding: binary -*- +# +# This class represents an POSIX message queue descriptor (mqd_t) +# object. It matches the C API for POSIX messages queues closely. +# +# See the link:README for examples on how to use it. class POSIX_MQ # version of POSIX_MQ, currently 0.6.0 |