ezmq 0.3.6 → 0.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 781daac7e68b2fed1dde07f9ae4ef822fd0ace3b
-  data.tar.gz: 11b07e2b25f322278cfa8c73254e90d652d91f91
+  metadata.gz: 46b7285032dabec9656efcba1ef4605c6175c47a
+  data.tar.gz: bfd62eadbc82531ff1eedf8f8aa50501d69572ac
 SHA512:
-  metadata.gz: 814754da7bb07a0a913df8b4cd11fe576352047d430f9f2cc0637039b706247761646e5939f2b068be2012baa26819c9f4f123576aee30911f12e1a3b5acc621
-  data.tar.gz: f91fae0a7de7176e1da8d9f412f0413b8e5f60a292881ee367df307a14825b14d8075e8dada6d5a6598679044e22c00134534c8fab505704ea813e798075cfbc
+  metadata.gz: 092728ae0b28bcdf69f9e5591a654414efda4012b985086201622f8e24d76c6e4a4c5d57a08a21572ee72e853ed9ed838e97529f8afcfcb90fbfbebf261131b8
+  data.tar.gz: 6786e5495ac80837a6cb996486370323030b81e21b5b6fe31c2fa47d42b741db8b0cf21f78716c18180bbb91b4c66801f5a751df8b84c04d18c49aef72999b04

data/Rakefile

@@ -1,28 +1,49 @@
 # require 'simplecov'
 
+require 'rubocop/rake_task'
+require 'reek/rake/task'
+require 'rspec/core/rake_task'
+require 'roodi_task'
+
 task default: [:test]
 
-task :test do
-  sh 'rspec'
+task test: [:rspec]
+
+desc 'Run Test Suite with RSpec'
+RSpec::Core::RakeTask.new(:rspec) do |task|
+  task.patterns = ['spec/**/*.rb']
+  task.fail_on_error = false
 end
 
 task audit: [:style, :complexity, :duplication, :design, :documentation]
 
-task :style do
-  sh 'rubocop'
+task style: [:rubocop]
+
+desc 'Enforce Style Conformance with RuboCop'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.patterns = ['lib/**/*.rb']
+  task.fail_on_error = false
 end
 
-task :complexity do
-  sh 'flog *.rb **/*.rb'
+task complexity: [:flog]
+
+desc 'Assess Complexity with Flog'
+# FlogTask.new :flog, 9000, ['lib']
+task :flog do
+  sh 'flog lib/**/*.rb'
 end
 
-task :duplication do
+task duplication: [:flay]
+
+task :flay do
   sh 'flay'
 end
 
-task :design do
-  sh 'roodi'
-  sh 'reek *.rb **/*.rb'
+task design: [:roodi, :reek]
+
+desc 'Find Code Smells with Reek'
+Reek::Rake::Task.new(:reek) do |task|
+  task.fail_on_error = false
 end
 
 task :rework do

data/doc/EZMQ.html

@@ -80,7 +80,7 @@
   
     <dt class="r1 last">Defined in:</dt>
     <dd class="r1 last">lib/ezmq/push.rb<span class="defines">,<br />
-  lib/ezmq/pull.rb,<br /> lib/ezmq/reply.rb,<br /> lib/ezmq/socket.rb,<br /> lib/ezmq/publish.rb,<br /> lib/ezmq/request.rb,<br /> lib/ezmq/context.rb,<br /> lib/ezmq/subscribe.rb</span>
+  lib/ezmq/pair.rb,<br /> lib/ezmq/pull.rb,<br /> lib/ezmq/reply.rb,<br /> lib/ezmq/socket.rb,<br /> lib/ezmq/publish.rb,<br /> lib/ezmq/request.rb,<br /> lib/ezmq/context.rb,<br /> lib/ezmq/subscribe.rb</span>
 </dd>
   
 </dl>
@@ -103,7 +103,7 @@
     
   
     
