rbzmq 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e6bbeba6732872df1e235bc96fa18b734b514bb8
+  data.tar.gz: c8d8dfe8cb6b08f9e5ff55a26d95dd3aad3f4b9d
+SHA512:
+  metadata.gz: c71ab0628d1d397c44dbe1d4727622baf0ccdb1a4feb3ea8f1464a625fb5e1853fcbf1d895a8672975b31f69ab1a106ce822db0a0976f1ecafa28075991cd19c
+  data.tar.gz: 68085788dfb47aa179cf7154feb4c7004c6b44f432ea4f34c48e4c46ed4a951cab1da246bc7807de4edb4208df3144981fda08b253541ca01e986753c14d4ef5

data/LICENSE.txt

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.md

@@ -0,0 +1,70 @@
+# RbZMQ
+
+An opinionated ruby library wrapping [ffi-rzmq](https://github.com/chuckremes/ffi-rzmq) for more rubish flair.
+
+*Library is still pre-release `0.x`. Everything may change anytime.*
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rbzmq', '~> 0.1'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rbzmq
+
+## Usage
+
+You can use RbZMQ's sockets just like in the [zguide](http://zguide.zeromq.org/) but without the need to handle a context. A global context will be used automagically.
+
+```ruby
+require 'rbzmq'
+
+writer = RbZMQ::Socket.new ZMQ::PUSH
+writer.connect 'tcp://127.0.0.1:4237'
+
+writer.send 'My Message!'
+writer.send 'My Second Message!'
+
+reader = RbZMQ::Socket.new ZMQ::PULL
+reader.bind 'tcp://127.0.0.1:4237'
+
+p reader.recv.to_s
+p reader.recv.to_s
+
+writer.close
+reader.close
+```
+
+See `examples/` for a growing number of translated examples from the zguide.
+
+## TODO
+
+* RbZMQ::Reactor
+* Pimp RbZMQ::Message
+* Socket option accessors
+* Class documentation w/ examples
+* Translate zguide examples (and try to use them for auto testing)
+
+## Contributing
+
+1. Fork it (http://github.com/jgraichen/rbzmq/fork)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+Copyright (C) 2014 Jan Graichen
+
+This program is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License along with this program.  If not, see <http://www.gnu.org/licenses/>.

data/doc/file.README.html

@@ -0,0 +1,125 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+<title>
+  File: README
+  
+    &mdash; Documentation by YARD 0.8.7.3
+  
+</title>
+
+  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+
+  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '';
+  framesUrl = "frames.html#!" + escape(window.location.href);
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+  
+    <a href="_index.html">Index</a> &raquo; 
+    <span class="title">File: README</span>
+  
+
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+
+      <div id="search">
+  
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+      Class List
+    </a>
+  
+    <a class="full_list_link" id="method_list_link"
+        href="method_list.html">
+      Method List
+    </a>
+  
+    <a class="full_list_link" id="file_list_link"
+        href="file_list.html">
+      File List
+    </a>
+  
+</div>
+      <div class="clear"></div>
+    </div>
+
+    <iframe id="search_frame"></iframe>
+
+    <div id="content"><div id='filecontents'><h1>RbZMQ</h1>
+
+<p>TODO: Write a gem description</p>
+
+<h2>Installation</h2>
+
+<p>Add this line to your application&#39;s Gemfile:</p>
+
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>rbzmq</span><span class='tstring_end'>&#39;</span></span>
+</code></pre>
+
+<p>And then execute:</p>
+
+<pre class="code ruby"><code class="ruby">$ bundle
+</code></pre>
+
+<p>Or install it yourself as:</p>
+
+<pre class="code ruby"><code class="ruby">$ gem install rbzmq
+</code></pre>
+
+<h2>Usage</h2>
+
+<p>You can use <span class='object_link'><a href="RbZMQ/Socket.html" title="RbZMQ::Socket (class)">RbZMQ::Socket</a></span>s just like in the Guide but without the need to handle a context. A global context will be used automagically.</p>
+
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>rbzmq</span><span class='tstring_end'>&#39;</span></span>
+
+<span class='id identifier rubyid_writer'>writer</span> <span class='op'>=</span> <span class='const'>RbZMQ</span><span class='op'>::</span><span class='const'>Socket</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='const'>ZMQ</span><span class='op'>::</span><span class='const'>PUSH</span>
+<span class='id identifier rubyid_writer'>writer</span><span class='period'>.</span><span class='id identifier rubyid_connect'>connect</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>tcp://127.0.0.1:4237</span><span class='tstring_end'>&#39;</span></span>
+
+<span class='id identifier rubyid_writer'>writer</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>My Message!</span><span class='tstring_end'>&#39;</span></span>
+<span class='id identifier rubyid_writer'>writer</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>My Second Message!</span><span class='tstring_end'>&#39;</span></span>
+
+<span class='id identifier rubyid_reader'>reader</span> <span class='op'>=</span> <span class='const'>RbZMQ</span><span class='op'>::</span><span class='const'>Socket</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='const'>ZMQ</span><span class='op'>::</span><span class='const'>PULL</span>
+<span class='id identifier rubyid_reader'>reader</span><span class='period'>.</span><span class='id identifier rubyid_bind'>bind</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>tcp://127.0.0.1:4237</span><span class='tstring_end'>&#39;</span></span>
+
+<span class='id identifier rubyid_p'>p</span> <span class='id identifier rubyid_reader'>reader</span><span class='period'>.</span><span class='id identifier rubyid_recv'>recv</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
+<span class='id identifier rubyid_p'>p</span> <span class='id identifier rubyid_reader'>reader</span><span class='period'>.</span><span class='id identifier rubyid_recv'>recv</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
+
+<span class='id identifier rubyid_writer'>writer</span><span class='period'>.</span><span class='id identifier rubyid_close'>close</span>
+<span class='id identifier rubyid_reader'>reader</span><span class='period'>.</span><span class='id identifier rubyid_close'>close</span>
+</code></pre>
+
+<h2>Contributing</h2>
+
+<ol>
+<li>Fork it ( <a href="http://github.com/jgraichen/rbzmq/fork">http://github.com/jgraichen/rbzmq/fork</a> )</li>
+<li>Create your feature branch (<code>git checkout -b my-new-feature</code>)</li>
+<li>Commit your changes (<code>git commit -am &#39;Add some feature&#39;</code>)</li>
+<li>Push to the branch (<code>git push origin my-new-feature</code>)</li>
+<li>Create new Pull Request</li>
+</ol>
+</div></div>
+
+    <div id="footer">
+  Generated on Sat Apr  5 12:32:58 2014 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.7.3 (ruby-2.1.1).
+</div>
+
+  </body>
+</html>

data/lib/rbzmq.rb

@@ -0,0 +1,11 @@
+require 'ffi-rzmq'
+require 'rbzmq/version'
+
+#
+module RbZMQ
+  require 'rbzmq/context'
+  require 'rbzmq/errors'
+  require 'rbzmq/message'
+  require 'rbzmq/poller'
+  require 'rbzmq/socket'
+end

data/lib/rbzmq/context.rb

@@ -0,0 +1,40 @@
+module RbZMQ
+
+  class Context
+    # @!visibility private
+    #
+    # Internal `ZMQ::Context` reference.
+    #
+    attr_reader :zmq_ctx
+
+    # Create new context.
+    #
+    def initialize(opts = {})
+      @zmq_ctx = opts.delete(:context) { self.class.global }
+    end
+
+    # Return `FFI::Pointer` from `ZMQ::Context`.
+    #
+    # @return [FFI::Pointer] return
+    def pointer
+      zmq_ctx.pointer
+    end
+
+    class << self
+
+      # Return a process global ZMQ context that will be
+      # lazy initialized on first request.
+      #
+      # @return [ZMQ::Context]
+      #
+      def global
+        unless @zmq_ctx && @ctx_pid == Process.pid
+          @zmq_ctx = ZMQ::Context.new
+          @ctx_pid = Process.pid
+        end
+
+        @zmq_ctx
+      end
+    end
+  end
+end

data/lib/rbzmq/errors.rb

@@ -0,0 +1,45 @@
+module RbZMQ
+
+  class Error < StandardError
+    # noop
+  end
+
+  class ZMQError < Error
+    attr_reader :rc, :errno, :message
+
+    def initialize(rc, errno = nil, message = nil)
+      if ZMQ::ZeroMQError === rc
+        @rc      = rc.result_code
+        @errno   = rc.error_code
+        @message = rc.message =~ /msg\s+\[(.*?)\]/ ? $1 : 'Unknown'
+      else
+        @rc      = rc
+        @errno   = errno || ZMQ::Util.errno
+        @message = message || ZMQ::Util.error_string
+      end
+
+      super "[ERRNO #{@errno}, RC #{@rc}] #{@message}"
+    end
+
+    alias_method :error_code, :errno
+    alias_method :result_code, :rc
+
+    class << self
+      def error!(rc)
+        if error?(rc)
+          raise new(rc)
+        else
+          rc
+        end
+      end
+
+      def error?(rc)
+        -1 == rc
+      end
+
+      def ok?(rc)
+        !error? rc
+      end
+    end
+  end
+end