posix_mq 0.1.0

data/README

@@ -0,0 +1,70 @@
+= 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.
+
+* Supports portable non-blocking operation.  Under Linux 2.6.6+ only,
+  POSIX_MQ objects may even be used with event notification mechanisms
+  such as IO.select.
+
+* Optional timeouts may be applied to send and receive operations.
+
+* Thread-safe under Ruby 1.9, releases GVL before blocking operations.
+
+* Documented library API
+
+* Includes a generic "posix-mq.rb" command-line tool with manpage.
+
+== 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
+
+== Development
+
+You can get the latest source via git from the following locations:
+
+  git://git.bogomips.org/ruby_posix_mq.git
+  git://repo.or.cz/ruby_posix_mq.git (mirror)
+
+You may browse the code from the web and download the latest snapshot
+tarballs here:
+
+* http://git.bogomips.org/cgit/ruby_posix_mq.git (cgit)
+* 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 on patch submission guidelines to follow.  Just
+don't email the git mailing list or maintainer with posix_mq patches.
+
+== Contact
+
+All feedback (bug reports, user/development discussion, patches, pull
+requests) go to the mailing list: mailto:ruby.posix.mq@librelist.com

data/Rakefile

@@ -0,0 +1,159 @@
+# -*- encoding: binary -*-
+
+# most tasks are in the GNUmakefile which offers better parallelism
+
+def tags
+  timefmt = '%Y-%m-%dT%H:%M:%SZ'
+  @tags ||= `git tag -l`.split(/\n/).map do |tag|
+    if %r{\Av[\d\.]+\z} =~ tag
+      header, subject, body = `git cat-file tag #{tag}`.split(/\n\n/, 3)
+      header = header.split(/\n/)
+      tagger = header.grep(/\Atagger /).first
+      body ||= "initial"
+      {
+        :time => Time.at(tagger.split(/ /)[-2].to_i).utc.strftime(timefmt),
+        :tagger_name => %r{^tagger ([^<]+)}.match(tagger)[1].strip,
+        :tagger_email => %r{<([^>]+)>}.match(tagger)[1].strip,
+        :id => `git rev-parse refs/tags/#{tag}`.chomp!,
+        :tag => tag,
+        :subject => subject,
+        :body => body,
+      }
+    end
+  end.compact.sort { |a,b| b[:time] <=> a[:time] }
+end
+
+cgit_url = "http://git.bogomips.org/cgit/ruby_posix_mq.git"
+git_url = ENV['GIT_URL'] || 'git://git.bogomips.org/ruby_posix_mq.git'
+web_url = "http://bogomips.org/ruby_posix_mq/"
+
+desc 'prints news as an Atom feed'
+task :news_atom do
+  require 'nokogiri'
+  new_tags = tags[0,10]
+  puts(Nokogiri::XML::Builder.new do
+    feed :xmlns => "http://www.w3.org/2005/Atom" do
+      id! "#{web_url}NEWS.atom.xml"
+      title "Ruby posix_mq news"
+      subtitle "POSIX Message Queues for Ruby"
+      link! :rel => "alternate", :type => "text/html",
+            :href => "#{web_url}NEWS.html"
+      updated(new_tags.empty? ? "1970-01-01T00:00:00Z" : new_tags.first[:time])
+      new_tags.each do |tag|
+        entry do
+          title tag[:subject]
+          updated tag[:time]
+          published tag[:time]
+          author {
+            name tag[:tagger_name]
+            email tag[:tagger_email]
+          }
+          url = "#{cgit_url}/tag/?id=#{tag[:tag]}"
+          link! :rel => "alternate", :type => "text/html", :href =>url
+          id! url
+          message_only = tag[:body].split(/\n.+\(\d+\):\n {6}/s).first.strip
+          content({:type =>:text}, message_only)
+          content(:type =>:xhtml) { pre tag[:body] }
+        end
+      end
+    end
+  end.to_xml)
+end
+
+desc 'prints RDoc-formatted news'
+task :news_rdoc do
+  tags.each do |tag|
+    time = tag[:time].tr!('T', ' ').gsub!(/:\d\dZ/, ' UTC')
+    puts "=== #{tag[:tag].sub(/^v/, '')} / #{time}"
+    puts ""
+
+    body = tag[:body]
+    puts tag[:body].gsub(/^/sm, "  ").gsub(/[ \t]+$/sm, "")
+    puts ""
+  end
+end
+
+desc "print release changelog for Rubyforge"
+task :release_changes do
+  version = ENV['VERSION'] or abort "VERSION= needed"
+  version = "v#{version}"
+  vtags = tags.map { |tag| tag[:tag] =~ /\Av/ and tag[:tag] }.sort
+  prev = vtags[vtags.index(version) - 1]
+  if prev
+    system('git', 'diff', '--stat', prev, version) or abort $?
+    puts ""
+    system('git', 'log', "#{prev}..#{version}") or abort $?
+  else
+    system('git', 'log', version) or abort $?
+  end
+end
+
+desc "print release notes for Rubyforge"
+task :release_notes do
+  require 'rubygems'
+
+  spec = Gem::Specification.load('posix_mq.gemspec')
+  puts spec.description.strip
+  puts ""
+  puts "* #{spec.homepage}"
+  puts "* #{spec.email}"
+  puts "* #{git_url}"
+
+  _, _, body = `git cat-file tag v#{spec.version}`.split(/\n\n/, 3)
+  print "\nChanges:\n\n"
+  puts body
+end
+
+desc "read news article from STDIN and post to rubyforge"
+task :publish_news do
+  require 'rubyforge'
+  IO.select([STDIN], nil, nil, 1) or abort "E: news must be read from stdin"
+  msg = STDIN.readlines
+  subject = msg.shift
+  blank = msg.shift
+  blank == "\n" or abort "no newline after subject!"
+  subject.strip!
+  body = msg.join("").strip!
+
+  rf = RubyForge.new.configure
+  rf.login
+  rf.post_news('qrp', subject, body)
+end
+
+desc "post to RAA"
+task :raa_update do
+  require 'rubygems'
+  require 'net/http'
+  require 'net/netrc'
+  rc = Net::Netrc.locate('ruby_posix_mq-raa') or abort "~/.netrc not found"
+  password = rc.password
+
+  s = Gem::Specification.load('posix_mq.gemspec')
+  desc = [ s.description.strip ]
+  desc << ""
+  desc << "* #{s.email}"
+  desc << "* #{git_url}"
+  desc << "* #{cgit_url}"
+  desc = desc.join("\n")
+  uri = URI.parse('http://raa.ruby-lang.org/regist.rhtml')
+  form = {
+    :name => s.name,
+    :short_description => s.summary,
+    :version => s.version.to_s,
+    :status => 'experimental',
+    :owner => s.authors.first,
+    :email => s.email,
+    :category_major => 'Library',
+    :category_minor => 'System',
+    :url => s.homepage,
+    :download => 'http://rubyforge.org/frs/?group_id=5626',
+    :license => 'LGPLv3',
+    :description_style => 'Plain',
+    :description => desc,
+    :pass => password,
+    :submit => 'Update',
+  }
+  res = Net::HTTP.post_form(uri, form)
+  p res
+  puts res.body
+end