-      <strong class="classes">Classes:</strong> <span class='object_link'><a href="EZMQ/Client.html" title="EZMQ::Client (class)">Client</a></span>, <span class='object_link'><a href="EZMQ/Context.html" title="EZMQ::Context (class)">Context</a></span>, <span class='object_link'><a href="EZMQ/Publisher.html" title="EZMQ::Publisher (class)">Publisher</a></span>, <span class='object_link'><a href="EZMQ/Puller.html" title="EZMQ::Puller (class)">Puller</a></span>, <span class='object_link'><a href="EZMQ/Pusher.html" title="EZMQ::Pusher (class)">Pusher</a></span>, <span class='object_link'><a href="EZMQ/Server.html" title="EZMQ::Server (class)">Server</a></span>, <span class='object_link'><a href="EZMQ/Socket.html" title="EZMQ::Socket (class)">Socket</a></span>, <span class='object_link'><a href="EZMQ/Subscriber.html" title="EZMQ::Subscriber (class)">Subscriber</a></span>
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="EZMQ/Client.html" title="EZMQ::Client (class)">Client</a></span>, <span class='object_link'><a href="EZMQ/Context.html" title="EZMQ::Context (class)">Context</a></span>, <span class='object_link'><a href="EZMQ/Pair.html" title="EZMQ::Pair (class)">Pair</a></span>, <span class='object_link'><a href="EZMQ/Publisher.html" title="EZMQ::Publisher (class)">Publisher</a></span>, <span class='object_link'><a href="EZMQ/Puller.html" title="EZMQ::Puller (class)">Puller</a></span>, <span class='object_link'><a href="EZMQ/Pusher.html" title="EZMQ::Pusher (class)">Pusher</a></span>, <span class='object_link'><a href="EZMQ/Server.html" title="EZMQ::Server (class)">Server</a></span>, <span class='object_link'><a href="EZMQ/Socket.html" title="EZMQ::Socket (class)">Socket</a></span>, <span class='object_link'><a href="EZMQ/Subscriber.html" title="EZMQ::Subscriber (class)">Subscriber</a></span>
     
   
 </p>
@@ -114,12 +114,144 @@
 
 
 
+  
+    <h2>
+      Class Method Summary
+      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+    </h2>
+
+    <ul class="summary">
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#create_linked_pair-class_method" title="create_linked_pair (class method)">+ (Array&lt;EZMQ::Pair&gt;) <strong>create_linked_pair</strong>(**options) </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
 
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Returns a pair of EZMQ::Pair sockets connected to each other.</p>
+</div></span>
+  
+</li>
+
+      
+    </ul>
+  
+
+
+
+  <div id="class_method_details" class="method_details_list">
+    <h2>Class Method Details</h2>
+
+    
+      <div class="method_details first">
+  <h3 class="signature first" id="create_linked_pair-class_method">
+  
+    + (<tt>Array&lt;<span class='object_link'><a href="EZMQ/Pair.html" title="EZMQ::Pair (class)">EZMQ::Pair</a></span>&gt;</tt>) <strong>create_linked_pair</strong>(**options) 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Returns a pair of EZMQ::Pair sockets connected to each other.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>options</span>
+      
+      
+        <span class='type'>(<tt>Hash</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>optional parameters.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Array&lt;<span class='object_link'><a href="EZMQ/Pair.html" title="EZMQ::Pair (class)">EZMQ::Pair</a></span>&gt;</tt>)</span>
+      
+      
+      
+    </li>
+  
+</ul>
+
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+    
+      <li><span class='object_link'><a href="EZMQ/Socket.html" title="EZMQ::Socket (class)">EZMQ::Socket for optional parameters.</a></span></li>
+    
+  </ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+31
+32
+33
+34
+35
+36
+37
+38</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ezmq/pair.rb', line 31</span>
+
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_create_linked_pair'>create_linked_pair</span><span class='lparen'>(</span><span class='op'>**</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:context</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='const'>EZMQ</span><span class='op'>::</span><span class='const'>Context</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
+  <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:protocol</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>inproc</span><span class='tstring_end'>&#39;</span></span>
+  <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:address</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:context</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_context'>context</span><span class='period'>.</span><span class='id identifier rubyid_address'>address</span>
+  <span class='qsymbols_beg'>%i(</span><span class='tstring_content'>bind</span><span class='words_sep'> </span><span class='tstring_content'>connect</span><span class='words_sep'>)</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_mode'>mode</span><span class='op'>|</span>
+    <span class='const'>EZMQ</span><span class='op'>::</span><span class='const'>Pair</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='id identifier rubyid_mode'>mode</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
+  <span class='kw'>end</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+  </div>
 
 </div>
 
     <div id="footer">
-  Generated on Sat Jan 31 17:36:28 2015 by
+  Generated on Mon Feb  2 15:37:51 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.0.0).
 </div>

data/doc/EZMQ/Client.html

@@ -405,7 +405,7 @@
 </div>
 
     <div id="footer">
-  Generated on Sat Jan 31 17:36:29 2015 by
+  Generated on Mon Feb  2 15:37:51 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.0.0).
 </div>

data/doc/EZMQ/Context.html

@@ -217,7 +217,7 @@ protocol.</p>
 </div>
 
     <div id="footer">
