posix-mqueue 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1d43379130238e323d67a9fdee4cfabd81a72661
-  data.tar.gz: 8f61ef81dcacc70618cd4a61d6828d6321004e5f
+  metadata.gz: 4684343b93a70e5ade31414a548044a4bdd67180
+  data.tar.gz: 03463a0abb8c142b7832812a04915e98ddfdc825
 SHA512:
-  metadata.gz: d90c99dd26fcbb147042fbfa5301eccbb71401359d2e0a7a8c621483dcab297833526fc4b89b8fd5ac26dcd4272bc5652da3ba93e6de3aa0d520c93f4e32133d
-  data.tar.gz: 9aba8450a25e9045605c9f9effa72d5c240953b4c53b451e3b58bd5abdfe25b38b880d6e211363d702db7489762e601d004df41b034d702a7a3913d9d60131d6
+  metadata.gz: 4996b7a36d757fc0f47961309a6b804c927de5ead7ff204914153f69e70a409f5e0a4d81761ac4d605b27182ccea259a6f71c6cfcdbf22237e22bb602ec0e371
+  data.tar.gz: 2083fe220f4b7e3e9ba22a8a9f42a965546d0f8e2bc2f26ef500ca5d409980e1766775dc136ccd8079481e6c41649ccbe8e87fd03bb999c458bba46a71ca3bb8

data/.gitignore

@@ -15,3 +15,7 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+*.o
+*.so
+Makefile
+*.log

data/README.md

@@ -1,5 +1,31 @@
-# Posix::Mqueue
+# posix-mqueue
 
-Minimal wrapper around the [POSIX message queue](pmq).
+Minimal wrapper around the [POSIX message queue](pmq). The POSIX message queue
+offers:
+
+* Persistence. Push messages while nothing is listening.
+* Simplicity. Nothing to set up. Built into Linux.
+* IPC. Blazingly fast communication between processes on the same machine.
+* Blocking and non-blocking. Listeners block until a message arrives on the
+  queue. No polling. Sending messages doesn't block.
+
+Add `gem 'posix-mqueue'` to your favorite Gemfile.
+
+Still WIP. Not stable. Not everything works as promised.
+
+## Usage
+
+```ruby
+m = POSIX::Mqueue.new("/whatever")
+m.send "hello"
+puts m.receive
+# => "hello"
+
+fork { POSIX::Mqueue.new("/whatever").send("world") }
+
+# Blocks until the forked process pushes to the queue
+m.receive
+# => "world"
+```
 
 [pmq]: http://man7.org/linux/man-pages/man7/mq_overview.7.html

data/Rakefile

@@ -1 +1,7 @@
 require "bundler/gem_tasks"
+
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+end

data/ext/{extconf.rb → posix/extconf.rb}

@@ -1,3 +1,3 @@
 require 'mkmf'
 have_header('mqueue.h')
-create_makefile('mqueue')
+create_makefile('posix/mqueue')

data/ext/{mqueue.c → posix/mqueue.c}

@@ -1,4 +1,5 @@
 #include <ruby.h>
+#include <ruby/util.h>
 
 #include <mqueue.h>
 #include <fcntl.h>
@@ -7,20 +8,11 @@
 #include <stdlib.h>
 #include <stdio.h>
 
-mqd_t
-rb_mqueue_fd(const char *queue, const struct mq_attr *attr) {
-  mqd_t fd = mq_open("/mqueue", O_CREAT | O_RDWR, S_IRWXU | S_IRWXO | S_IRWXG, attr);
-
-  if (fd == (mqd_t)-1) {
-    rb_sys_fail("fak rubby");
-  }
-
-  return fd;
-}
-
 typedef struct {
   mqd_t fd;
   struct mq_attr attr;
+  size_t queue_len;
+  char *queue;
 }
 mqueue_t;
 