data/bin/posix-mq.rb

@@ -0,0 +1,138 @@
+#!/usr/bin/ruby
+# -*- encoding: binary -*-
+Encoding.default_external = Encoding::BINARY if defined?(Encoding)
+$stderr.sync = $stdout.sync = true
+
+require 'posix_mq'
+require 'optparse'
+
+commands = %w(create attr send receive wait unlink)
+usage = "Usage: MQUEUE=/name #{File.basename($0)} COMMAND " \
+        "[options] [<arguments>]\n" \
+        "COMMAND may be one of: #{commands.join(', ')}"
+
+mqueue = ENV["MQUEUE"] or abort usage
+command = ARGV.shift or abort usage
+commands.include?(command) or abort usage
+
+priority = nil
+timeout = nil
+mode = 0666
+oflags = IO::RDONLY
+mq_attr = nil
+nonblock = false
+command = command.to_sym
+
+ARGV.options do |x|
+  x.banner = usage.split(/\n/).first.gsub(/COMMAND/, command.to_s)
+  x.separator ''
+
+  case command
+  when :create
+    oflags |= IO::CREAT
+    x.on('-x', '--exclusive', "exclusive create") {
+      oflags |= IO::EXCL
+    }
+    x.on('-m', '--mode=MODE', "octal file mode") { |i|
+      mode = i.to_i(8)
+    }
+    x.on('-c', '--maxmsg=COUNT', Integer, "maximum number of messages") { |i|
+      mq_attr ||= POSIX_MQ::Attr.new
+      mq_attr.maxmsg = i
+    }
+    x.on('-s', '--msgsize=BYTES', Integer, "maximum size of message") { |i|
+      mq_attr ||= POSIX_MQ::Attr.new
+      mq_attr.msgsize = i
+    }
+  when :wait
+    x.on('-t', '--timeout=SECONDS', Float, "timeout in seconds") { |f|
+      timeout = f
+    }
+  when :send, :receive
+    conflict = "timeout and nonblock are exclusive"
+    x.on('-t', '--timeout=SECONDS', Float, "timeout in seconds") { |f|
+      abort conflict if nonblock
+      timeout = f
+    }
+    x.on('-n', '--nonblock', "nonblocking operation") {
+      abort conflict if timeout
+      nonblock = true
+      oflags |= IO::NONBLOCK
+    }
+    if command == :send
+      oflags = IO::WRONLY
+      x.on('-p', '--priority=PRIO', Integer, "priority of message") { |i|
+        priority = i
+      }
+    else
+      x.on('-p', '--priority', "output priority of message to stderr") {
+        priority = $stderr
+      }
+    end
+  end
+  x.on('-q', "quiet warnings and errors") { $stderr.reopen("/dev/null", "w") }
+  x.on('-h', '--help', 'Show this help message.') { puts x; exit }
+  x.parse!
+end
+
+trap(:INT) { exit 130 }
+
+unless command == :send || ARGV.empty?
+  abort "#{command} accepts no arguments"
+end
+
+begin
+  if command == :create && mq_attr
+    mq_attr.flags = mq_attr.curmsgs = 0
+    mq_attr.msgsize && ! mq_attr.maxmsg and
+      abort "--maxmsg must be set with --msgsize"
+    mq_attr.maxmsg && ! mq_attr.msgsize and
+      abort "--msgsize must be set with --maxmsg"
+  elsif command == :unlink
+    POSIX_MQ.unlink(mqueue)
+    exit
+  end
+
+  mq = POSIX_MQ.open(mqueue, oflags, mode, mq_attr)
+  case command
+  when :create
+    exit
+  when :receive
+    buf, prio = mq.receive("", timeout)
+    $stderr.syswrite("priority=#{prio}\n") if priority
+    $stdout.syswrite(buf)
+  when :send
+    ARGV << $stdin.read if ARGV.empty?
+    ARGV.each { |msg| mq.send(msg, priority, timeout) }
+  when :attr
+    mq_attr = mq.attr
+    $stdout.syswrite(
+      "flags=#{mq_attr.flags}\n" \
+      "maxmsg=#{mq_attr.maxmsg}\n" \
+      "msgsize=#{mq_attr.msgsize}\n" \
+      "curmsgs=#{mq_attr.curmsgs}\n")
+  when :wait
+    trap(:USR1) { exit }
+
+    # we wouldn't get a notification if there were already messages
+    exit if mq.attr.curmsgs > 0
+    mq.notify = :USR1
+    exit if mq.attr.curmsgs > 0 # avoid race condition
+
+    timeout.nil? ? sleep : sleep(timeout)
+    exit 2 # timed out
+  end
+rescue Errno::EEXIST
+  abort "Queue exists"
+rescue Errno::ENOENT
+  abort "Queue does not exist"
+rescue Errno::EMSGSIZE
+  abort "Message too long"
+rescue Errno::EAGAIN
+  abort(command == :send ? "Queue full" : "No messages available")
+rescue Errno::ETIMEDOUT
+  warn "Operation timed out"
+  exit 2
+rescue => e
+  abort e.message
+end

data/ext/posix_mq/extconf.rb

@@ -0,0 +1,9 @@
+require "mkmf"
+
+have_header("mqueue.h") or abort "mqueue.h header missing"
+have_func("rb_str_set_len")
+have_func("rb_struct_alloc_noinit")
+have_func('rb_thread_blocking_region')
+have_library("rt")
+dir_config("posix_mq")
+create_makefile("posix_mq_ext")