-  Generated on Sat Jan 31 17:36:29 2015 by
+  Generated on Mon Feb  2 15:37:51 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.0.0).
 </div>

data/doc/EZMQ/Pair.html

@@ -0,0 +1,279 @@
+<!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>
+  Class: EZMQ::Pair
+  
+    &mdash; Documentation by YARD 0.8.7.6
+  
+</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#!EZMQ/Pair.html";
+</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 (P)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../EZMQ.html" title="EZMQ (module)">EZMQ</a></span></span>
+     &raquo; 
+    <span class="title">Pair</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"><h1>Class: EZMQ::Pair
+  
+  
+  
+</h1>
+
+<dl class="box">
+  
+    <dt class="r1">Inherits:</dt>
+    <dd class="r1">
+      <span class="inheritName"><span class='object_link'><a href="Socket.html" title="EZMQ::Socket (class)">Socket</a></span></span>
+      
+        <ul class="fullTree">
+          <li>Object</li>
+          
+            <li class="next"><span class='object_link'><a href="Socket.html" title="EZMQ::Socket (class)">Socket</a></span></li>
+          
+            <li class="next">EZMQ::Pair</li>
+          
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      
+      </dd>
+    
+  
+  
+    
+  
+    
+  
+  
+  
+    <dt class="r2 last">Defined in:</dt>
+    <dd class="r2 last">lib/ezmq/pair.rb</dd>
+  
+</dl>
+<div class="clear"></div>
+
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    
+<p>Pair sockets are meant to operate in pairs, as the name implies. They are</p>
+
+<pre class="code ruby"><code class="ruby">bi-directional, with a one-to-one relationship between endpoints. Either
+end can send or receive messages.</code></pre>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div>
+
+
+
+
+
+  <h2>Instance Attribute Summary</h2>
+  
+  <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Socket.html" title="EZMQ::Socket (class)">Socket</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="Socket.html#context-instance_method" title="EZMQ::Socket#context (method)">#context</a></span>, <span class='object_link'><a href="Socket.html#decode-instance_method" title="EZMQ::Socket#decode (method)">#decode</a></span>, <span class='object_link'><a href="Socket.html#encode-instance_method" title="EZMQ::Socket#encode (method)">#encode</a></span>, <span class='object_link'><a href="Socket.html#socket-instance_method" title="EZMQ::Socket#socket (method)">#socket</a></span></p>
+
+
+  
+    <h2>
+      Instance Method Summary
+      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+    </h2>
+
+    <ul class="summary">
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#initialize-instance_method" title="#initialize (instance method)">- (Pair) <strong>initialize</strong>(mode, **options) </a>
+    
+
+    
+  </span>
+  
+  
+    <span class="note title constructor">constructor</span>
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Creates a new Pair socket.</p>
+</div></span>
+  
+</li>
+
+      
+    </ul>
+  
+
+
+  
+  
+  
+  
+  
+  
+  
+  
+  <h3 class="inherited">Methods inherited from <span class='object_link'><a href="Socket.html" title="EZMQ::Socket (class)">Socket</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="Socket.html#connect-instance_method" title="EZMQ::Socket#connect (method)">#connect</a></span>, <span class='object_link'><a href="Socket.html#listen-instance_method" title="EZMQ::Socket#listen (method)">#listen</a></span>, <span class='object_link'><a href="Socket.html#receive-instance_method" title="EZMQ::Socket#receive (method)">#receive</a></span>, <span class='object_link'><a href="Socket.html#send-instance_method" title="EZMQ::Socket#send (method)">#send</a></span></p>
+<div id="constructor_details" class="method_details_list">
+  <h2>Constructor Details</h2>
+  
+    <div class="method_details first">
+  <h3 class="signature first" id="initialize-instance_method">
+  
+    - (<tt><span class='object_link'><a href="" title="EZMQ::Pair (class)">Pair</a></span></tt>) <strong>initialize</strong>(mode, **options) 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Creates a new Pair socket.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>mode</span>
+      
+      
+        <span class='type'>(<tt>:bind</tt>, <tt>:connect</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>a mode for the socket.</p>
+</div>
+      
+    </li>
+  
+    <li>
+      
+        <span class='name'>options</span>
+      
+      
+        <span class='type'>(<tt>Hash</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>optional parameters.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+    
+      <li><span class='object_link'><a href="Socket.html" title="EZMQ::Socket (class)">EZMQ::Socket for optional parameters.</a></span></li>
+    
+  </ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+18
+19
+20
+21</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ezmq/pair.rb', line 18</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_mode'>mode</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_fail'>fail</span> <span class='const'>ArgumentError</span> <span class='kw'>unless</span> <span class='qsymbols_beg'>%i(</span><span class='tstring_content'>bind</span><span class='words_sep'> </span><span class='tstring_content'>connect</span><span class='words_sep'>)</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span> <span class='id identifier rubyid_mode'>mode</span>
+  <span class='kw'>super</span> <span class='id identifier rubyid_mode'>mode</span><span class='comma'>,</span> <span class='const'>ZMQ</span><span class='op'>::</span><span class='const'>PAIR</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  
+</div>
+
+
+</div>
+
+    <div id="footer">
+  Generated on Mon Feb  2 15:37:51 2015 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.7.6 (ruby-2.0.0).
+</div>
+
+  </body>
+</html>

data/doc/EZMQ/Publisher.html

@@ -420,7 +420,7 @@
 </div>
 
     <div id="footer">
-  Generated on Sat Jan 31 17:36:29 2015 by
+  Generated on Mon Feb  2 15:37:51 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.0.0).
 </div>

data/doc/EZMQ/Puller.html

@@ -104,7 +104,10 @@
 <h2>Overview</h2><div class="docstring">
   <div class="discussion">
     
-<p>Pull socket that receives messages but does not send them.</p>
+<p>Pull socket that receives messages but does not send them. Pullers can</p>
+
+<pre class="code ruby"><code class="ruby">connect to multiple Pushers, and will fair-queue messages from available
+sources.</code></pre>
 
 
   </div>
@@ -246,12 +249,12 @@
       <pre class="lines">
 
 
-15
-16
-17</pre>
+17
+18
+19</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ezmq/pull.rb', line 15</span>
+      <pre class="code"><span class="info file"># File 'lib/ezmq/pull.rb', line 17</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_mode'>mode</span> <span class='op'>=</span> <span class='symbol'>:bind</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
   <span class='kw'>super</span> <span class='id identifier rubyid_mode'>mode</span><span class='comma'>,</span> <span class='const'>ZMQ</span><span class='op'>::</span><span class='const'>PULL</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
@@ -267,7 +270,7 @@
 </div>
 
     <div id="footer">
-  Generated on Sat Jan 31 17:36:28 2015 by
+  Generated on Mon Feb  2 15:37:51 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.0.0).
 </div>