@@ -35,13 +27,15 @@ mqueue_free(void* ptr)
 {
   mqueue_t* data = ptr;
   mq_close(data->fd);
+  xfree(data->queue);
   xfree(ptr);
 }
 
 static size_t
 mqueue_memsize(const void* ptr)
 {
-  return sizeof(mqueue_t);
+  const mqueue_t* data = ptr;
+  return sizeof(mqueue_t) + sizeof(char) * data->queue_len;
 }
 
 static const rb_data_type_t
@@ -58,7 +52,26 @@ static VALUE
 posix_mqueue_alloc(VALUE klass)
 {
   mqueue_t* data;
-  return TypedData_Make_Struct(klass, mqueue_t, &mqueue_type, data);
+  VALUE obj = TypedData_Make_Struct(klass, mqueue_t, &mqueue_type, data);
+
+  data->fd = -1;
+  data->queue = NULL;
+  data->queue_len = 0;
+
+  return obj;
+}
+
+VALUE posix_mqueue_unlink(VALUE self)
+{
+  mqueue_t* data;
+
+  TypedData_Get_Struct(self, mqueue_t, &mqueue_type, data);
+
+  if (mq_unlink(data->queue) == -1) {
+    rb_sys_fail("Message queue unlinking failed");
+  }
+
+  return Qtrue;
 }
 
 VALUE posix_mqueue_send(VALUE self, VALUE message)
@@ -69,15 +82,14 @@ VALUE posix_mqueue_send(VALUE self, VALUE message)
   TypedData_Get_Struct(self, mqueue_t, &mqueue_type, data);
 
   if (!RB_TYPE_P(message, T_STRING)) { 
-    rb_raise(rb_eTypeError, "fak u rubby"); 
+    rb_raise(rb_eTypeError, "Message must be a string"); 
   }
 
-  // FIXME: is rstring_len with or without \0?
   // TODO: Custom priority
   err = mq_send(data->fd, RSTRING_PTR(message), RSTRING_LEN(message), 10);
 
   if (err < 0) {
-    rb_sys_fail("fak rubby");
+    rb_sys_fail("Message sending failed");
   }
   
   return Qtrue;
@@ -103,7 +115,7 @@ VALUE posix_mqueue_receive(VALUE self)
   err = mq_receive(data->fd, buf, buf_size, NULL);
 
   if (err < 0) {
-    rb_sys_fail("fak rubby");
+    rb_sys_fail("Message retrieval failed");
   }
 
   str = rb_str_new(buf, err);
@@ -117,20 +129,28 @@ VALUE posix_mqueue_initialize(VALUE self, VALUE queue)
   // TODO: Modify these options from initialize arguments
   // TODO: Set nonblock and handle error in #push
   struct mq_attr attr = {
-    .mq_flags   = 0,    // Flags, 0 or O_NONBLOCK
-    .mq_maxmsg  = 100,  // Max messages in queue
-    .mq_msgsize = 512,  // Max message size (bytes)
-    .mq_curmsgs = 0     // # currently in queue
+    .mq_flags   = 0,          // Flags, 0 or O_NONBLOCK
+    .mq_maxmsg  = 10,         // Max messages in queue
+    .mq_msgsize = 512,        // Max message size (bytes)
+    .mq_curmsgs = 0           // # currently in queue
   };
 
   mqueue_t* data;
   TypedData_Get_Struct(self, mqueue_t, &mqueue_type, data);
 
+  if (data->fd != -1) {
+    // This would cause a memleak otherwise
+    rb_raise(rb_eRuntimeError, "Illegal reinitialization");
+  }
+
   data->attr = attr;
+  data->queue_len = RSTRING_LEN(queue);
+  data->queue = ruby_strdup(StringValueCStr(queue));
+  data->fd = mq_open(data->queue, O_CREAT | O_RDWR, S_IRWXU | S_IRWXO | S_IRWXG, &data->attr);
 
-  // FIXME: This is probably dangerous since I don't whether the value is
-  // actually a string.
-  data->fd = rb_mqueue_fd(StringValueCStr(queue), &data->attr);
+  if (data->fd == (mqd_t)-1) {
+    rb_sys_fail("Failed opening the message queue");
+  }
 
   return self;
 }
