ionian 0.7.0 → 0.8.0

data/doc/Ionian/Server.html

@@ -930,7 +930,7 @@ connected client is passed to the block as an Ionain::Client.</p>
 </div>
 
     <div id="footer">
-  Generated on Wed Jan 28 16:07:20 2015 by
+  Generated on Wed Feb 11 16:57:31 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.1.5).
 </div>

data/doc/Ionian/Socket.html

@@ -333,7 +333,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#expression-instance_method" title="#expression (instance method)">- (Object) <strong>expression</strong> </a>
+      <a href="#expression-instance_method" title="#expression (instance method)">- (Regexp) <strong>expression</strong> </a>
     
 
     
@@ -348,7 +348,7 @@
 
   
     <span class="summary_desc"><div class='inline'>
-<p>Returns the regular expression used to match incoming data.</p>
+<p>The regular expression used to match incoming data.</p>
 </div></span>
   
 </li>
@@ -375,6 +375,30 @@
 <p>Set the regular expression used to match incoming data.</p>
 </div></span>
   
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#fd-instance_method" title="#fd (instance method)">- (IO) <strong>fd</strong> </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>The file descriptor for this socket.</p>
+</div></span>
+  
 </li>
 
       
@@ -470,7 +494,7 @@
 
   
     <span class="summary_desc"><div class='inline'>
-<p>Returns true if the socket remains open after writing data.</p>
+<p>True if the socket remains open after writing data.</p>
 </div></span>
   
 </li>
@@ -1510,13 +1534,13 @@ the block.</p>
       <pre class="lines">
 
 
-272
-273
-274
-275</pre>
+280
+281
+282
+283</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ionian/socket.rb', line 272</span>
+      <pre class="code"><span class="info file"># File 'lib/ionian/socket.rb', line 280</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_closed?'>closed?</span>
   <span class='kw'>return</span> <span class='kw'>true</span> <span class='kw'>unless</span> <span class='ivar'>@socket</span>
@@ -1618,20 +1642,20 @@ the block.</p>
       <pre class="lines">
 
 
-196
-197
-198
-199
-200
-201
-202
-203
 204
 205
-206</pre>
+206
+207
+208
+209
+210
+211
+212
+213
+214</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ionian/socket.rb', line 196</span>
+      <pre class="code"><span class="info file"># File 'lib/ionian/socket.rb', line 204</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_cmd'>cmd</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_kwargs'>kwargs</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span>
   <span class='id identifier rubyid_create_socket'>create_socket</span> <span class='kw'>unless</span> <span class='ivar'>@persistent</span>
@@ -1652,7 +1676,7 @@ the block.</p>
       <div class="method_details ">
   <h3 class="signature " id="expression-instance_method">
   
-    - (<tt>Object</tt>) <strong>expression</strong> 
+    - (<tt>Regexp</tt>) <strong>expression</strong> 
   
 
   
@@ -1668,6 +1692,24 @@ the block.</p>
 </div>
 <div class="tags">
   
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Regexp</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>the regular expression used to match incoming data.</p>
+</div>
+      
+    </li>
+  
+</ul>
 
 </div><table class="source_code">
   <tr>
@@ -1675,12 +1717,12 @@ the block.</p>
       <pre class="lines">
 
 
-172
-173
-174</pre>
+178
+179
+180</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ionian/socket.rb', line 172</span>
+      <pre class="code"><span class="info file"># File 'lib/ionian/socket.rb', line 178</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_expression'>expression</span>
   <span class='ivar'>@expression</span> <span class='op'>||</span> <span class='ivar'>@socket</span><span class='period'>.</span><span class='id identifier rubyid_expression'>expression</span>
@@ -1708,7 +1750,34 @@ the block.</p>
   </div>
 </div>
 <div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
   