data/doc/EZMQ/Pusher.html

@@ -104,7 +104,11 @@
 <h2>Overview</h2><div class="docstring">
   <div class="discussion">
     
-<p>Push socket that sends messages but does not receive them.</p>
+<p>Push socket that sends messages but does not receive them. It can connect
+to</p>
+
+<pre class="code ruby"><code class="ruby">multiple Pull sockets, and will load-balance requests to available
+destinations.</code></pre>
 
 
   </div>
@@ -246,12 +250,12 @@
       <pre class="lines">
 
 
-15
-16
-17</pre>
+17
+18
+19</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ezmq/push.rb', line 15</span>
+      <pre class="code"><span class="info file"># File 'lib/ezmq/push.rb', line 17</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_mode'>mode</span> <span class='op'>=</span> <span class='symbol'>:connect</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
   <span class='kw'>super</span> <span class='id identifier rubyid_mode'>mode</span><span class='comma'>,</span> <span class='const'>ZMQ</span><span class='op'>::</span><span class='const'>PUSH</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
@@ -267,7 +271,7 @@
 </div>
 
     <div id="footer">
-  Generated on Sat Jan 31 17:36:28 2015 by
+  Generated on Mon Feb  2 15:37:51 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.0.0).
 </div>

data/doc/EZMQ/Server.html

@@ -390,7 +390,7 @@
 </div>
 
     <div id="footer">
-  Generated on Sat Jan 31 17:36:28 2015 by
+  Generated on Mon Feb  2 15:37:51 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.0.0).
 </div>

data/doc/EZMQ/Socket.html

@@ -112,7 +112,7 @@
 
 </div><div id="subclasses">
   <h2>Direct Known Subclasses</h2>
