posix_mq 0.1.0

data/lib/posix_mq.rb

@@ -0,0 +1,34 @@
+# -*- encoding: binary -*-
+class POSIX_MQ
+
+  # version of POSIX_MQ, currently 0.1.0
+  VERSION = '0.1.0'
+
+  # An analogous Struct to "struct mq_attr" in C.
+  # This may be used in arguments for POSIX_MQ.new and
+  # POSIX_MQ#attr=.  POSIX_MQ#attr returns an instance
+  # of this class.
+  #
+  # See the mq_getattr(3) manpage for more information on the values.
+  Attr = Struct.new(:flags, :maxmsg, :msgsize, :curmsgs)
+
+  class << self
+
+    # Opens a POSIX message queue and performs operations on the
+    # given block, closing the message queue at exit.
+    # All all arguments are passed to POSIX_MQ.new.
+    def open(*args)
+      mq = new(*args)
+      block_given? or return mq
+      begin
+        yield mq
+      ensure
+        mq.close unless mq.closed?
+      end
+    end
+
+  end
+
+end
+
+require 'posix_mq_ext'

data/local.mk.sample

@@ -0,0 +1,70 @@
+# this is a sample local.mk file, feel free to modify it for your needs
+# GNUmakefile will source local.mk in the top-level source tree
+# if it is present.
+#
+# This is depends on a bunch of GNU-isms from bash, touch.
+
+RSYNC = rsync
+DLEXT := so
+gems :=
+
+# Avoid loading rubygems to speed up tests because gmake is
+# fork+exec heavy with Ruby.
+prefix = $(HOME)
+ifeq ($(r19),)
+  RUBY := $(prefix)/bin/ruby
+  gem_paths := $(addprefix $(prefix)/lib/ruby/gems/1.8/gems/,$(gems))
+else
+  prefix := $(prefix)/ruby-1.9
+  export PATH := $(prefix)/bin:$(PATH)
+  RUBY := $(prefix)/bin/ruby --disable-gems
+  gem_paths := $(addprefix $(prefix)/lib/ruby/gems/1.9.1/gems/,$(gems))
+endif
+
+ifdef gem_paths
+  sp :=
+  sp +=
+  export RUBYLIB := $(subst $(sp),:,$(addsuffix /lib,$(gem_paths)))
+endif
+
+# pipefail is THE reason to use bash (v3+) or never revisions of ksh93
+# SHELL := /bin/bash -e -o pipefail
+SHELL := /bin/ksh93 -e -o pipefail
+
+# trace execution of tests
+# TRACER = strace -f -o $(t_pfx).strace -s 100000
+TRACER = /usr/bin/time -v -o $(t_pfx).time
+
+full-test: test-18 test-19
+test-18:
+	$(MAKE) test 2>&1 | sed -e 's!^!1.8 !'
+test-19:
+	$(MAKE) test r19=t 2>&1 | sed -e 's!^!1.9 !'
+
+latest: NEWS
+	@awk 'BEGIN{RS="=== ";ORS=""}NR==2{sub(/\n$$/,"");print RS""$$0 }' $<
+
+# publishes docs to http://bogomips.org/ruby_posix_mq/
+publish_doc:
+	-git set-file-times
+	$(RM) -r doc ChangeLog NEWS
+	$(MAKE) doc LOG_VERSION=$(shell git tag -l | tail -1)
+	$(MAKE) -s latest > doc/LATEST
+	find doc/images doc/js -type f | \
+		TZ=UTC xargs touch -d '1970-01-01 00:00:00' doc/rdoc.css
+	$(MAKE) doc_gz
+	chmod 644 $$(find doc -type f)
+	$(RSYNC) -av doc/ dcvr:/srv/bogomips/ruby_posix_mq/
+	git ls-files | xargs touch
+
+# Create gzip variants of the same timestamp as the original so nginx
+# "gzip_static on" can serve the gzipped versions directly.
+doc_gz: docs = $(shell find doc -type f ! -regex '^.*\.\(gif\|jpg\|png\|gz\)$$')
+doc_gz:
+	touch doc/NEWS.atom.xml -d "$$(awk 'NR==1{print $$4,$$5,$$6}' NEWS)"
+	for i in $(docs); do \
+	  gzip --rsyncable -9 < $$i > $$i.gz; touch -r $$i $$i.gz; done
+
+# launches any of the following shells with RUBYLIB set
+irb sh bash ksh:
+	$@