+    <li>
+      
+        <span class='name'>exp</span>
+      
+      
+        <span class='type'>(<tt>Regexp</tt>, <tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>Match expression.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+    
+      <li><span class='object_link'><a href="Extension/IO.html#expression%3D-instance_method" title="Ionian::Extension::IO#expression= (method)">Extension::IO#expression=</a></span></li>
+    
+  </ul>
 
 </div><table class="source_code">
   <tr>
@@ -1716,13 +1785,13 @@ the block.</p>
       <pre class="lines">
 
 
-177
-178
-179
-180</pre>
+185
+186
+187
+188</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ionian/socket.rb', line 177</span>
+      <pre class="code"><span class="info file"># File 'lib/ionian/socket.rb', line 185</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_expression='>expression=</span> <span class='id identifier rubyid_exp'>exp</span>
   <span class='ivar'>@expression</span> <span class='op'>=</span> <span class='id identifier rubyid_exp'>exp</span>
@@ -1731,6 +1800,66 @@ the block.</p>
     </td>
   </tr>
 </table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="fd-instance_method">
+  
+    - (<tt>IO</tt>) <strong>fd</strong> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Returns the file descriptor for this socket. For use with methods like
+IO.select.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>IO</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>the file descriptor for this socket. For use with methods like IO.select.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+173
+174
+175</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ionian/socket.rb', line 173</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_fd'>fd</span>
+  <span class='ivar'>@socket</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
 </div>
     
       <div class="method_details ">
@@ -1760,12 +1889,12 @@ non-persistent sockets.</p>
       <pre class="lines">
 
 
-279
-280
-281</pre>
+287
+288
+289</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ionian/socket.rb', line 279</span>
+      <pre class="code"><span class="info file"># File 'lib/ionian/socket.rb', line 287</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_flush'>flush</span>
   <span class='ivar'>@socket</span><span class='period'>.</span><span class='id identifier rubyid_flush'>flush</span> <span class='kw'>if</span> <span class='ivar'>@persistent</span>
@@ -1864,13 +1993,13 @@ non-persistent sockets.</p>
       <pre class="lines">
 
 
-266
-267
-268
-269</pre>
+274
+275
+276
+277</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ionian/socket.rb', line 266</span>
+      <pre class="code"><span class="info file"># File 'lib/ionian/socket.rb', line 274</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_has_data?'>has_data?</span> <span class='op'>**</span><span class='id identifier rubyid_kwargs'>kwargs</span>
   <span class='kw'>return</span> <span class='kw'>false</span> <span class='kw'>unless</span> <span class='ivar'>@socket</span>
@@ -1893,7 +2022,7 @@ non-persistent sockets.</p>
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Returns true if the socket remains open after writing data.</p>
+<p>Returns True if the socket remains open after writing data.</p>
 
 
   </div>
@@ -1910,6 +2039,11 @@ non-persistent sockets.</p>
       
       
       
+        &mdash;
+        <div class='inline'>
+<p>True if the socket remains open after writing data.</p>
+</div>
+      
     </li>
   
 </ul>
@@ -1920,12 +2054,12 @@ non-persistent sockets.</p>
       <pre class="lines">
 
 
-183
-184
-185</pre>
+191
+192
+193</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ionian/socket.rb', line 183</span>
+      <pre class="code"><span class="info file"># File 'lib/ionian/socket.rb', line 191</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_persistent?'>persistent?</span>
   <span class='ivar'>@persistent</span> <span class='op'>==</span> <span class='kw'>false</span> <span class='op'>||</span> <span class='ivar'>@persistent</span> <span class='op'>==</span> <span class='kw'>nil</span> <span class='op'>?</span> <span class='kw'>false</span> <span class='op'>:</span> <span class='kw'>true</span>
@@ -1962,12 +2096,12 @@ any string not already ending with one.</p>
       <pre class="lines">
 
 
-285
-286
-287</pre>
+293
+294
+295</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ionian/socket.rb', line 285</span>
+      <pre class="code"><span class="info file"># File 'lib/ionian/socket.rb', line 293</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_puts'>puts</span> <span class='op'>*</span><span class='id identifier rubyid_string'>string</span>
   <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span> <span class='id identifier rubyid_string'>string</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_s'>s</span><span class='op'>|</span> <span class='id identifier rubyid_s'>s</span><span class='period'>.</span><span class='id identifier rubyid_chomp'>chomp</span> <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\n</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span> <span class='op'>+</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\n</span><span class='tstring_end'>&quot;</span></span>
@@ -2040,14 +2174,14 @@ an error. Method callbacks can be registered with
       <pre class="lines">
 
 
-245
-246
-247
-248
-249</pre>
+253
+254
+255
+256
+257</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ionian/socket.rb', line 245</span>
+      <pre class="code"><span class="info file"># File 'lib/ionian/socket.rb', line 253</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_register_error_handler'>register_error_handler</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span>
   <span class='ivar'>@ionian_error_handlers</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_block'>block</span> <span class='kw'>unless</span> <span class='ivar'>@ionian_error_handlers</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span> <span class='id identifier rubyid_block'>block</span>
@@ -2122,14 +2256,14 @@ receives matched data. Method callbacks can be registered with
       <pre class="lines">
 
 
-213
-214
-215
-216
-217</pre>
+221
+222
+223
+224
+225</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ionian/socket.rb', line 213</span>
+      <pre class="code"><span class="info file"># File 'lib/ionian/socket.rb', line 221</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_register_match_handler'>register_match_handler</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span>
   <span class='ivar'>@ionian_match_handlers</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_block'>block</span> <span class='kw'>unless</span> <span class='ivar'>@ionian_match_handlers</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span> <span class='id identifier rubyid_block'>block</span>
@@ -2168,13 +2302,13 @@ receives matched data. Method callbacks can be registered with
       <pre class="lines">
 
 
-222
-223
-224
-225</pre>
+230
+231
+232
+233</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ionian/socket.rb', line 222</span>
+      <pre class="code"><span class="info file"># File 'lib/ionian/socket.rb', line 230</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_register_observer'>register_observer</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span>
   <span class='const'>STDOUT</span><span class='period'>.</span><span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>WARN: Call to deprecated method </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid___method__'>__method__</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
@@ -2212,14 +2346,14 @@ raised.</p>
       <pre class="lines">
 
 
-255
-256
-257
-258
-259</pre>
+263
+264
+265
+266
+267</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ionian/socket.rb', line 255</span>
+      <pre class="code"><span class="info file"># File 'lib/ionian/socket.rb', line 263</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_unregister_error_handler'>unregister_error_handler</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span>
   <span class='ivar'>@ionian_error_handlers</span><span class='period'>.</span><span class='id identifier rubyid_delete_if'>delete_if</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_o'>o</span><span class='op'>|</span> <span class='id identifier rubyid_o'>o</span> <span class='op'>==</span> <span class='id identifier rubyid_block'>block</span> <span class='rbrace'>}</span>
@@ -2257,14 +2391,14 @@ raised.</p>
       <pre class="lines">
 
 
-228
-229
-230
-231
-232</pre>
+236
+237
+238
+239
+240</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ionian/socket.rb', line 228</span>
+      <pre class="code"><span class="info file"># File 'lib/ionian/socket.rb', line 236</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_unregister_match_handler'>unregister_match_handler</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span>
   <span class='ivar'>@ionian_match_handlers</span><span class='period'>.</span><span class='id identifier rubyid_delete_if'>delete_if</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_o'>o</span><span class='op'>|</span> <span class='id identifier rubyid_o'>o</span> <span class='op'>==</span> <span class='id identifier rubyid_block'>block</span> <span class='rbrace'>}</span>
@@ -2303,13 +2437,13 @@ raised.</p>
       <pre class="lines">
 
 
-235
-236
-237
-238</pre>
+243
+244
+245
+246</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ionian/socket.rb', line 235</span>
+      <pre class="code"><span class="info file"># File 'lib/ionian/socket.rb', line 243</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_unregister_observer'>unregister_observer</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span>
   <span class='const'>STDOUT</span><span class='period'>.</span><span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>WARN: Call to deprecated method </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid___method__'>__method__</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
@@ -2368,14 +2502,6 @@ raised.</p>
       <pre class="lines">
 
 
-291
-292
-293
-294
-295
-296
-297
-298
 299
 300
 301
@@ -2394,10 +2520,18 @@ raised.</p>
 314
 315
 316
-317</pre>
+317
+318
+319
+320
+321
+322
+323
+324
+325</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ionian/socket.rb', line 291</span>
+      <pre class="code"><span class="info file"># File 'lib/ionian/socket.rb', line 299</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_write'>write</span> <span class='id identifier rubyid_string'>string</span>
   <span class='id identifier rubyid_create_socket'>create_socket</span> <span class='kw'>unless</span> <span class='ivar'>@persistent</span>
@@ -2436,7 +2570,7 @@ raised.</p>
 </div>
 
     <div id="footer">
-  Generated on Wed Jan 28 16:07:21 2015 by
+  Generated on Wed Feb 11 16:57:32 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.1.5).
 </div>