-  <p class="children"><span class='object_link'><a href="Client.html" title="EZMQ::Client (class)">Client</a></span>, <span class='object_link'><a href="Publisher.html" title="EZMQ::Publisher (class)">Publisher</a></span>, <span class='object_link'><a href="Puller.html" title="EZMQ::Puller (class)">Puller</a></span>, <span class='object_link'><a href="Pusher.html" title="EZMQ::Pusher (class)">Pusher</a></span>, <span class='object_link'><a href="Server.html" title="EZMQ::Server (class)">Server</a></span>, <span class='object_link'><a href="Subscriber.html" title="EZMQ::Subscriber (class)">Subscriber</a></span></p>
+  <p class="children"><span class='object_link'><a href="Client.html" title="EZMQ::Client (class)">Client</a></span>, <span class='object_link'><a href="Pair.html" title="EZMQ::Pair (class)">Pair</a></span>, <span class='object_link'><a href="Publisher.html" title="EZMQ::Publisher (class)">Publisher</a></span>, <span class='object_link'><a href="Puller.html" title="EZMQ::Puller (class)">Puller</a></span>, <span class='object_link'><a href="Pusher.html" title="EZMQ::Pusher (class)">Pusher</a></span>, <span class='object_link'><a href="Server.html" title="EZMQ::Server (class)">Server</a></span>, <span class='object_link'><a href="Subscriber.html" title="EZMQ::Subscriber (class)">Subscriber</a></span></p>
 </div>
 
 
@@ -387,7 +387,8 @@
   <div class="note notetag">
     <strong>Note:</strong>
     <div class='inline'>
-<p>port is ignored unless protocol is either &#39;tcp&#39; or &#39;udp&#39;.</p>
+<p>port is ignored unless protocol is one of &#39;tcp&#39;, &#39;pgm&#39; or
+&#39;epgm&#39;.</p>
 </div>
   </div>
 
@@ -1301,7 +1302,7 @@ address instead.</p>
 </div>
 
     <div id="footer">
-  Generated on Sat Jan 31 17:36:29 2015 by
+  Generated on Mon Feb  2 15:37:51 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.0.0).
 </div>

data/doc/EZMQ/Subscriber.html

@@ -847,7 +847,7 @@ set, this will only remove one.</p>
 </div>
 
     <div id="footer">
-  Generated on Sat Jan 31 17:36:29 2015 by
+  Generated on Mon Feb  2 15:37:52 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.0.0).
 </div>

data/doc/_index.html

@@ -119,6 +119,13 @@
           <li class="letter">P</li>
           <ul>
             
+              <li>
+                <span class='object_link'><a href="EZMQ/Pair.html" title="EZMQ::Pair (class)">Pair</a></span>
+                
+                  <small>(EZMQ)</small>
+                
+              </li>
+            
               <li>
                 <span class='object_link'><a href="EZMQ/Publisher.html" title="EZMQ::Publisher (class)">Publisher</a></span>
                 
@@ -181,7 +188,7 @@
 </div>
 
     <div id="footer">
-  Generated on Sat Jan 31 17:36:28 2015 by
+  Generated on Mon Feb  2 15:37:50 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.0.0).
 </div>

data/doc/class_list.html

@@ -50,7 +50,7 @@
 
       <ul id="full_list" class="class">
         <li><span class='object_link'><a href="top-level-namespace.html" title="Top Level Namespace (root)">Top Level Namespace</a></span></li>
-<li><a class='toggle'></a> <span class='object_link'><a href="EZMQ.html" title="EZMQ (module)">EZMQ</a></span><small class='search_info'>Top Level Namespace</small></li><ul><li><span class='object_link'><a href="EZMQ/Client.html" title="EZMQ::Client (class)">Client</a></span> &lt; Socket<small class='search_info'>EZMQ</small></li><li><span class='object_link'><a href="EZMQ/Context.html" title="EZMQ::Context (class)">Context</a></span> &lt; Context<small class='search_info'>EZMQ</small></li><li><span class='object_link'><a href="EZMQ/Publisher.html" title="EZMQ::Publisher (class)">Publisher</a></span> &lt; Socket<small class='search_info'>EZMQ</small></li><li><span class='object_link'><a href="EZMQ/Puller.html" title="EZMQ::Puller (class)">Puller</a></span> &lt; Socket<small class='search_info'>EZMQ</small></li><li><span class='object_link'><a href="EZMQ/Pusher.html" title="EZMQ::Pusher (class)">Pusher</a></span> &lt; Socket<small class='search_info'>EZMQ</small></li><li><span class='object_link'><a href="EZMQ/Server.html" title="EZMQ::Server (class)">Server</a></span> &lt; Socket<small class='search_info'>EZMQ</small></li><li><span class='object_link'><a href="EZMQ/Socket.html" title="EZMQ::Socket (class)">Socket</a></span> &lt; Object<small class='search_info'>EZMQ</small></li><li><span class='object_link'><a href="EZMQ/Subscriber.html" title="EZMQ::Subscriber (class)">Subscriber</a></span> &lt; Socket<small class='search_info'>EZMQ</small></li></ul>
+<li><a class='toggle'></a> <span class='object_link'><a href="EZMQ.html" title="EZMQ (module)">EZMQ</a></span><small class='search_info'>Top Level Namespace</small></li><ul><li><span class='object_link'><a href="EZMQ/Client.html" title="EZMQ::Client (class)">Client</a></span> &lt; Socket<small class='search_info'>EZMQ</small></li><li><span class='object_link'><a href="EZMQ/Context.html" title="EZMQ::Context (class)">Context</a></span> &lt; Context<small class='search_info'>EZMQ</small></li><li><span class='object_link'><a href="EZMQ/Pair.html" title="EZMQ::Pair (class)">Pair</a></span> &lt; Socket<small class='search_info'>EZMQ</small></li><li><span class='object_link'><a href="EZMQ/Publisher.html" title="EZMQ::Publisher (class)">Publisher</a></span> &lt; Socket<small class='search_info'>EZMQ</small></li><li><span class='object_link'><a href="EZMQ/Puller.html" title="EZMQ::Puller (class)">Puller</a></span> &lt; Socket<small class='search_info'>EZMQ</small></li><li><span class='object_link'><a href="EZMQ/Pusher.html" title="EZMQ::Pusher (class)">Pusher</a></span> &lt; Socket<small class='search_info'>EZMQ</small></li><li><span class='object_link'><a href="EZMQ/Server.html" title="EZMQ::Server (class)">Server</a></span> &lt; Socket<small class='search_info'>EZMQ</small></li><li><span class='object_link'><a href="EZMQ/Socket.html" title="EZMQ::Socket (class)">Socket</a></span> &lt; Object<small class='search_info'>EZMQ</small></li><li><span class='object_link'><a href="EZMQ/Subscriber.html" title="EZMQ::Subscriber (class)">Subscriber</a></span> &lt; Socket<small class='search_info'>EZMQ</small></li></ul>
 
       </ul>
     </div>

