ezmq 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 53f27cf838fcd7f6dfe55aa2876eca322e4d1771
-  data.tar.gz: 29a2a8f41c6de6f0302ef8492ddda546a6b6702b
+  metadata.gz: acd34ba3fc6400948cb525260fffeb2c537f9efa
+  data.tar.gz: f62399fa0d1b808429b8c18cf17bd38f709bac47
 SHA512:
-  metadata.gz: 67e6d18714294b269610295c0f279175e848678ac8521f86d745e9105490b057ba2f491172ac7eaf611894c66b566279a7b7bd67547e8b2241934a3e86e887d9
-  data.tar.gz: 9d4abe01a0061edd3b441749759ced76f3f558b351c65e49c377225e671d71089408c014a1c98e95c293fb0a8da3f591df27d2dc25ff5227de4cd397d540a405
+  metadata.gz: 9340fc6c1f9a1df80f29446e56cd69d49eeadd44336e4ef5201a91cc7f76c797aac653dc9046766d419ed60d4c53fe5192e75b926895db2c2255ea3c80299bfb
+  data.tar.gz: f6f2a361fcbb633dc8d1373d77dec5ebe415f3bec465eb91c2b75496ce2c7fb8bd58f2e379ef22a83186921469663d835eeea1983db82a5f7bcb666e7dcc72e6

data/README.md

