posix-mqueue 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4684343b93a70e5ade31414a548044a4bdd67180
-  data.tar.gz: 03463a0abb8c142b7832812a04915e98ddfdc825
+  metadata.gz: 43c80748fbbdc131f1949149a5046213b1d8ad4c
+  data.tar.gz: acd93be843908dead256dc96cb4680fa8f045abf
 SHA512:
-  metadata.gz: 4996b7a36d757fc0f47961309a6b804c927de5ead7ff204914153f69e70a409f5e0a4d81761ac4d605b27182ccea259a6f71c6cfcdbf22237e22bb602ec0e371
-  data.tar.gz: 2083fe220f4b7e3e9ba22a8a9f42a965546d0f8e2bc2f26ef500ca5d409980e1766775dc136ccd8079481e6c41649ccbe8e87fd03bb999c458bba46a71ca3bb8
+  metadata.gz: 764bb288fad4342bcc2bc99c69c5b5b1c12f2ee3f37367f5302f58eb1a8af285e2359fcd88a2c1db7ba4c183d857e87b77cab535285fc355bce47c78819d3427
+  data.tar.gz: 13506b7fabd6bee22da907f807bddd7bbdadc494e0d7a313e86c888048d0a2297e361a0728736763d248ba49b8a7dfcb190167ac6b44854c0d7a62c9af441f38

data/README.md

@@ -16,6 +16,8 @@ Still WIP. Not stable. Not everything works as promised.
 ## Usage
 
 ```ruby
+require 'posix/mqueue'
+
 m = POSIX::Mqueue.new("/whatever")
 m.send "hello"
 puts m.receive
@@ -28,4 +30,54 @@ m.receive
 # => "world"
 ```
 
+## mqueue
+
+Most important information from the manpages, with a little added information
+about the behavior of `posix-mqueue`.
+
+## /proc interfaces
+
+1. `/proc/sys/fs/mqueue/msg_max`. Contains the maximum number of messages in
+   queue. Defaults to 10. You should increase that number. `#send` will throw an
+   exception if the queue is full (instead of blocking).
+2. `/proc/sys/fs/mqueue/msgsize_max`. Maximum size of a single message. Defaults
+   to 8192 bytes. `posix-mqueue` defaults to 4096 bytes. You'll be able to
+   change this, soon!
+3. `/proc/sys/fs/mqueue/queues_max`. Maximum number of queues on the system.
+   Defaults to 256. Which is probably enough.
+
+## Virtual filesystem
+
+The message queue is created as a virtual file system. That means you can mount
+it:
+
+    # sudo mkdir /dev/queue
+    # sudo mount -t mqueue none /dev/queue
+
+Add a queue and a few tasks, count the characters and you'll see it's a total of 19 bytes:
+
+    $ irb
+    > require 'posix/mqueue'
+    => true
+    > m = POSIX::Mqueue.new("/queue")
+    => #<POSIX::Mqueue:0xb8c9fe88>
+    > m.send "narwhal"
+    => true
+    > m.send "walrus"
+    => true
+    > m.send "ponies"
+    => true
+    > exit
+
+Inspect the mounted filesystem:
+
+    $ ls /dev/queue/
+    important  mails  queue
+    $ cat /dev/queue/queue
+    QSIZE:19         NOTIFY:0     SIGNO:0     NOTIFY_PID:0
+
+Here `QSIZE` is the bytes of data in the queue. The other flags are about
+notifications which `posix-mqueue` does not support currently, read about them
+in [mq_overview(7)][pmq].
+
 [pmq]: http://man7.org/linux/man-pages/man7/mq_overview.7.html

data/ext/posix/mqueue.c

@@ -131,7 +131,7 @@ VALUE posix_mqueue_initialize(VALUE self, VALUE queue)
   struct mq_attr attr = {
     .mq_flags   = 0,          // Flags, 0 or O_NONBLOCK
     .mq_maxmsg  = 10,         // Max messages in queue
-    .mq_msgsize = 512,        // Max message size (bytes)
+    .mq_msgsize = 4096,       // Max message size (bytes)
     .mq_curmsgs = 0           // # currently in queue
   };
 

data/lib/posix/mqueue/version.rb

@@ -1,5 +1,5 @@
 module POSIX
   class Mqueue
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

data/test/test_helper.rb

@@ -3,4 +3,4 @@ require 'minitest/autorun'
 
 $: << File.dirname(__FILE__) + '/../ext'
 
-require "posix/mqueue/mqueue"
+require "posix/mqueue"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: posix-mqueue
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Simon Eskildsen