data/doc/file.README.html

@@ -230,7 +230,7 @@ sudo aptitude install libzmq3-dev
 </div></div>
 
     <div id="footer">
-  Generated on Sat Jan 31 17:36:28 2015 by
+  Generated on Mon Feb  2 15:37:50 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.0.0).
 </div>

data/doc/index.html

@@ -230,7 +230,7 @@ sudo aptitude install libzmq3-dev
 </div></div>
 
     <div id="footer">
-  Generated on Sat Jan 31 17:36:28 2015 by
+  Generated on Mon Feb  2 15:37:50 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.0.0).
 </div>

data/doc/method_list.html

@@ -64,23 +64,35 @@
   
 
   <li class="r1 ">
+    <span class='object_link'><a href="EZMQ.html#create_linked_pair-class_method" title="EZMQ.create_linked_pair (method)">create_linked_pair</a></span>
+    <small>EZMQ</small>
+  </li>
+  
+
+  <li class="r2 ">
     <span class='object_link'><a href="EZMQ/Socket.html#decode-instance_method" title="EZMQ::Socket#decode (method)">#decode</a></span>
     <small>EZMQ::Socket</small>
   </li>
   
 
-  <li class="r2 ">
+  <li class="r1 ">
     <span class='object_link'><a href="EZMQ/Socket.html#encode-instance_method" title="EZMQ::Socket#encode (method)">#encode</a></span>
     <small>EZMQ::Socket</small>
   </li>
   
 
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="EZMQ/Pusher.html#initialize-instance_method" title="EZMQ::Pusher#initialize (method)">#initialize</a></span>
     <small>EZMQ::Pusher</small>
   </li>
   
 
+  <li class="r1 ">
+    <span class='object_link'><a href="EZMQ/Server.html#initialize-instance_method" title="EZMQ::Server#initialize (method)">#initialize</a></span>
+    <small>EZMQ::Server</small>
+  </li>
+  
+
   <li class="r2 ">
     <span class='object_link'><a href="EZMQ/Client.html#initialize-instance_method" title="EZMQ::Client#initialize (method)">#initialize</a></span>
     <small>EZMQ::Client</small>
@@ -88,14 +100,14 @@
   
 
   <li class="r1 ">
-    <span class='object_link'><a href="EZMQ/Server.html#initialize-instance_method" title="EZMQ::Server#initialize (method)">#initialize</a></span>
-    <small>EZMQ::Server</small>
+    <span class='object_link'><a href="EZMQ/Puller.html#initialize-instance_method" title="EZMQ::Puller#initialize (method)">#initialize</a></span>
+    <small>EZMQ::Puller</small>
   </li>
   
 
   <li class="r2 ">