@@ -143,5 +163,6 @@ void Init_mqueue()
   rb_define_method(mqueue, "initialize", posix_mqueue_initialize, 1);
   rb_define_method(mqueue, "send", posix_mqueue_send, 1);
   rb_define_method(mqueue, "receive", posix_mqueue_receive, 0);
+  rb_define_method(mqueue, "unlink", posix_mqueue_unlink, 0);
 }
 

data/lib/posix/mqueue/version.rb

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

data/posix-mqueue.gemspec

@@ -16,8 +16,8 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
-  spec.extensions    = ["ext/extconf.rb"]
+  spec.require_paths = ["lib", "ext"]
+  spec.extensions    = ["ext/posix/extconf.rb"]
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"

data/test/mqueue_test.rb

@@ -0,0 +1,55 @@
+require 'test_helper'
+
+class MqueueTest < MiniTest::Unit::TestCase
+  def setup
+    @queue_name = "/test-queue"
+    @queue = POSIX::Mqueue.new(@queue_name)
+  end
+
+  def teardown
+    @queue.unlink
+  end
+
+  def test_send_and_receive_single_message
+    @queue.send "hello"
+    assert_equal "hello", @queue.receive
+  end
+
+  def test_send_and_receive_multiple_messages
+    @queue.send "hello"
+    @queue.send "world"
+
+    assert_equal "hello", @queue.receive
+    assert_equal "world", @queue.receive
+  end
+
+  def test_receiver_blocks
+    @queue.send "hello"
+
+    assert_equal "hello", @queue.receive
+
+    fork { POSIX::Mqueue.new(@queue_name).send("world") }
+
+    assert_equal "world", @queue.receive
+  end
+
+  def test_multiple_queues
+    @queue.send "hello"
+
+    other = POSIX::Mqueue.new("/other-test-queue")
+    other.send "world"
+
+    assert_equal "world", other.receive
+    assert_equal "hello", @queue.receive
+
+    other.unlink
+  end
+
+  # def test_send_raises_exception_instead_of_blocking
+  #   10.times { @queue.send "walrus" }
+
+  #   assert_raises Exception do
+  #     @queue.send "hi"
+  #   end
+  # end
+end

data/test/test_helper.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: posix-mqueue
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Simon Eskildsen
@@ -43,7 +43,7 @@ email:
 - sirup@sirupsen.com
 executables: []
 extensions:
-- ext/extconf.rb
+- ext/posix/extconf.rb
 extra_rdoc_files: []
 files:
 - .gitignore
@@ -51,13 +51,12 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- ext/extconf.rb
-- ext/mqueue.c
-- lib/posix/mqueue.rb
+- ext/posix/extconf.rb
+- ext/posix/mqueue.c
 - lib/posix/mqueue/version.rb
 - posix-mqueue.gemspec
+- test/mqueue_test.rb
 - test/test_helper.rb
-- test/test_mqueue.rb
 homepage: ''
 licenses:
 - MIT
@@ -66,6 +65,7 @@ post_install_message:
 rdoc_options: []
 require_paths:
 - lib
+- ext
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
@@ -83,5 +83,5 @@ signing_key:
 specification_version: 4
 summary: posix-mqueue is a simple wrapper around the mqueue(7). It only works on Linux.
 test_files:
+- test/mqueue_test.rb
 - test/test_helper.rb
-- test/test_mqueue.rb

data/lib/posix/mqueue.rb

@@ -1,6 +0,0 @@
-require "posix/mqueue/version"
-
-module POSIX
-  class Mqueue
-  end
-end

data/test/test_mqueue.rb

@@ -1,9 +0,0 @@
-require 'test_helper'
-
-class MqueueTest < MiniTest::Unit::TestCase
-  def test_send_and_receive
-    m = POSIX::Mqueue.new("/whatever")
-    m.send("hello")
-    assert_equal "hello", m.receive
-  end
-end