@@ -1,12 +1,106 @@
-EZMQ (Effortless ZeroMQ)
+[EZMQ (Effortless ZeroMQ)](https://colstrom.github.io/ezmq/)
 ========================
 
+Overview
+--------
+
 EZMQ is a wrapper around the wonderful `ffi-rzmq` gem, which (as the name suggests) uses FFI, and exposes a fairly raw C-like interface. As elegant as 0MQ is, C doesn't feel like Ruby, and FFI bindings feel like C. EZMQ makes some reasonable assumptions to help you focus on what makes your code special, and not worry about setting up 0MQ.
 
 Any of the magical hand-wavey bits (contexts, sockets, etc) are still exposed for tinkering, EZMQ just starts you off with some sane defaults.
 
+Examples
+========
+
+Most of these examples are trivial, because ZMQ is just the fabric of your networked application(s).
+
+Echo Server
+-----------
+Waits for a request, replies with the same request.
+
+```
+require 'ezmq'
+
+server = EZMQ::Server.new
+server.listen
+```
+
+Synchronous Client Request
+--------------------------
+Sends a message, prints the reply when it arrives.
+
+```
+require 'ezmq'
+
+client = EZMQ::Client.new
+puts client.request 'test'
+```
+
+Confirming Logging Server
+-------------------------
+Waits for a request, prints it to STDOUT, and thanks the client for it.
+
+```
+require 'ezmq'
+
+server = EZMQ::Server.new
+server.listen do |message|
+  puts message
+  'Thanks for the message!' # The return of the block is sent to the client.
+end
+
+JSON Echo Server
+----------------
+Waits for JSON message, decodes it, re-encodes it, and sends it back.
+
+```
+require 'ezmq'
+require 'json'
+
+server = EZMQ::Server.new encode: -> m { JSON.dump m }, decode: -> m { JSON.load m }
+server.listen
+```
+
+JSON Synchronous Client Request
+-------------------------------
+Encodes a message in JSON, sends it twice, prints the first one raw, and decodes the second.
+
+```
+require 'ezmq'
+require 'json'
+
+client = EZMQ::Client.new encode: -> m { JSON.dump m }
+puts client.request 'test'
+client.decode = -> m { JSON.load m }
+puts client.request 'test'
+```
+
+'foorever' Publisher
+--------------------
+Publishes an endless stream of 'foo's with a topic of 'foorever'.
+
+```
+require 'ezmq'
+
+publisher = EZMQ.Publisher.new topic: 'foorever'
+
+loop do
+  publisher.send 'foo'
+end
+```
+
+'foorever' Subscriber
+---------------------
+Subscribes to topic 'foorever', prints any messages it receives.
+
+```
+require 'ezmq'
+
+subscriber = EZMQ.Subscriber.new topic: 'foorever'
+subscriber.listen
+````
+
 Operating System Notes
-----------------------
+======================
 
 As this relies on [ffi-rzmq](https://github.com/chuckremes/ffi-rzmq), you will need to have the zeromq libraries available.
 

data/UPGRADING.md

@@ -0,0 +1,12 @@
+Upgrading from 0.1.x to 0.2+
+----------------------------
+
+Initializing a socket now allows `protocol`, `address`, and `port` as optional parameters.
+
+If you were passing `address` in as a string containing all three, this is no longer required, and will fail.
+
+`provides` and `action` removed from `Server` and `Subscriber` respectively. `handler` removed from #listen.
+
+Server#listen and Subscriber#listen now yield received messages to a block, if given. The return of the block will be send as the response.
+
+Client#request now yields the response message to the block.

data/doc/EZMQ.html

@@ -117,7 +117,7 @@
 </div>
 
     <div id="footer">
-  Generated on Tue Jan  6 12:58:18 2015 by
+  Generated on Fri Jan  9 13:06:26 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

@@ -161,7 +161,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#request-instance_method" title="#request (instance method)">- (void) <strong>request</strong>(message = &#39;&#39;, encode: @encode, decode: @decode) </a>
+      <a href="#request-instance_method" title="#request (instance method)">- (void) <strong>request</strong>(message = &#39;&#39;, **options) </a>
     
 
     
@@ -231,7 +231,7 @@
       
         &mdash;
         <div class='inline'>
-<p>optional parameters</p>
+<p>optional parameters.</p>
 </div>
       
     </li>
@@ -242,7 +242,7 @@
   <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 a list of optional parameters.</a></span></li>
+      <li><span class='object_link'><a href="Socket.html" title="EZMQ::Socket (class)">EZMQ::Socket for optional parameters.</a></span></li>
     
   </ul>
 
@@ -252,12 +252,12 @@
       <pre class="lines">
 
 
-125
-126
-127</pre>
+119
+120
+121</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ezmq.rb', line 125</span>
+      <pre class="code"><span class="info file"># File 'lib/ezmq.rb', line 119</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='op'>**</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
   <span class='kw'>super</span> <span class='symbol'>:connect</span><span class='comma'>,</span> <span class='const'>ZMQ</span><span class='op'>::</span><span class='const'>REQ</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
@@ -277,7 +277,7 @@
       <div class="method_details first">
   <h3 class="signature first" id="request-instance_method">
   
-    - (<tt>void</tt>) <strong>request</strong>(message = &#39;&#39;, encode: @encode, decode: @decode) 
+    - (<tt>void</tt>) <strong>request</strong>(message = &#39;&#39;, **options) 
   
 
   
@@ -315,37 +315,58 @@
   
     <li>
       
-        <span class='name'>encode</span>
+        <span class='name'>options</span>
       
       
-        <span class='type'>(<tt>lambda</tt>)</span>
+        <span class='type'>(<tt>Hash</tt>)</span>
       
       
       
         &mdash;
         <div class='inline'>
-<p>how to encode the message.</p>
+<p>optional parameters.</p>
 </div>
       
     </li>
   
-    <li>
-      
-        <span class='name'>decode</span>
-      
-      
-        <span class='type'>(<tt>lambda</tt>)</span>
-      
-      
-      
-        &mdash;
-        <div class='inline'>
+</ul>
+
+  
+    
+    
+    
+    
+    <p class="tag_title">Options Hash (<tt>**options</tt>):</p>
+    <ul class="option">
+      
+        <li>
+          <span class="name">encode</span>
+          <span class="type">(<tt>lambda</tt>)</span>
+          <span class="default">
+            
+          </span>
+          
+            &mdash; <div class='inline'>
+<p>how to encode the message.</p>
+</div>
+          
+        </li>
+      
+        <li>
+          <span class="name">decode</span>
+          <span class="type">(<tt>lambda</tt>)</span>
+          <span class="default">
+            
+          </span>
+          
+            &mdash; <div class='inline'>
 <p>how to decode the message.</p>
 </div>
+          
+        </li>
       
-    </li>
+    </ul>
   
-</ul>
 
 
 </div><table class="source_code">
@@ -354,17 +375,25 @@
       <pre class="lines">
 
 
+132
+133
+134
+135
+136
 137
 138
-139
-140</pre>
+139</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ezmq.rb', line 137</span>
-
-<span class='kw'>def</span> <span class='id identifier rubyid_request'>request</span><span class='lparen'>(</span><span class='id identifier rubyid_message'>message</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='label'>encode:</span> <span class='ivar'>@encode</span><span class='comma'>,</span> <span class='label'>decode:</span> <span class='ivar'>@decode</span><span class='rparen'>)</span>
-  <span class='id identifier rubyid_send'>send</span> <span class='id identifier rubyid_message'>message</span><span class='comma'>,</span> <span class='label'>encode:</span> <span class='id identifier rubyid_encode'>encode</span>
-  <span class='id identifier rubyid_receive'>receive</span> <span class='label'>decode:</span> <span class='id identifier rubyid_decode'>decode</span>
+      <pre class="code"><span class="info file"># File 'lib/ezmq.rb', line 132</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_request'>request</span><span class='lparen'>(</span><span class='id identifier rubyid_message'>message</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></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_send'>send</span> <span class='id identifier rubyid_message'>message</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
+  <span class='kw'>if</span> <span class='id identifier rubyid_block_given?'>block_given?</span>
+    <span class='kw'>yield</span> <span class='id identifier rubyid_receive'>receive</span> <span class='id identifier rubyid_options'>options</span>
+  <span class='kw'>else</span>
+    <span class='id identifier rubyid_receive'>receive</span> <span class='id identifier rubyid_options'>options</span>
+  <span class='kw'>end</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -376,7 +405,7 @@
 </div>
 
     <div id="footer">
-  Generated on Tue Jan  6 12:58:18 2015 by
+  Generated on Fri Jan  9 13:06:26 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/Publisher.html

@@ -161,7 +161,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#send-instance_method" title="#send (instance method)">- (Fixnum) <strong>send</strong>(message = &#39;&#39;, topic: &#39;&#39;, encode: @encode) </a>
+      <a href="#send-instance_method" title="#send (instance method)">- (Fixnum) <strong>send</strong>(message = &#39;&#39;, topic: &#39;&#39;, **options) </a>
     
 
     
@@ -231,7 +231,7 @@
       
         &mdash;
         <div class='inline'>
-<p>optional parameters</p>
+<p>optional parameters.</p>
 </div>
       
     </li>
@@ -242,7 +242,7 @@
   <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 a list of optional parameters.</a></span></li>
+      <li><span class='object_link'><a href="Socket.html" title="EZMQ::Socket (class)">EZMQ::Socket for optional parameters.</a></span></li>
     
   </ul>
 
@@ -252,12 +252,12 @@
       <pre class="lines">
 
 
-153
-154
-155</pre>
+186
+187
+188</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ezmq.rb', line 153</span>
+      <pre class="code"><span class="info file"># File 'lib/ezmq.rb', line 186</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='op'>**</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
   <span class='kw'>super</span> <span class='symbol'>:bind</span><span class='comma'>,</span> <span class='const'>ZMQ</span><span class='op'>::</span><span class='const'>PUB</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
@@ -277,7 +277,7 @@
       <div class="method_details first">
   <h3 class="signature first" id="send-instance_method">
   
-    - (<tt>Fixnum</tt>) <strong>send</strong>(message = &#39;&#39;, topic: &#39;&#39;, encode: @encode) 
+    - (<tt>Fixnum</tt>) <strong>send</strong>(message = &#39;&#39;, topic: &#39;&#39;, **options) 
   
 
   
@@ -331,22 +331,48 @@
   
     <li>
       
-        <span class='name'>encode</span>
+        <span class='name'>options</span>
       
       
-        <span class='type'>(<tt>lambda</tt>)</span>
+        <span class='type'>(<tt>Hash</tt>)</span>
       
       
       
         &mdash;
         <div class='inline'>
-<p>how to encode the message.</p>
+<p>optional parameters.</p>
 </div>
       
     </li>
   
 </ul>
 
+  
+    
+    
+    
+    
+    
+    
+    <p class="tag_title">Options Hash (<tt>**options</tt>):</p>
+    <ul class="option">
+      
+        <li>
+          <span class="name">encode</span>
+          <span class="type">(<tt>lambda</tt>)</span>
+          <span class="default">
+            
+          </span>
+          
+            &mdash; <div class='inline'>
+<p>how to encode the message.</p>
+</div>
+          
+        </li>
+      
+    </ul>
+  
+
 <p class="tag_title">Returns:</p>
 <ul class="return">
   
@@ -372,15 +398,15 @@
       <pre class="lines">
 
 
-165
-166
-167</pre>
+199
+200
+201</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ezmq.rb', line 165</span>
+      <pre class="code"><span class="info file"># File 'lib/ezmq.rb', line 199</span>
 
-<span class='kw'>def</span> <span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='id identifier rubyid_message'>message</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='label'>topic:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='label'>encode:</span> <span class='ivar'>@encode</span><span class='rparen'>)</span>
-  <span class='ivar'>@socket</span><span class='period'>.</span><span class='id identifier rubyid_send_string'>send_string</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span> <span class='id identifier rubyid_topic'>topic</span> <span class='embexpr_end'>}</span><span class='tstring_content'> </span><span class='embexpr_beg'>#{</span> <span class='id identifier rubyid_encode'>encode</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span> <span class='id identifier rubyid_message'>message</span> <span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
+<span class='kw'>def</span> <span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='id identifier rubyid_message'>message</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='label'>topic:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+  <span class='ivar'>@socket</span><span class='period'>.</span><span class='id identifier rubyid_send_string'>send_string</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span> <span class='id identifier rubyid_topic'>topic</span> <span class='embexpr_end'>}</span><span class='tstring_content'> </span><span class='embexpr_beg'>#{</span> <span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:encode</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='ivar'>@encode</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span> <span class='id identifier rubyid_message'>message</span> <span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -392,7 +418,7 @@
 </div>
 
     <div id="footer">
-  Generated on Tue Jan  6 12:58:18 2015 by
+  Generated on Fri Jan  9 13:06:26 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

@@ -116,41 +116,9 @@
 
 
 
-  <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
-  <ul class="summary">
-    
-      <li class="public ">
-  <span class="summary_signature">
-    
-      <a href="#provides-instance_method" title="#provides (instance method)">- (Object) <strong>provides</strong> </a>
-    
-
-    
-  </span>
-  
-  
-  
-    
-    
-  
-  
-  
-  
-  
-
-  
-    <span class="summary_desc"><div class='inline'>
-<p>Returns the value of attribute provides.</p>
-</div></span>
-  
-</li>
 
-    
-  </ul>
 
-
-
-  
+  <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>
@@ -167,7 +135,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#initialize-instance_method" title="#initialize (instance method)">- (Server) <strong>initialize</strong>(provides: -&gt; m { m }, **options) </a>
+      <a href="#initialize-instance_method" title="#initialize (instance method)">- (Server) <strong>initialize</strong>(**options) </a>
     
 
     
@@ -193,7 +161,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#listen-instance_method" title="#listen (instance method)">- (void) <strong>listen</strong>(handler: -&gt; { send @provides.call(receive) }) </a>
+      <a href="#listen-instance_method" title="#listen (instance method)">- (void) <strong>listen</strong> {|message| ... }</a>
     
 
     
@@ -208,8 +176,7 @@
 
   
     <span class="summary_desc"><div class='inline'>
-<p>By default, waits to receive a message, calls @action with it, replies with
-the result, then loops.</p>
+<p>Listens for a request, and responds to it.</p>
 </div></span>
   
 </li>
@@ -235,7 +202,7 @@ the result, then loops.</p>
     <div class="method_details first">
   <h3 class="signature first" id="initialize-instance_method">
   
-    - (<tt><span class='object_link'><a href="" title="EZMQ::Server (class)">Server</a></span></tt>) <strong>initialize</strong>(provides: -&gt; m { m }, **options) 
+    - (<tt><span class='object_link'><a href="" title="EZMQ::Server (class)">Server</a></span></tt>) <strong>initialize</strong>(**options) 
   
 
   
@@ -253,22 +220,6 @@ the result, then loops.</p>
   <p class="tag_title">Parameters:</p>
 <ul class="param">
   
-    <li>
-      
-        <span class='name'>provides</span>
-      
-      
-        <span class='type'>(<tt>lambda</tt>)</span>
-      
-      
-      
-        &mdash;
-        <div class='inline'>
-<p>the service provided by this server.</p>
-</div>
-      
-    </li>
-  
     <li>
       
         <span class='name'>options</span>
@@ -291,7 +242,7 @@ the result, then loops.</p>
   <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 a list of optional parameters.</a></span></li>
+      <li><span class='object_link'><a href="Socket.html" title="EZMQ::Socket (class)">EZMQ::Socket for optional parameters.</a></span></li>
     
   </ul>
 
@@ -301,16 +252,14 @@ the result, then loops.</p>
       <pre class="lines">
 
 
-98
-99
-100
-101</pre>
+152
+153
+154</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ezmq.rb', line 98</span>
+      <pre class="code"><span class="info file"># File 'lib/ezmq.rb', line 152</span>
 
-<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>provides:</span> <span class='tlambda'>-&gt;</span> <span class='id identifier rubyid_m'>m</span> <span class='tlambeg'>{</span> <span class='id identifier rubyid_m'>m</span> <span class='rbrace'>}</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
-  <span class='ivar'>@provides</span> <span class='op'>=</span> <span class='id identifier rubyid_provides'>provides</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='op'>**</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
   <span class='kw'>super</span> <span class='symbol'>:bind</span><span class='comma'>,</span> <span class='const'>ZMQ</span><span class='op'>::</span><span class='const'>REP</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
 <span class='kw'>end</span></pre>
     </td>
@@ -320,54 +269,6 @@ the result, then loops.</p>
   
 </div>
 
-  <div id="instance_attr_details" class="attr_details">
-    <h2>Instance Attribute Details</h2>
-    
-      
-      <span id="provides=-instance_method"></span>
-      <div class="method_details first">
-  <h3 class="signature first" id="provides-instance_method">
-  
-    - (<tt>Object</tt>) <strong>provides</strong> 
-  
-
-  
-
-  
-</h3><div class="docstring">
-  <div class="discussion">
-    
-<p>Returns the value of attribute provides</p>
-
-
-  </div>
-</div>
-<div class="tags">
-  
-
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-
-
-87
-88
-89</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/ezmq.rb', line 87</span>
-
-<span class='kw'>def</span> <span class='id identifier rubyid_provides'>provides</span>
-  <span class='ivar'>@provides</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-    
-  </div>
-
 
   <div id="instance_method_details" class="method_details_list">
     <h2>Instance Method Details</h2>
@@ -376,7 +277,7 @@ the result, then loops.</p>
       <div class="method_details first">
   <h3 class="signature first" id="listen-instance_method">
   
-    - (<tt>void</tt>) <strong>listen</strong>(handler: -&gt; { send @provides.call(receive) }) 
+    - (<tt>void</tt>) <strong>listen</strong> {|message| ... }
   
 
   
@@ -385,34 +286,71 @@ the result, then loops.</p>
 </h3><div class="docstring">
   <div class="discussion">
     <p class="note returns_void">This method returns an undefined value.</p>
-<p>By default, waits to receive a message, calls @action with it, replies with
-the result, then loops.</p>
+<p>Listens for a request, and responds to it.</p>
+
+<p>If no block is given, responds with the request message.</p>
 
 
   </div>
 </div>
 <div class="tags">
-  <p class="tag_title">Parameters:</p>
-<ul class="param">
+  
+<p class="tag_title">Yields:</p>
+<ul class="yield">
   
     <li>
       
-        <span class='name'>handler</span>
       
+        <span class='type'></span>
       
-        <span class='type'>(<tt>lambda</tt>)</span>
+      
+      
+        
+        <div class='inline'>
+<p>message passes the message received to the block.</p>
+</div>
+      
+    </li>
+  
+</ul>
+<p class="tag_title">Yield Parameters:</p>
+<ul class="yieldparam">
+  
+    <li>
+      
+        <span class='name'>message</span>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
       
       
       
         &mdash;
         <div class='inline'>
-<p>how requests are handled.</p>
+<p>the message received.</p>
+</div>
+      
+    </li>
+  
+</ul>
+<p class="tag_title">Yield Returns:</p>
+<ul class="yieldreturn">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>void</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>the message to reply with.</p>
 </div>
       
     </li>
   
 </ul>
-
 
 </div><table class="source_code">
   <tr>
@@ -420,15 +358,27 @@ the result, then loops.</p>
       <pre class="lines">
 
 
-110
-111
-112</pre>
+166
+167
+168
+169
+170
+171
+172
+173
+174</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ezmq.rb', line 110</span>
-
-<span class='kw'>def</span> <span class='id identifier rubyid_listen'>listen</span><span class='lparen'>(</span><span class='label'>handler:</span> <span class='tlambda'>-&gt;</span> <span class='tlambeg'>{</span> <span class='id identifier rubyid_send'>send</span> <span class='ivar'>@provides</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='id identifier rubyid_receive'>receive</span><span class='rparen'>)</span> <span class='rbrace'>}</span><span class='rparen'>)</span>
-  <span class='id identifier rubyid_loop'>loop</span> <span class='lbrace'>{</span> <span class='id identifier rubyid_handler'>handler</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span> <span class='rbrace'>}</span>
+      <pre class="code"><span class="info file"># File 'lib/ezmq.rb', line 166</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_listen'>listen</span>
+  <span class='id identifier rubyid_loop'>loop</span> <span class='kw'>do</span>
+    <span class='kw'>if</span> <span class='id identifier rubyid_block_given?'>block_given?</span>
+      <span class='id identifier rubyid_send'>send</span> <span class='kw'>yield</span> <span class='id identifier rubyid_receive'>receive</span>
+    <span class='kw'>else</span>
+      <span class='id identifier rubyid_send'>send</span> <span class='id identifier rubyid_receive'>receive</span>
+    <span class='kw'>end</span>
+  <span class='kw'>end</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -440,7 +390,7 @@ the result, then loops.</p>
 </div>
 
     <div id="footer">
-  Generated on Tue Jan  6 12:58:18 2015 by
+  Generated on Fri Jan  9 13:06:26 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>