-    <span class='object_link'><a href="EZMQ/Puller.html#initialize-instance_method" title="EZMQ::Puller#initialize (method)">#initialize</a></span>
-    <small>EZMQ::Puller</small>
+    <span class='object_link'><a href="EZMQ/Subscriber.html#initialize-instance_method" title="EZMQ::Subscriber#initialize (method)">#initialize</a></span>
+    <small>EZMQ::Subscriber</small>
   </li>
   
 
@@ -106,26 +118,26 @@
   
 
   <li class="r2 ">
-    <span class='object_link'><a href="EZMQ/Context.html#initialize-instance_method" title="EZMQ::Context#initialize (method)">#initialize</a></span>
-    <small>EZMQ::Context</small>
+    <span class='object_link'><a href="EZMQ/Publisher.html#initialize-instance_method" title="EZMQ::Publisher#initialize (method)">#initialize</a></span>
+    <small>EZMQ::Publisher</small>
   </li>
   
 
   <li class="r1 ">
-    <span class='object_link'><a href="EZMQ/Publisher.html#initialize-instance_method" title="EZMQ::Publisher#initialize (method)">#initialize</a></span>
-    <small>EZMQ::Publisher</small>
+    <span class='object_link'><a href="EZMQ/Pair.html#initialize-instance_method" title="EZMQ::Pair#initialize (method)">#initialize</a></span>
+    <small>EZMQ::Pair</small>
   </li>
   
 
   <li class="r2 ">
-    <span class='object_link'><a href="EZMQ/Subscriber.html#initialize-instance_method" title="EZMQ::Subscriber#initialize (method)">#initialize</a></span>
-    <small>EZMQ::Subscriber</small>
+    <span class='object_link'><a href="EZMQ/Context.html#initialize-instance_method" title="EZMQ::Context#initialize (method)">#initialize</a></span>
+    <small>EZMQ::Context</small>
   </li>
   
 
   <li class="r1 ">
-    <span class='object_link'><a href="EZMQ/Server.html#listen-instance_method" title="EZMQ::Server#listen (method)">#listen</a></span>
-    <small>EZMQ::Server</small>
+    <span class='object_link'><a href="EZMQ/Socket.html#listen-instance_method" title="EZMQ::Socket#listen (method)">#listen</a></span>
+    <small>EZMQ::Socket</small>
   </li>
   
 
@@ -136,20 +148,20 @@
   
 
   <li class="r1 ">
-    <span class='object_link'><a href="EZMQ/Socket.html#listen-instance_method" title="EZMQ::Socket#listen (method)">#listen</a></span>
-    <small>EZMQ::Socket</small>
+    <span class='object_link'><a href="EZMQ/Server.html#listen-instance_method" title="EZMQ::Server#listen (method)">#listen</a></span>
+    <small>EZMQ::Server</small>
   </li>
   
 
   <li class="r2 ">
-    <span class='object_link'><a href="EZMQ/Socket.html#receive-instance_method" title="EZMQ::Socket#receive (method)">#receive</a></span>
-    <small>EZMQ::Socket</small>
+    <span class='object_link'><a href="EZMQ/Subscriber.html#receive-instance_method" title="EZMQ::Subscriber#receive (method)">#receive</a></span>
+    <small>EZMQ::Subscriber</small>
   </li>
   
 
   <li class="r1 ">
-    <span class='object_link'><a href="EZMQ/Subscriber.html#receive-instance_method" title="EZMQ::Subscriber#receive (method)">#receive</a></span>
-    <small>EZMQ::Subscriber</small>
+    <span class='object_link'><a href="EZMQ/Socket.html#receive-instance_method" title="EZMQ::Socket#receive (method)">#receive</a></span>
+    <small>EZMQ::Socket</small>
   </li>
   
 
@@ -160,14 +172,14 @@
   
 
   <li class="r1 ">
-    <span class='object_link'><a href="EZMQ/Socket.html#send-instance_method" title="EZMQ::Socket#send (method)">#send</a></span>
-    <small>EZMQ::Socket</small>
+    <span class='object_link'><a href="EZMQ/Publisher.html#send-instance_method" title="EZMQ::Publisher#send (method)">#send</a></span>
+    <small>EZMQ::Publisher</small>
   </li>
   
 
   <li class="r2 ">
-    <span class='object_link'><a href="EZMQ/Publisher.html#send-instance_method" title="EZMQ::Publisher#send (method)">#send</a></span>
-    <small>EZMQ::Publisher</small>
+    <span class='object_link'><a href="EZMQ/Socket.html#send-instance_method" title="EZMQ::Socket#send (method)">#send</a></span>
+    <small>EZMQ::Socket</small>
   </li>
   
 

data/doc/top-level-namespace.html

@@ -103,7 +103,7 @@
 </div>
 
     <div id="footer">