data/man/man1/posix-mq.rb.1

@@ -0,0 +1,187 @@
+.TH posix-mq.rb 1 "Jan 1, 2010" "posix-mq.rb User Manual"
+.SH NAME
+.PP
+posix-mq.rb - command-line interface for POSIX message queues
+.SH SYNOPSIS
+.PP
+MQUEUE=/name posix-mq.rb COMMAND [\f[I]OPTIONS\f[]]
+[\f[I]ARGUMENTS\f[]]
+.SH DESCRIPTION
+.PP
+A command-line interface for manipulating POSIX message queues.
+It is useful for testing and debugging applications using POSIX
+message queues.
+.SH COMMANDS
+.PP
+\f[I]create\f[] - create a new message queue
+.PP
+\f[I]attr\f[] - output attributes of the message queue
+.PP
+\f[I]send\f[] - insert a message into the queue from stdin or the
+command-line
+.PP
+\f[I]receive\f[] - take a message from the queue and outputs it to
+stdout
+.PP
+\f[I]wait\f[] - sleep until a message is available in the queue
+.PP
+\f[I]unlink\f[] - unlink the message queue
+.SH CREATE USAGE
+.PP
+The \f[I]create\f[] command accepts the following options:
+.TP
+.B -x, --exclusive
+This causes queue creation to fail if the queue exists.
+.RS
+.RE
+.TP
+.B -m, --mode MODE
+The MODE to open the file under, the actual mode of the queue will
+be AND-ed with the current umask (like open(2)).
+.RS
+.RE
+.TP
+.B -c, --maxmsg COUNT
+The maximum messages in the queue.
+The default and limit of this value is system-dependent.
+This must be specified if --msgsize is also specified.
+.RS
+.RE
+.TP
+.B -s, --msgsize BYTES
+The maximum size of an individual message.
+The default and limit of this value is system-dependent.
+This must be specified if --maxmsg is also specified.
+.RS
+.RE
+.SH ATTR USAGE
+.PP
+The \f[I]attr\f[] command takes no special options nor command-line
+arguments.
+The output format of this command is suitable for \[lq]eval\[rq] in
+shell scripts.
+Sample output is below:
+.PP
+\f[CR]
+      \ \ \ \ flags=0
+      \ \ \ \ maxmsg=10
+      \ \ \ \ msgsize=8192
+      \ \ \ \ curmsgs=3
+\f[]
+.PP
+See mq_getattr(3) for information on the meaning of the fields.
+.SH SEND USAGE
+.PP
+The \f[I]send\f[] command will read a message from standard input
+if no command-line arguments are given.
+If command-line arguments are given, each argument is considered
+its own message and will be inserted into the queue separately.
+.PP
+The following command-line arguments are accepted:
+.TP
+.B -n, --nonblock
+Exit immediately with error if the message queue is full.
+Normally posix-mq.rb(1) will block until the queue is writable or
+interrupted.
+This may not be used in conjunction with --timeout \&.
+.RS
+.RE
+.TP
+.B -t, --timeout SECONDS
+Timeout and exit with error after SECONDS if the message queue is
+full.
+This may not be used in conjunction with --nonblock.
+.RS
+.RE
+.TP
+.B -p, --priority PRIORITY
+Specify an integer PRIORITY, this value should be 0 through 31
+(inclusive) for portability across POSIX-compliant systems.
+The default priority is 0.
+.RS
+.RE
+.SH RECEIVE USAGE
+.PP
+The \f[I]receive\f[] command will output message to standard
+output.
+It will read a message from standard input if no command-line
+arguments are given.
+If command-line arguments are given, each argument is considered
+its own message and will be inserted into the queue separately.
+.PP
+The following command-line arguments are accepted:
+.TP
+.B -n, --nonblock
+Exit immediately with error if the message queue is empty.
+Normally posix-mq.rb(1) will block until the queue is readable or
+interrupted.
+This may not be used in conjunction with --timeout \&.
+.RS
+.RE
+.TP
+.B -t, --timeout SECONDS
+Timeout and exit with error after SECONDS if the message queue is
+empty.
+This may not be used in conjunction with --nonblock.
+.RS
+.RE
+.TP
+.B -p, --priority
+Output the priority of the received message to stderr in the
+following format:
+.RS
+.RE
+.PP
+\f[CR]
+      \ \ \ \ priority=3
+      
+      The\ priority\ is\ an\ unsigned\ integer.
+\f[]
+.SH WAIT USAGE
+.PP
+The \f[I]wait\f[] command will cause posix-mq.rb(1) to sleep until
+a message is available in the queue.
+Only one process may wait on an empty queue, posix-mq.rb(1) will
+exit with an error if there is another waiting process.
+.PP
+It takes no arguments and accepts the following options:
+.TP
+.B -t, --timeout SECONDS
+Timeout and exit with error after SECONDS if the message queue is
+empty.
+.RS
+.RE
+.SH UNLINK USAGE
+.PP
+The \f[I]unlink\f[] command prevents further opening and use of the
+current queue.
+Existing processes with the queue open may continue to operate on
+the queue indefinitely.
+If a new queue is created with the same name, the created queue is
+a different queue from the unlinked queue.
+See mq_unlink(3) for more information.
+.SH GENERAL OPTIONS
+.TP
+.B -q
+Do not show warning/error messages, suitable for scripting.
+.RS
+.RE
+.TP
+.B -h, --help
+Show summary usage
+.RS
+.RE
+.SH ENVIRONMENT
+.PP
+All commands rely on the MQUEUE environment variable.
+The value of MQUEUE should always be prefixed with a slash
+(\[lq]/\[rq]) for portability.
+.SH DIAGNOSTICS
+.PP
+Exit status is normally 0.
+Exit status is 2 if a timeout occurs, 1 for all other errors.
+.SH SEE ALSO
+.IP \[bu] 2
+mq_overview(7) (http://kernel.org/doc/man-pages/online/pages/man7/mq_overview.7.html)
+.SH AUTHOR
+Ruby POSIX MQ hackers <ruby.posix.mq@librelist.com>

data/posix_mq.gemspec

@@ -0,0 +1,39 @@
+# -*- encoding: binary -*-
+
+ENV["VERSION"] or abort "VERSION= must be specified"
+manifest = File.readlines('.manifest').map! { |x| x.chomp! }
+test_files = manifest.grep(%r{\Atest/test_.*\.rb\z})
+
+Gem::Specification.new do |s|
+  s.name = %q{posix_mq}
+  s.version = ENV["VERSION"]
+
+  s.authors = ["Ruby POSIX MQ hackers"]
+  s.date = Time.now.utc.strftime('%Y-%m-%d')
+  s.description = File.read("README").split(/\n\n/)[1]
+  s.email = %q{ruby.posix.mq@librelist.com}
+  s.executables = %w(posix-mq.rb)
+  s.extensions = %w(ext/posix_mq/extconf.rb)
+
+  s.extra_rdoc_files = File.readlines('.document').map! do |x|
+    x.chomp!
+    if File.directory?(x)
+      manifest.grep(%r{\A#{x}/})
+    elsif File.file?(x)
+      x
+    else
+      nil
+    end
+  end.flatten.compact
+
+  s.files = manifest
+  s.homepage = %q{http://bogomips.org/ruby_posix_mq/}
+  s.summary = %q{POSIX Message Queues for Ruby}
+  s.rdoc_options = [ "-Na", "-t", "posix_mq - #{s.summary}" ]
+  s.require_paths = %w(lib)
+  s.rubyforge_project = %q{qrp}
+
+  s.test_files = test_files
+
+  # s.licenses = %w(LGPLv3) # accessor not compatible with older RubyGems
+end