ionian 0.6.8 → 0.6.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f2c1057ff496da029cbdcd0d9967fccd9ab7c1b
-  data.tar.gz: 82f0e659ff947991b902b01bc535f80ef22a211d
+  metadata.gz: 1740c16fc1de977ccfb32dc86a9bbdad020cc09a
+  data.tar.gz: 39c63d9683e284d1998b46ae1df44e76fa15e1a4
 SHA512:
-  metadata.gz: 68af34bda41fa4144b6b994250920e02306336ab3ecc61f63f98a98286cd0263eb65354924d2184181694c5a1a081d4b5a13b8e38d07938d280e5f0b983cf7f4
-  data.tar.gz: 5e0c5615b6029cc14a8ee60ebbdde22236786bf77b7e787b787c760f7c921d4ea95a2a2418e5f2d5079a2a182e8c8a04449cd567acbab48854ab03789b5b50b3
+  metadata.gz: bf1dfa00d8412aa1c874e004b106c49ada0ca4f4785f125cd2624c7e65ac80fdf5fe3f8f7a781743bd8e1f712dd5b1e54ad70750c0dc9d7e68c61cfda6c44729
+  data.tar.gz: a4cbd18beba67fdb8d8bc7435a2b48233c0d85679e13f9cea3da9a419d95be2953c3a73e227b35d7661bbea19cfa93fc2f39e3cc5cada7a88b5cc7b72875e1b2

data/doc/Ionian/Extension/IO.html

@@ -6,7 +6,7 @@
 <title>
   Module: Ionian::Extension::IO
   
-    &mdash; Documentation by YARD 0.8.7.4
+    &mdash; Documentation by YARD 0.8.7.6
   
 </title>
 
@@ -197,7 +197,7 @@ implement the standard library IO class. my_socket.extend Ionian::IO</p>
 
   
     <span class="summary_desc"><div class='inline'>
-<p>Returns the regular expression used for #read_match.</p>
+<p>Returns the regular expression used for <span class='object_link'><a href="#read_match-instance_method" title="Ionian::Extension::IO#read_match (method)">#read_match</a></span>.</p>
 </div></span>
   
 </li>
@@ -245,7 +245,7 @@ implement the standard library IO class. my_socket.extend Ionian::IO</p>
 
   
     <span class="summary_desc"><div class='inline'>
-<p>Returns true if there is data in the receive buffer.</p>
+<p>True if there is data in the receive buffer.</p>
 </div></span>
   
 </li>
@@ -326,7 +326,7 @@ implement the standard library IO class. my_socket.extend Ionian::IO</p>
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#read_match-instance_method" title="#read_match (instance method)">- (Object) <strong>read_match</strong>(**kwargs, &amp;block) </a>
+      <a href="#read_match-instance_method" title="#read_match (instance method)">- (Array&lt;MatchData&gt;<sup>?</sup>) <strong>read_match</strong>(**kwargs) {|match| ... }</a>
     
 
     
@@ -367,7 +367,7 @@ implement the standard library IO class. my_socket.extend Ionian::IO</p>
 
   
     <span class="summary_desc"><div class='inline'>
-<p>Register a block to be called when #run_match receives matched data.</p>
+<p>Register a block to be called when <span class='object_link'><a href="#run_match-instance_method" title="Ionian::Extension::IO#run_match (method)">#run_match</a></span> receives matched data.</p>
 </div></span>
   
 </li>
@@ -539,7 +539,7 @@ standard library IO::select.</p>
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Returns the regular expression used for #read_match.</p>
+<p>Returns the regular expression used for <span class='object_link'><a href="#read_match-instance_method" title="Ionian::Extension::IO#read_match (method)">#read_match</a></span>.</p>
 
 
   </div>
@@ -553,12 +553,12 @@ standard library IO::select.</p>
       <pre class="lines">
 
 
-41
 42
-43</pre>
+43
+44</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ionian/extension/io.rb', line 41</span>
+      <pre class="code"><span class="info file"># File 'lib/ionian/extension/io.rb', line 42</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_expression'>expression</span>
   <span class='ivar'>@ionian_expression</span>
@@ -598,13 +598,13 @@ href=":parameter">match</a>.</p>
       <pre class="lines">
 
 
-51
 52
 53