-  Generated on Sat Jan 31 17:36:28 2015 by
+  Generated on Mon Feb  2 15:37:50 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.0.0).
 </div>

data/ezmq.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name        = 'ezmq'
-  gem.version     = '0.3.6'
+  gem.version     = '0.3.7'
   gem.licenses    = 'MIT'
   gem.authors     = ['Chris Olstrom']
   gem.email       = 'chris@olstrom.com'

data/lib/ezmq.rb

@@ -7,3 +7,4 @@ require_relative 'ezmq/publish'
 require_relative 'ezmq/subscribe'
 require_relative 'ezmq/push'
 require_relative 'ezmq/pull'
+require_relative 'ezmq/pair'

data/lib/ezmq/pair.rb

@@ -0,0 +1,39 @@
+require_relative 'context'
+require_relative 'socket'
+
+# Syntactic sugar for 0MQ, because Ruby shouldn't feel like C.
+module EZMQ
+  # Pair sockets are meant to operate in pairs, as the name implies. They are
+  #   bi-directional, with a one-to-one relationship between endpoints. Either
+  #   end can send or receive messages.
+  class Pair < EZMQ::Socket
+    # Creates a new Pair socket.
+    #
+    # @param [:bind, :connect] mode a mode for the socket.
+    # @param [Hash] options optional parameters.
+    # @see EZMQ::Socket EZMQ::Socket for optional parameters.
+    #
+    # @return [Pair] a new instance of Pair.
+    #
+    def initialize(mode, **options)
+      fail ArgumentError unless %i(bind connect).include? mode
+      super mode, ZMQ::PAIR, options
+    end
+  end
+
+  # Returns a pair of EZMQ::Pair sockets connected to each other.
+  # 
+  # @param [Hash] options optional parameters.
+  # @see EZMQ::Socket EZMQ::Socket for optional parameters.
+  # 
+  # @return [Array<EZMQ::Pair>]
+  #
+  def self.create_linked_pair(**options)
+    options[:context] ||= EZMQ::Context.new
+    options[:protocol] ||= 'inproc'
+    options[:address] ||= options[:context].context.address
+    %i(bind connect).map do |mode|
+      EZMQ::Pair.new mode, options
+    end
+  end
+end

data/lib/ezmq/pull.rb

@@ -2,7 +2,9 @@ require_relative 'socket'
 
 # Syntactic sugar for 0MQ, because Ruby shouldn't feel like C.
 module EZMQ
-  # Pull socket that receives messages but does not send them.
+  # Pull socket that receives messages but does not send them. Pullers can
+  #   connect to multiple Pushers, and will fair-queue messages from available
+  #   sources.
   class Puller < EZMQ::Socket
     # Creates a new Puller socket.
     #

data/lib/ezmq/push.rb

@@ -2,7 +2,9 @@ require_relative 'socket'
 
 # Syntactic sugar for 0MQ, because Ruby shouldn't feel like C.
 module EZMQ
-  # Push socket that sends messages but does not receive them.
+  # Push socket that sends messages but does not receive them. It can connect to
+  #   multiple Pull sockets, and will load-balance requests to available
+  #   destinations.
   class Pusher < EZMQ::Socket
     # Creates a new Pusher socket.
     #

data/lib/ezmq/socket.rb

@@ -19,7 +19,7 @@ module EZMQ
     # @option options [String] protocol ('tcp') protocol for transport.
     # @option options [String] address ('127.0.0.1') address for endpoint.
     # @option options [Fixnum] port (5555) port for endpoint.
-    # @note port is ignored unless protocol is either 'tcp' or 'udp'.
+    # @note port is ignored unless protocol is one of 'tcp', 'pgm' or 'epgm'.
     #
     # @return [Socket] a new instance of Socket.
     #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ezmq
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.3.7
 platform: ruby
 authors:
 - Chris Olstrom
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-01 00:00:00.000000000 Z
+date: 2015-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi-rzmq
@@ -166,6 +166,7 @@ files:
 - doc/EZMQ.html
 - doc/EZMQ/Client.html
 - doc/EZMQ/Context.html
+- doc/EZMQ/Pair.html
 - doc/EZMQ/Publisher.html
 - doc/EZMQ/Puller.html
 - doc/EZMQ/Pusher.html
@@ -189,6 +190,7 @@ files:
 - ezmq.gemspec
 - lib/ezmq.rb
 - lib/ezmq/context.rb
+- lib/ezmq/pair.rb
 - lib/ezmq/publish.rb
 - lib/ezmq/pull.rb
 - lib/ezmq/push.rb