-54</pre>
+54
+55</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ionian/extension/io.rb', line 51</span>
+      <pre class="code"><span class="info file"># File 'lib/ionian/extension/io.rb', line 52</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'>@ionian_expression</span> <span class='op'>=</span> <span class='id identifier rubyid_exp'>exp</span>
@@ -627,16 +627,34 @@ href=":parameter">match</a>.</p>
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Returns true if there is data in the receive buffer. Args:</p>
-
-<pre class="code ruby"><code class="ruby">Timeout: Number of seconds to wait for data until
-  giving up. Set to nil for blocking.</code></pre>
+<p>Returns True if there is data in the receive buffer.</p>
 
 
   </div>
 </div>
 <div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
   
+    <li>
+      
+        <span class='name'>timeout</span>
+      
+      
+        <span class='type'>(<tt>Numeric</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>Number of seconds to wait for data until giving up. Set to nil for
+blocking.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
 <p class="tag_title">Returns:</p>
 <ul class="return">
   
@@ -647,6 +665,11 @@ href=":parameter">match</a>.</p>
       
       
       
+        &mdash;
+        <div class='inline'>
+<p>True if there is data in the receive buffer.</p>
+</div>
+      
     </li>
   
 </ul>
@@ -657,12 +680,12 @@ href=":parameter">match</a>.</p>
       <pre class="lines">
 
 
-36
 37
-38</pre>
+38
+39</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ionian/extension/io.rb', line 36</span>
+      <pre class="code"><span class="info file"># File 'lib/ionian/extension/io.rb', line 37</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_has_data?'>has_data?</span> <span class='label'>timeout:</span> <span class='int'>0</span>
   <span class='op'>::</span><span class='const'>IO</span><span class='period'>.</span><span class='id identifier rubyid_select'>select</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='kw'>self</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_timeout'>timeout</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='kw'>true</span> <span class='op'>:</span> <span class='kw'>false</span>
@@ -751,14 +774,14 @@ automatically.</p>
       <pre class="lines">
 
 
-162
-163
-164
-165
-166</pre>
+172
+173
+174
+175
+176</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ionian/extension/io.rb', line 162</span>
+      <pre class="code"><span class="info file"># File 'lib/ionian/extension/io.rb', line 172</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_purge'>purge</span>
   <span class='comment'># Erase IO buffer.
@@ -798,7 +821,6 @@ nonblocking, returns nil if no data available.</p>
       <pre class="lines">
 
 
-60
 61
 62
 63
@@ -806,10 +828,11 @@ nonblocking, returns nil if no data available.</p>
 65
 66
 67
-68</pre>
+68
+69</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ionian/extension/io.rb', line 60</span>
+      <pre class="code"><span class="info file"># File 'lib/ionian/extension/io.rb', line 61</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_read_all'>read_all</span> <span class='label'>nonblocking:</span> <span class='kw'>false</span>
   <span class='kw'>return</span> <span class='kw'>nil</span> <span class='kw'>if</span> <span class='id identifier rubyid_nonblocking'>nonblocking</span> <span class='kw'>and</span> <span class='kw'>not</span> <span class='id identifier rubyid_has_data?'>has_data?</span>
@@ -828,7 +851,7 @@ nonblocking, returns nil if no data available.</p>
       <div class="method_details ">
   <h3 class="signature " id="read_match-instance_method">
   
-    - (<tt>Object</tt>) <strong>read_match</strong>(**kwargs, &amp;block) 
+    - (<tt>Array&lt;MatchData&gt;</tt><sup>?</sup>) <strong>read_match</strong>(**kwargs) {|match| ... }
   
 
   
@@ -838,55 +861,175 @@ nonblocking, returns nil if no data available.</p>
   <div class="discussion">
     
 <p>Read matched data from the buffer. This method SHOULD NOT be used if
-#run_match is used.</p>
-
-<p>Passes matches to the block (do |match|). If there are multiple matches,
-the block is called multiple times.</p>
-
-<p>Returns an array of matches. Returns nil if no data was received within the
-timeout period.</p>
+<span class='object_link'><a href="#run_match-instance_method" title="Ionian::Extension::IO#run_match (method)">#run_match</a></span> is used.</p>
 
 <p>Junk data that could exist before a match in the buffer can be accessed
 with match.pre_match.</p>
 
 <p>Data at the end of the buffer that is not matched can be accessed in the
 last match with match.post_match. This data remains in the buffer for the
-next #read_match cycle. This is helpful for protocols like RS232 that do
+next <span class='object_link'><a href="#read_match-instance_method" title="Ionian::Extension::IO#read_match (method)">#read_match</a></span> cycle. This is helpful for protocols like RS232 that do
 not have packet boundries.</p>
 
-<p>kwargs:</p>
-
-<pre class="code ruby"><code class="ruby">timeout:        Timeout in seconds IO::select will block.
-expression:     Override the expression match for this single
-                method call.
-notify:         Set to false to skip notifying match listener procs.
-skip_select:    Skip over the IO::select statement. Use if you
-                are calling IO::select ahead of this method.
-build_methods:  Build accessor methods from named capture groups.
-                Enabled by default.</code></pre>
-
 
   </div>
 </div>
 <div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>kwargs</span>
+      
+      
+        <span class='type'>(<tt>Hash</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>a customizable set of options</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+  
+    
+    
+    <p class="tag_title">Options Hash (<tt>**kwargs</tt>):</p>
+    <ul class="option">
+      
+        <li>
+          <span class="name">:timeout</span>
+          <span class="type">(<tt>Numeric</tt>)</span>
+          <span class="default">
+            
+              &mdash; default:
+              <tt>nil</tt>
+            
+          </span>
+          
+            &mdash; <div class='inline'>
+<p>Timeout in seconds IO::select will block. Blocks indefinitely by default.
+Set to 0 for nonblocking.</p>
+</div>
+          
+        </li>
+      
+        <li>
+          <span class="name">:expression</span>
+          <span class="type">(<tt>Regexp</tt>, <tt>String</tt>)</span>
+          <span class="default">
+            
+          </span>
+          
+            &mdash; <div class='inline'>
+<p>Override the expression match for this single method call.</p>
+</div>
+          
+        </li>
+      
+        <li>
+          <span class="name">:notify</span>
+          <span class="type">(<tt>Boolean</tt>)</span>
+          <span class="default">
+            
+              &mdash; default:
+              <tt>true</tt>
+            
+          </span>
+          
+            &mdash; <div class='inline'>
+<p>Set to false to skip notifying match listener procs.</p>
+</div>
+          
+        </li>
+      
+        <li>
+          <span class="name">:skip_select</span>
+          <span class="type">(<tt>Boolean</tt>)</span>
+          <span class="default">
+            
+              &mdash; default:
+              <tt>false</tt>
+            
+          </span>
+          
+            &mdash; <div class='inline'>
+<p>Skip over the IO::select statement. Use if you are calling IO::select ahead
+of this method.</p>
+</div>
+          
+        </li>
+      
+        <li>
+          <span class="name">:build_methods</span>
+          <span class="type">(<tt>Boolean</tt>)</span>
+          <span class="default">
+            
+              &mdash; default:
+              <tt>true</tt>
+            
+          </span>
+          
+            &mdash; <div class='inline'>
+<p>Build accessor methods from named capture groups.</p>
+</div>
+          
+        </li>
+      
+    </ul>
   
 
+<p class="tag_title">Yield Parameters:</p>
+<ul class="yieldparam">
+  
+    <li>
+      
+        <span class='name'>match</span>
+      
+      
+        <span class='type'>(<tt>MatchData</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>If there are multiple matches, the block is called multiple times.</p>
+</div>
+      
+    </li>
+  
+</ul>
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Array&lt;MatchData&gt;</tt>, <tt>nil</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>Returns an array of matches. Returns nil if no data was received within the
+timeout period.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
 </div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">
 
 
-96
-97
-98
-99
-100
-101
-102
-103
-104
-105
 106
 107
 108
@@ -921,10 +1064,20 @@ build_methods:  Build accessor methods from named capture groups.
 137
 138
 139
-140</pre>
+140
+141
+142
+143
+144
+145
+146
+147
+148
+149
+150</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ionian/extension/io.rb', line 96</span>
+      <pre class="code"><span class="info file"># File 'lib/ionian/extension/io.rb', line 106</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_read_match'>read_match</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_timeout'>timeout</span>       <span class='op'>=</span> <span class='id identifier rubyid_kwargs'>kwargs</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span> <span class='symbol'>:timeout</span><span class='comma'>,</span>        <span class='ivar'>@ionian_timeout</span>
@@ -992,15 +1145,26 @@ build_methods:  Build accessor methods from named capture groups.
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Register a block to be called when #run_match receives matched data. Method
-callbacks can be registered with &amp;object.method(:method). Returns a
-reference to the given block. block = ionian_socket.register_observer { … }</p>
+<p>Register a block to be called when <span class='object_link'><a href="#run_match-instance_method" title="Ionian::Extension::IO#run_match (method)">#run_match</a></span> receives matched data.
+Method callbacks can be registered with &amp;object.method(:method).
+Returns a reference to the given block.</p>
 
 
   </div>
 </div>
 <div class="tags">
   
+  <div class="examples">
+    <p class="tag_title">Examples:</p>
+    
+      
+      <pre class="example code"><code>registered_block = ionian_socket.register_observer { |match| ... }</code></pre>
+    
+      
+      <pre class="example code"><code><span class='id identifier rubyid_registered_block'>registered_block</span> <span class='op'>=</span> <span class='id identifier rubyid_ionian_socket'>ionian_socket</span><span class='period'>.</span><span class='id identifier rubyid_register_observer'>register_observer</span> <span class='op'>&amp;</span><span class='id identifier rubyid_my_object'>my_object</span><span class='period'>.</span><span class='id identifier rubyid_method'>method</span><span class='lparen'>(</span><span class='symbol'>:foo</span><span class='rparen'>)</span></code></pre>
+    
+  </div>
+
 
 </div><table class="source_code">
   <tr>
@@ -1008,13 +1172,13 @@ reference to the given block. block = ionian_socket.register_observer { … }</p
       <pre class="lines">
 
 
-172
-173
-174
-175</pre>
+187
+188
+189
+190</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ionian/extension/io.rb', line 172</span>
+      <pre class="code"><span class="info file"># File 'lib/ionian/extension/io.rb', line 187</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='ivar'>@ionian_listeners</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_block'>block</span> <span class='kw'>unless</span> <span class='ivar'>@ionian_listeners</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span> <span class='id identifier rubyid_block'>block</span>
@@ -1038,8 +1202,8 @@ reference to the given block. block = ionian_socket.register_observer { … }</p
   <div class="discussion">
     
 <p>Start a thread that checks for data and notifies listeners (do |match,
-socket|). Passes kwargs to #read_match. This method SHOULD NOT be used if
-#read_match is used.</p>
+socket|). Passes kwargs to <span class='object_link'><a href="#read_match-instance_method" title="Ionian::Extension::IO#read_match (method)">#read_match</a></span>. This method SHOULD NOT be used if
+<span class='object_link'><a href="#read_match-instance_method" title="Ionian::Extension::IO#read_match (method)">#read_match</a></span> is used.</p>
 
 
   </div>
@@ -1053,23 +1217,23 @@ socket|). Passes kwargs to #read_match. This method SHOULD NOT be used if
       <pre class="lines">
 
 
-145
-146
-147
-148
-149
-150
-151
-152
-153
-154
 155
 156
 157
-158</pre>
+158
+159
+160
+161
+162
+163
+164
+165
+166
+167
+168</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ionian/extension/io.rb', line 145</span>
+      <pre class="code"><span class="info file"># File 'lib/ionian/extension/io.rb', line 155</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_run_match'>run_match</span> <span class='op'>**</span><span class='id identifier rubyid_kwargs'>kwargs</span>
   <span class='ivar'>@match_listener</span> <span class='op'>||=</span> <span class='const'>Thread</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='kw'>do</span>
@@ -1116,13 +1280,13 @@ socket|). Passes kwargs to #read_match. This method SHOULD NOT be used if
       <pre class="lines">
 
 
-180
-181
-182
-183</pre>
+195
+196
+197
+198</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ionian/extension/io.rb', line 180</span>
+      <pre class="code"><span class="info file"># File 'lib/ionian/extension/io.rb', line 195</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='ivar'>@ionian_listeners</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>
@@ -1138,9 +1302,9 @@ socket|). Passes kwargs to #read_match. This method SHOULD NOT be used if
 </div>
 
     <div id="footer">
-  Generated on Mon Apr 14 18:43:33 2014 by
+  Generated on Fri Oct 31 15:50:43 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.8.7.4 (ruby-2.1.1).
+  0.8.7.6 (ruby-2.1.4).
 </div>
 
   </body>