RubyGems - ionian - Versions diffs - 0.4.0 → 0.4.1 - Mend

ionian 0.4.0 → 0.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (13) hide show

checksums.yaml +4 -4
data/doc/Ionian/Extension/IO.html +10 -10
data/doc/Ionian/Extension/Socket.html +6 -4
data/doc/Ionian/Extension.html +2 -0
data/doc/Ionian/Socket.html +50 -32
data/doc/created.rid +5 -5
data/doc/js/search_index.js +1 -1
data/lib/ionian/extension/io.rb +8 -8
data/lib/ionian/extension/socket.rb +2 -0
data/lib/ionian/socket.rb +40 -23
data/lib/ionian.rb +6 -1
metadata +16 -3
data/doc/Ionian/IO.html +0 -598

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 81979c2c40c6fa759df1c49a2d5226edfb46ba18
-  data.tar.gz: 76e21b58efbdce773066a8f20c23f1a422df43e5
+  metadata.gz: 8ed4a0765c97eff06e5318477989af9dcc436cfb
+  data.tar.gz: c5a76f349eb8ed7e1ecc4f62ac1133fff87a494b
 SHA512:
-  metadata.gz: 239b709e5a1f3f112f238d01054d8e31d0b5f983ae4ef0093025f92573038f689ef1aa7f8425546afb7e53d8a8aac7e6d6d259a31bd38e023e3b78d433a06500
-  data.tar.gz: d8b5ab66d8ae1d31f0aa5d6046198eb34404e15af7711abce4ec09f43b1cecfcf16a0e0c71f31dee609ea8978081ad5369c1bd94787146f23de644f91c0bd5d9
+  metadata.gz: 3fa5c34137d8718f792bf26fabcea6ca786c325136291cce5aecb6350a711849615f39fb1cb81d5463b4334248b47f3c58ccf597707a81d8792319aed3f195ef
+  data.tar.gz: 7d3a636e3260627fa07f90f61c6a7dfc855dff2a57325c5932eea2ac17a0d824ba8c5da399e566c841b361ee13977af16a9f7aa20c8c6cd58c205b5df5a8d3b8

data/doc/Ionian/Extension/IO.html CHANGED Viewed

@@ -412,7 +412,7 @@ automatically.</p>
         <div class="method-heading">
           <span class="method-name">read_match</span><span
-            class="method-args">(**kvargs) { |$~| ... }</span>
+            class="method-args">(**kwargs) { |$~| ... }</span>
           <span class="method-click-advice">click to toggle source</span>
@@ -438,7 +438,7 @@ last match with match.post_match. This data remains in the buffer for the
 next <a href="IO.html#method-i-read_match">read_match</a> cycle. This is
 helpful for protocols like RS232 that do not have packet boundries.</p>
-<p>kvargs:</p>
+<p>kwargs:</p>
 <pre>timeout:        Timeout in seconds IO::select will block.
 skip_select:    Skip over the IO::select statement. Use if you
@@ -451,10 +451,10 @@ build_methods:  Build method accessors from named captures.
           <div class="method-source-code" id="read_match-source">
             <pre><span class="ruby-comment"># File lib/ionian/extension/io.rb, line 77</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier">read_match</span>(<span class="ruby-operator">**</span><span class="ruby-identifier">kvargs</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
-  <span class="ruby-identifier">timeout</span>       = <span class="ruby-identifier">kvargs</span>.<span class="ruby-identifier">fetch</span> <span class="ruby-value">:timeout</span>, <span class="ruby-ivar">@ionian_timeout</span>
-  <span class="ruby-identifier">skip_select</span>   = <span class="ruby-identifier">kvargs</span>.<span class="ruby-identifier">fetch</span> <span class="ruby-value">:skip_select</span>, <span class="ruby-ivar">@ionian_skip_select</span>
-  <span class="ruby-identifier">build_methods</span> = <span class="ruby-identifier">kvargs</span>.<span class="ruby-identifier">fetch</span> <span class="ruby-value">:build_methods</span>, <span class="ruby-ivar">@ionian_build_methods</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">read_match</span>(<span class="ruby-operator">**</span><span class="ruby-identifier">kwargs</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
+  <span class="ruby-identifier">timeout</span>       = <span class="ruby-identifier">kwargs</span>.<span class="ruby-identifier">fetch</span> <span class="ruby-value">:timeout</span>, <span class="ruby-ivar">@ionian_timeout</span>
+  <span class="ruby-identifier">skip_select</span>   = <span class="ruby-identifier">kwargs</span>.<span class="ruby-identifier">fetch</span> <span class="ruby-value">:skip_select</span>, <span class="ruby-ivar">@ionian_skip_select</span>
+  <span class="ruby-identifier">build_methods</span> = <span class="ruby-identifier">kwargs</span>.<span class="ruby-identifier">fetch</span> <span class="ruby-value">:build_methods</span>, <span class="ruby-ivar">@ionian_build_methods</span>
   <span class="ruby-keyword">unless</span> <span class="ruby-identifier">skip_select</span>
     <span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">unless</span> <span class="ruby-operator">::</span><span class="ruby-constant">IO</span>.<span class="ruby-identifier">select</span> [<span class="ruby-keyword">self</span>], <span class="ruby-keyword">nil</span>, <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">timeout</span>
@@ -543,7 +543,7 @@ ionian_socket.register_observer {…}</p>
         <div class="method-heading">
           <span class="method-name">run_match</span><span
-            class="method-args">(**kvargs)</span>
+            class="method-args">(**kwargs)</span>
           <span class="method-click-advice">click to toggle source</span>
@@ -553,7 +553,7 @@ ionian_socket.register_observer {…}</p>
         <div class="method-description">
           <p>Start a thread that checks for data and notifies listeners (do |match,
-socket|). Passes kvargs to <a
+socket|). Passes kwargs to <a
 href="IO.html#method-i-read_match">read_match</a>. This method SHOULD NOT
 be used if <a href="IO.html#method-i-read_match">read_match</a> is used.</p>
@@ -562,11 +562,11 @@ be used if <a href="IO.html#method-i-read_match">read_match</a> is used.</p>
           <div class="method-source-code" id="run_match-source">
             <pre><span class="ruby-comment"># File lib/ionian/extension/io.rb, line 118</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier">run_match</span>(<span class="ruby-operator">**</span><span class="ruby-identifier">kvargs</span>)
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">run_match</span>(<span class="ruby-operator">**</span><span class="ruby-identifier">kwargs</span>)
   <span class="ruby-ivar">@match_listener</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">Thread</span>.<span class="ruby-identifier">new</span> <span class="ruby-keyword">do</span>
     <span class="ruby-keyword">begin</span>
       <span class="ruby-keyword">while</span> <span class="ruby-keyword">not</span> <span class="ruby-identifier">closed?</span> <span class="ruby-keyword">do</span>
-          <span class="ruby-identifier">matches</span> = <span class="ruby-identifier">read_match</span> <span class="ruby-identifier">kvargs</span>
+          <span class="ruby-identifier">matches</span> = <span class="ruby-identifier">read_match</span> <span class="ruby-identifier">kwargs</span>
           <span class="ruby-identifier">matches</span>.<span class="ruby-identifier">each</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">match</span><span class="ruby-operator">|</span>
             <span class="ruby-ivar">@ionian_listeners</span>.<span class="ruby-identifier">each</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">listener</span><span class="ruby-operator">|</span> <span class="ruby-identifier">listener</span>.<span class="ruby-identifier">call</span> <span class="ruby-identifier">match</span>, <span class="ruby-keyword">self</span>}
           } <span class="ruby-keyword">if</span> <span class="ruby-identifier">matches</span>

data/doc/Ionian/Extension/Socket.html CHANGED Viewed

@@ -183,13 +183,15 @@ my_socket.extend <a href="../Socket.html">Ionian::Socket</a></p>
         <div class="method-description">
+          <p>Initialize the <a href="../../Ionian.html">Ionian</a> <a
+href="Socket.html">Socket</a> variables. This is called automatically if
+extend is called on an object.</p>
           <div class="method-source-code" id="initialize_ionian_socket-source">
-            <pre><span class="ruby-comment"># File lib/ionian/extension/socket.rb, line 21</span>
+            <pre><span class="ruby-comment"># File lib/ionian/extension/socket.rb, line 23</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize_ionian_socket</span>
 <span class="ruby-keyword">end</span></pre>
           </div>
@@ -222,7 +224,7 @@ false.</p>
           <div class="method-source-code" id="no_delay-source">
-            <pre><span class="ruby-comment"># File lib/ionian/extension/socket.rb, line 26</span>
+            <pre><span class="ruby-comment"># File lib/ionian/extension/socket.rb, line 28</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">no_delay</span>
   <span class="ruby-identifier">nagle_disabled</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">getsockopt</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Socket</span><span class="ruby-operator">::</span><span class="ruby-constant">IPPROTO_TCP</span>, <span class="ruby-operator">::</span><span class="ruby-constant">Socket</span><span class="ruby-operator">::</span><span class="ruby-constant">TCP_NODELAY</span>).<span class="ruby-identifier">data</span>.<span class="ruby-identifier">ord</span>
   <span class="ruby-identifier">nagle_disabled</span> <span class="ruby-operator">&gt;</span> <span class="ruby-value">0</span> <span class="ruby-operator">?</span> <span class="ruby-keyword">true</span> <span class="ruby-operator">:</span> <span class="ruby-keyword">false</span>
@@ -257,7 +259,7 @@ false disables the flag (enables Nagle).</p>
           <div class="method-source-code" id="no_delay-3D-source">
-            <pre><span class="ruby-comment"># File lib/ionian/extension/socket.rb, line 33</span>
+            <pre><span class="ruby-comment"># File lib/ionian/extension/socket.rb, line 35</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">no_delay=</span>(<span class="ruby-identifier">value</span>)
   <span class="ruby-identifier">disable_nagle</span> = <span class="ruby-identifier">value</span> <span class="ruby-operator">?</span> <span class="ruby-value">1</span> <span class="ruby-operator">:</span> <span class="ruby-value">0</span>
   <span class="ruby-keyword">self</span>.<span class="ruby-identifier">setsockopt</span> <span class="ruby-operator">::</span><span class="ruby-constant">Socket</span><span class="ruby-operator">::</span><span class="ruby-constant">IPPROTO_TCP</span>, <span class="ruby-operator">::</span><span class="ruby-constant">Socket</span><span class="ruby-operator">::</span><span class="ruby-constant">TCP_NODELAY</span>, <span class="ruby-identifier">disable_nagle</span>

data/doc/Ionian/Extension.html CHANGED Viewed

@@ -72,6 +72,8 @@
   <section class="description">
+<p>A collection of mixins.</p>
   </section>

data/doc/Ionian/Socket.html CHANGED Viewed

@@ -118,6 +118,8 @@
   <section class="description">
+<p>A convenient wrapper for TCP, UDP, and Unix sockets.</p>
   </section>
@@ -143,7 +145,7 @@
         <div class="method-heading">
           <span class="method-name">new</span><span
-            class="method-args">(**kvargs)</span>
+            class="method-args">(**kwargs)</span>
           <span class="method-click-advice">click to toggle source</span>
@@ -152,26 +154,29 @@
         <div class="method-description">
-          <p>TODO NOTES</p>
+          <p>Args:</p>
-<p>Always lazily instiantiate @socket, even when persistent? May not work with
-forwarding method calls. Oh! Unless the forwarded methods check for @socket
-to exist. Will persistent methods have to check for the socket not to be
-closed as well?</p>
+<pre>host: IP or hostname to connect to.
+port: Connection&#39;s port number. Default is 23. Unused by :unix protocol.
+protocol: Type of socket to create. :tcp, :udp, :unix. Default is :tcp.
+persistent: The socket remains open after data is sent if this is true.
+            The socket closes after data is sent and a packet is received
+            if this is false. Default is true.
+expression: Overrides the #read_match regular expression for received data.</pre>
           <div class="method-source-code" id="new-source">
-            <pre><span class="ruby-comment"># File lib/ionian/socket.rb, line 15</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-operator">**</span><span class="ruby-identifier">kvargs</span>)
+            <pre><span class="ruby-comment"># File lib/ionian/socket.rb, line 16</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-operator">**</span><span class="ruby-identifier">kwargs</span>)
   <span class="ruby-ivar">@socket</span>         = <span class="ruby-keyword">nil</span>
-  <span class="ruby-ivar">@host</span>           = <span class="ruby-identifier">kvargs</span>.<span class="ruby-identifier">fetch</span> <span class="ruby-value">:host</span>
-  <span class="ruby-ivar">@port</span>           = <span class="ruby-identifier">kvargs</span>.<span class="ruby-identifier">fetch</span> <span class="ruby-value">:port</span>, <span class="ruby-value">23</span>
-  <span class="ruby-ivar">@expression</span>     = <span class="ruby-identifier">kvargs</span>.<span class="ruby-identifier">fetch</span> <span class="ruby-value">:expression</span>, <span class="ruby-keyword">nil</span>
-  <span class="ruby-ivar">@protocol</span>       = <span class="ruby-identifier">kvargs</span>.<span class="ruby-identifier">fetch</span> <span class="ruby-value">:protocol</span>, <span class="ruby-value">:tcp</span>
-  <span class="ruby-ivar">@persistent</span>     = <span class="ruby-identifier">kvargs</span>.<span class="ruby-identifier">fetch</span> <span class="ruby-value">:persistent</span>, <span class="ruby-keyword">true</span>
+  <span class="ruby-ivar">@host</span>           = <span class="ruby-identifier">kwargs</span>.<span class="ruby-identifier">fetch</span> <span class="ruby-value">:host</span>
+  <span class="ruby-ivar">@port</span>           = <span class="ruby-identifier">kwargs</span>.<span class="ruby-identifier">fetch</span> <span class="ruby-value">:port</span>, <span class="ruby-value">23</span>
+  <span class="ruby-ivar">@protocol</span>       = <span class="ruby-identifier">kwargs</span>.<span class="ruby-identifier">fetch</span> <span class="ruby-value">:protocol</span>, <span class="ruby-value">:tcp</span>
+  <span class="ruby-ivar">@persistent</span>     = <span class="ruby-identifier">kwargs</span>.<span class="ruby-identifier">fetch</span> <span class="ruby-value">:persistent</span>, <span class="ruby-keyword">true</span>
+  <span class="ruby-ivar">@expression</span>     = <span class="ruby-identifier">kwargs</span>.<span class="ruby-identifier">fetch</span> <span class="ruby-value">:expression</span>, <span class="ruby-keyword">nil</span>
   <span class="ruby-identifier">create_socket</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@persistent</span>
 <span class="ruby-keyword">end</span></pre>
@@ -240,7 +245,7 @@ closed as well?</p>
           <div class="method-source-code" id="closed-3F-source">
-            <pre><span class="ruby-comment"># File lib/ionian/socket.rb, line 65</span>
+            <pre><span class="ruby-comment"># File lib/ionian/socket.rb, line 73</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">closed?</span>
   <span class="ruby-keyword">return</span> <span class="ruby-keyword">true</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@socket</span>
   <span class="ruby-ivar">@socket</span>.<span class="ruby-identifier">closed?</span>
@@ -259,7 +264,7 @@ closed as well?</p>
         <div class="method-heading">
           <span class="method-name">cmd</span><span
-            class="method-args">(string, **kvargs) { |match| ... }</span>
+            class="method-args">(string, **kwargs) { |match| ... }</span>
           <span class="method-click-advice">click to toggle source</span>
@@ -268,21 +273,27 @@ closed as well?</p>
         <div class="method-description">
-          <p>Send a command (data) to the socket. Returns received matches. Block yields
-received match. See <a
-href="Extension/IO.html#method-i-read_match">Ionian::Extension::IO#read_match</a></p>
+          <p>Send a command (data) to the socket. Returns an array of received matches.
+Block yields received match. See <a
+href="Extension/IO.html#method-i-read_match">Ionian::Extension::IO#read_match</a>.</p>
           <div class="method-source-code" id="cmd-source">
-            <pre><span class="ruby-comment"># File lib/ionian/socket.rb, line 41</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier">cmd</span>(<span class="ruby-identifier">string</span>, <span class="ruby-operator">**</span><span class="ruby-identifier">kvargs</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
+            <pre><span class="ruby-comment"># File lib/ionian/socket.rb, line 43</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">cmd</span>(<span class="ruby-identifier">string</span>, <span class="ruby-operator">**</span><span class="ruby-identifier">kwargs</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
   <span class="ruby-identifier">create_socket</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@persistent</span>
-  <span class="ruby-ivar">@socket</span>.<span class="ruby-identifier">write</span> <span class="ruby-identifier">string</span>
+  <span class="ruby-keyword">if</span> <span class="ruby-ivar">@protocol</span> <span class="ruby-operator">==</span> <span class="ruby-value">:udp</span>
+    <span class="ruby-ivar">@socket</span>.<span class="ruby-identifier">send</span> <span class="ruby-identifier">string</span>, <span class="ruby-value">0</span>
+  <span class="ruby-keyword">else</span>
+    <span class="ruby-ivar">@socket</span>.<span class="ruby-identifier">write</span> <span class="ruby-identifier">string</span>
+  <span class="ruby-keyword">end</span>
   <span class="ruby-ivar">@socket</span>.<span class="ruby-identifier">flush</span>
-  <span class="ruby-identifier">matches</span> = <span class="ruby-ivar">@socket</span>.<span class="ruby-identifier">read_match</span>(<span class="ruby-identifier">kvargs</span>) {<span class="ruby-operator">|</span><span class="ruby-identifier">match</span><span class="ruby-operator">|</span> <span class="ruby-keyword">yield</span> <span class="ruby-identifier">match</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">block_given?</span>}
+  <span class="ruby-identifier">matches</span> = <span class="ruby-ivar">@socket</span>.<span class="ruby-identifier">read_match</span>(<span class="ruby-identifier">kwargs</span>) {<span class="ruby-operator">|</span><span class="ruby-identifier">match</span><span class="ruby-operator">|</span> <span class="ruby-keyword">yield</span> <span class="ruby-identifier">match</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">block_given?</span>}
   <span class="ruby-ivar">@socket</span>.<span class="ruby-identifier">close</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@persistent</span>
   <span class="ruby-identifier">matches</span>
@@ -317,7 +328,7 @@ non-persistent sockets.</p>
           <div class="method-source-code" id="flush-source">
-            <pre><span class="ruby-comment"># File lib/ionian/socket.rb, line 72</span>
+            <pre><span class="ruby-comment"># File lib/ionian/socket.rb, line 80</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">flush</span>
   <span class="ruby-ivar">@socket</span>.<span class="ruby-identifier">flush</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@persistent</span>
 <span class="ruby-keyword">end</span></pre>
@@ -335,7 +346,7 @@ non-persistent sockets.</p>
         <div class="method-heading">
           <span class="method-name">has_data?</span><span
-            class="method-args">(**kvargs)</span>
+            class="method-args">(**kwargs)</span>
           <span class="method-click-advice">click to toggle source</span>
@@ -353,10 +364,10 @@ non-persistent sockets.</p>
           <div class="method-source-code" id="has_data-3F-source">
-            <pre><span class="ruby-comment"># File lib/ionian/socket.rb, line 59</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier">has_data?</span>(<span class="ruby-operator">**</span><span class="ruby-identifier">kvargs</span>)
+            <pre><span class="ruby-comment"># File lib/ionian/socket.rb, line 67</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">has_data?</span>(<span class="ruby-operator">**</span><span class="ruby-identifier">kwargs</span>)
   <span class="ruby-keyword">return</span> <span class="ruby-keyword">false</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@socket</span>
-  <span class="ruby-ivar">@socket</span>.<span class="ruby-identifier">has_data?</span> <span class="ruby-identifier">kvargs</span>
+  <span class="ruby-ivar">@socket</span>.<span class="ruby-identifier">has_data?</span> <span class="ruby-identifier">kwargs</span>
 <span class="ruby-keyword">end</span></pre>
           </div>
@@ -387,7 +398,7 @@ non-persistent sockets.</p>
           <div class="method-source-code" id="persistent-3F-source">
-            <pre><span class="ruby-comment"># File lib/ionian/socket.rb, line 34</span>
+            <pre><span class="ruby-comment"># File lib/ionian/socket.rb, line 35</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">persistent?</span>
   <span class="ruby-ivar">@persistent</span> <span class="ruby-operator">==</span> <span class="ruby-keyword">false</span> <span class="ruby-operator">||</span> <span class="ruby-ivar">@persistent</span> <span class="ruby-operator">==</span> <span class="ruby-keyword">nil</span> <span class="ruby-operator">?</span> <span class="ruby-keyword">false</span> <span class="ruby-operator">:</span> <span class="ruby-keyword">true</span>
 <span class="ruby-keyword">end</span></pre>
@@ -421,7 +432,7 @@ non-persistent sockets.</p>
           <div class="method-source-code" id="protocol-3F-source">
-            <pre><span class="ruby-comment"># File lib/ionian/socket.rb, line 29</span>
+            <pre><span class="ruby-comment"># File lib/ionian/socket.rb, line 30</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">protocol?</span>
   <span class="ruby-ivar">@protocol</span>
 <span class="ruby-keyword">end</span></pre>
@@ -455,7 +466,7 @@ any string not already ending with one.</p>
           <div class="method-source-code" id="puts-source">
-            <pre><span class="ruby-comment"># File lib/ionian/socket.rb, line 78</span>
+            <pre><span class="ruby-comment"># File lib/ionian/socket.rb, line 86</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">puts</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">string</span>)
   <span class="ruby-keyword">self</span>.<span class="ruby-identifier">write</span> <span class="ruby-identifier">string</span>.<span class="ruby-identifier">map</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">s</span><span class="ruby-operator">|</span> <span class="ruby-identifier">s</span>.<span class="ruby-identifier">chomp</span>}.<span class="ruby-identifier">join</span>(<span class="ruby-string">&quot;\n&quot;</span>) <span class="ruby-operator">+</span> <span class="ruby-string">&quot;\n&quot;</span>
 <span class="ruby-keyword">end</span></pre>
@@ -488,10 +499,17 @@ any string not already ending with one.</p>
           <div class="method-source-code" id="write-source">
-            <pre><span class="ruby-comment"># File lib/ionian/socket.rb, line 84</span>
+            <pre><span class="ruby-comment"># File lib/ionian/socket.rb, line 92</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">write</span>(<span class="ruby-identifier">string</span>)
   <span class="ruby-identifier">create_socket</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@persistent</span>
-  <span class="ruby-identifier">num_bytes</span> = <span class="ruby-ivar">@socket</span>.<span class="ruby-identifier">write</span> <span class="ruby-identifier">string</span>
+  <span class="ruby-identifier">num_bytes</span> = <span class="ruby-value">0</span>
+  <span class="ruby-keyword">if</span> <span class="ruby-ivar">@protocol</span> <span class="ruby-operator">==</span> <span class="ruby-value">:udp</span>
+    <span class="ruby-identifier">num_bytes</span> = <span class="ruby-ivar">@socket</span>.<span class="ruby-identifier">send</span> <span class="ruby-identifier">string</span>, <span class="ruby-value">0</span>
+  <span class="ruby-keyword">else</span>
+    <span class="ruby-identifier">num_bytes</span> = <span class="ruby-ivar">@socket</span>.<span class="ruby-identifier">write</span> <span class="ruby-identifier">string</span>
+  <span class="ruby-keyword">end</span>
   <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@persistent</span>
     <span class="ruby-comment"># Read in data to prevent RST packets.</span>

data/doc/created.rid CHANGED Viewed

@@ -1,5 +1,5 @@
-Sun, 01 Dec 2013 18:46:48 -0800
-lib/ionian.rb	Sun, 01 Dec 2013 18:46:44 -0800
-lib/ionian/extension/io.rb	Sun, 01 Dec 2013 18:46:44 -0800
-lib/ionian/extension/socket.rb	Sun, 01 Dec 2013 18:46:44 -0800
-lib/ionian/socket.rb	Sun, 01 Dec 2013 18:46:44 -0800
+Tue, 03 Dec 2013 19:30:58 -0800
+lib/ionian.rb	Tue, 03 Dec 2013 19:30:50 -0800
+lib/ionian/extension/io.rb	Tue, 03 Dec 2013 19:28:00 -0800
+lib/ionian/extension/socket.rb	Tue, 03 Dec 2013 19:28:50 -0800
+lib/ionian/socket.rb	Tue, 03 Dec 2013 19:29:44 -0800

data/doc/js/search_index.js CHANGED Viewed

	@@ -1 +1 @@
1	- var search_data = {"index":{"searchIndex":["ionian","extension","io","socket","socket","<<()","closed?()","cmd()","expression()","expression=()","extended()","extended()","flush()","has_data?()","has_data?()","initialize_ionian()","initialize_ionian_socket()","new()","no_delay()","no_delay=()","on_match()","persistent?()","protocol?()","purge()","puts()","read_match()","register_observer()","run_match()","unregister_observer()","write()"],"longSearchIndex":["ionian","ionian::extension","ionian::extension::io","ionian::extension::socket","ionian::socket","ionian::socket#<<()","ionian::socket#closed?()","ionian::socket#cmd()","ionian::extension::io#expression()","ionian::extension::io#expression=()","ionian::extension::io::extended()","ionian::extension::socket::extended()","ionian::socket#flush()","ionian::extension::io#has_data?()","ionian::socket#has_data?()","ionian::extension::io#initialize_ionian()","ionian::extension::socket#initialize_ionian_socket()","ionian::socket::new()","ionian::extension::socket#no_delay()","ionian::extension::socket#no_delay=()","ionian::extension::io#on_match()","ionian::socket#persistent?()","ionian::socket#protocol?()","ionian::extension::io#purge()","ionian::socket#puts()","ionian::extension::io#read_match()","ionian::extension::io#register_observer()","ionian::extension::io#run_match()","ionian::extension::io#unregister_observer()","ionian::socket#write()"],"info":[["Ionian","","Ionian.html","","<p>A library to simplify interaction with IO streams. This includes network\nsockets, file sockets, and serial …\n"],["Ionian::Extension","","Ionian/Extension.html","",""],["Ionian::Extension::IO","","Ionian/Extension/IO.html","","<p>A mixin for IO objects that allows regular expression matching and\nconvenient notification of received …\n"],["Ionian::Extension::Socket","","Ionian/Extension/Socket.html","","<p>A mixin for Socket objects.\n<p>This module was designed to be extended by instantiated objects that\nimplement …\n"],["Ionian::Socket","","Ionian/Socket.html","",""],["<<","Ionian::Socket","Ionian/Socket.html#method-i-3C-3C","(string)",""],["closed?","Ionian::Socket","Ionian/Socket.html#method-i-closed-3F","()","<p>Returns true if the socket is closed.\n"],["cmd","Ionian::Socket","Ionian/Socket.html#method-i-cmd","(string, ~~kvargs~~, &block)","<p>Send a command (data) to the socket. Returns received matches. ~~Block~~ yields~~\nreceived~~ match. ~~See Ionian::Extension::IO#read_match~~ …\n"],["expression","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-expression","()","<p>Returns the regular expression used for #read_match.\n"],["expression=","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-expression-3D","(exp)","<p>Set the expression to match against the read buffer. Can be a regular\nexpression specifying capture groups, …\n"],["extended","Ionian::Extension::IO","Ionian/Extension/IO.html#method-c-extended","(obj)","<p>Called automaticallly when the object is extended with #extend.\n"],["extended","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-c-extended","(obj)","<p>Called automaticallly when the object is extended with #extend.\n"],["flush","Ionian::Socket","Ionian/Socket.html#method-i-flush","()","<p>Flushes buffered data to the operating system. This method has no effect on\nnon-persistent sockets.\n"],["has_data?","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-has_data-3F","(timeout: 0)","<p>Returns true if there is data in the receive buffer. Args:\n\n<pre>Timeout: Number of seconds to wait for data ...</pre>\n"],["has_data?","Ionian::Socket","Ionian/Socket.html#method-i-has_data-3F","(~~kvargs~~)","<p>Returns true if there is data in the receive buffer. Args:\n\n<pre>Timeout: Number of seconds to wait for data ...</pre>\n"],["initialize_ionian","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-initialize_ionian","()","<p>Initialize the Ionian instance variables. This is called automatically if\n#extend is called on an object. …\n"],["initialize_ionian_socket","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-initialize_ionian_socket","()",""],["new","Ionian::Socket","Ionian/Socket.html#method-c-new","(*~~kvargs~~)","<p>~~TODO NOTES~~\n<p>~~Always~~ ~~lazily~~ ~~instiantiate~~ ~~@socket,~~ ~~even~~ ~~when~~ ~~persistent?~~ ~~May~~ ~~not~~ ~~work~~ ~~with\nforwarding~~ ~~method~~ …\n"],["no_delay","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-no_delay","()","<p>Returns true if the TCP_NODELAY flag is enabled (Nagle disabled). Otherwise\nfalse.\n"],["no_delay=","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-no_delay-3D","(value)","<p>Setting to true enables the TCP_NODELAY flag (disables Nagle). Setting to\nfalse disables the flag (enables …\n"],["on_match","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-on_match","(&block)",""],["persistent?","Ionian::Socket","Ionian/Socket.html#method-i-persistent-3F","()","<p>Returns true if the socket remains open after writing data.\n"],["protocol?","Ionian::Socket","Ionian/Socket.html#method-i-protocol-3F","()","<p>Returns a symbol of the type of protocol this socket uses: :tcp, :udp,\n:unix\n"],["purge","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-purge","()","<p>Erase the data in the IO and Ionian buffers. This is typically handled\nautomatically.\n"],["puts","Ionian::Socket","Ionian/Socket.html#method-i-puts","(string)","<p>Writes the given string(s) to the socket and appends a newline character to\nany string not already ending …\n"],["read_match","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-read_match","(~~kvargs~~, &block)","<p>Read matched data from the buffer. This method SHOULD NOT be used if\n#run_match is used.\n<p>Passes matches …\n"],["register_observer","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-register_observer","(&block)","<p>Register a block to be called when #run_match receives matched data. Method\ncallbacks can be registered …\n"],["run_match","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-run_match","(~~kvargs~~)","<p>Start a thread that checks for data and notifies listeners (do \|match,\nsocket\|). Passes ~~kvargs~~ to #read_match …\n"],["unregister_observer","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-unregister_observer","(&block)","<p>Unregister a block from being called when matched data is received.\n"],["write","Ionian::Socket","Ionian/Socket.html#method-i-write","(string)","<p>Writes the given string to the socket. Returns the number of bytes written.\n"]]}}
1	+ var search_data = {"index":{"searchIndex":["ionian","extension","io","socket","socket","<<()","closed?()","cmd()","expression()","expression=()","extended()","extended()","flush()","has_data?()","has_data?()","initialize_ionian()","initialize_ionian_socket()","new()","no_delay()","no_delay=()","on_match()","persistent?()","protocol?()","purge()","puts()","read_match()","register_observer()","run_match()","unregister_observer()","write()"],"longSearchIndex":["ionian","ionian::extension","ionian::extension::io","ionian::extension::socket","ionian::socket","ionian::socket#<<()","ionian::socket#closed?()","ionian::socket#cmd()","ionian::extension::io#expression()","ionian::extension::io#expression=()","ionian::extension::io::extended()","ionian::extension::socket::extended()","ionian::socket#flush()","ionian::extension::io#has_data?()","ionian::socket#has_data?()","ionian::extension::io#initialize_ionian()","ionian::extension::socket#initialize_ionian_socket()","ionian::socket::new()","ionian::extension::socket#no_delay()","ionian::extension::socket#no_delay=()","ionian::extension::io#on_match()","ionian::socket#persistent?()","ionian::socket#protocol?()","ionian::extension::io#purge()","ionian::socket#puts()","ionian::extension::io#read_match()","ionian::extension::io#register_observer()","ionian::extension::io#run_match()","ionian::extension::io#unregister_observer()","ionian::socket#write()"],"info":[["Ionian","","Ionian.html","","<p>A library to simplify interaction with IO streams. This includes network\nsockets, file sockets, and serial …\n"],["Ionian::Extension","","Ionian/Extension.html","","<p>A collection of mixins.\n"],["Ionian::Extension::IO","","Ionian/Extension/IO.html","","<p>A mixin for IO objects that allows regular expression matching and\nconvenient notification of received …\n"],["Ionian::Extension::Socket","","Ionian/Extension/Socket.html","","<p>A mixin for Socket objects.\n<p>This module was designed to be extended by instantiated objects that\nimplement …\n"],["Ionian::Socket","","Ionian/Socket.html","","<p>A convenient wrapper for TCP, UDP, and Unix sockets.\n"],["<<","Ionian::Socket","Ionian/Socket.html#method-i-3C-3C","(string)",""],["closed?","Ionian::Socket","Ionian/Socket.html#method-i-closed-3F","()","<p>Returns true if the socket is closed.\n"],["cmd","Ionian::Socket","Ionian/Socket.html#method-i-cmd","(string, kwargs, &block)","<p>Send a command (data) to the socket. Returns an array of received matches.\nBlock yields received match. …\n"],["expression","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-expression","()","<p>Returns the regular expression used for #read_match.\n"],["expression=","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-expression-3D","(exp)","<p>Set the expression to match against the read buffer. Can be a regular\nexpression specifying capture groups, …\n"],["extended","Ionian::Extension::IO","Ionian/Extension/IO.html#method-c-extended","(obj)","<p>Called automaticallly when the object is extended with #extend.\n"],["extended","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-c-extended","(obj)","<p>Called automaticallly when the object is extended with #extend.\n"],["flush","Ionian::Socket","Ionian/Socket.html#method-i-flush","()","<p>Flushes buffered data to the operating system. This method has no effect on\nnon-persistent sockets.\n"],["has_data?","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-has_data-3F","(timeout: 0)","<p>Returns true if there is data in the receive buffer. Args:\n\n<pre>Timeout: Number of seconds to wait for data ...</pre>\n"],["has_data?","Ionian::Socket","Ionian/Socket.html#method-i-has_data-3F","(kwargs)","<p>Returns true if there is data in the receive buffer. Args:\n\n<pre>Timeout: Number of seconds to wait for data ...</pre>\n"],["initialize_ionian","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-initialize_ionian","()","<p>Initialize the Ionian instance variables. This is called automatically if\n#extend is called on an object. …\n"],["initialize_ionian_socket","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-initialize_ionian_socket","()","<p>Initialize the Ionian Socket variables. This is called automatically if\n#extend is called on an object. …\n"],["new","Ionian::Socket","Ionian/Socket.html#method-c-new","(*kwargs)","<p>Args:\n\n<pre>host: IP or hostname to connect to.\nport: Connection's port number. Default is 23. Unused by :unix ...</pre>\n"],["no_delay","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-no_delay","()","<p>Returns true if the TCP_NODELAY flag is enabled (Nagle disabled). Otherwise\nfalse.\n"],["no_delay=","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-no_delay-3D","(value)","<p>Setting to true enables the TCP_NODELAY flag (disables Nagle). Setting to\nfalse disables the flag (enables …\n"],["on_match","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-on_match","(&block)",""],["persistent?","Ionian::Socket","Ionian/Socket.html#method-i-persistent-3F","()","<p>Returns true if the socket remains open after writing data.\n"],["protocol?","Ionian::Socket","Ionian/Socket.html#method-i-protocol-3F","()","<p>Returns a symbol of the type of protocol this socket uses: :tcp, :udp,\n:unix\n"],["purge","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-purge","()","<p>Erase the data in the IO and Ionian buffers. This is typically handled\nautomatically.\n"],["puts","Ionian::Socket","Ionian/Socket.html#method-i-puts","(string)","<p>Writes the given string(s) to the socket and appends a newline character to\nany string not already ending …\n"],["read_match","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-read_match","(kwargs, &block)","<p>Read matched data from the buffer. This method SHOULD NOT be used if\n#run_match is used.\n<p>Passes matches …\n"],["register_observer","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-register_observer","(&block)","<p>Register a block to be called when #run_match receives matched data. Method\ncallbacks can be registered …\n"],["run_match","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-run_match","(kwargs)","<p>Start a thread that checks for data and notifies listeners (do \|match,\nsocket\|). Passes kwargs to #read_match …\n"],["unregister_observer","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-unregister_observer","(&block)","<p>Unregister a block from being called when matched data is received.\n"],["write","Ionian::Socket","Ionian/Socket.html#method-i-write","(string)","<p>Writes the given string to the socket. Returns the number of bytes written.\n"]]}}

data/lib/ionian/extension/io.rb CHANGED Viewed

@@ -68,16 +68,16 @@ module Ionian
       # buffer for the next #read_match cycle. This is helpful for protocols
       # like RS232 that do not have packet boundries.
       #
-      # kvargs:
+      # kwargs:
       #   timeout:        Timeout in seconds IO::select will block.
       #   skip_select:    Skip over the IO::select statement. Use if you
       #                   are calling IO::select ahead of this method.
       #   build_methods:  Build method accessors from named captures.
       #                   Enabled by default.
-      def read_match(**kvargs, &block)
-        timeout       = kvargs.fetch :timeout, @ionian_timeout
-        skip_select   = kvargs.fetch :skip_select, @ionian_skip_select
-        build_methods = kvargs.fetch :build_methods, @ionian_build_methods
+      def read_match(**kwargs, &block)
+        timeout       = kwargs.fetch :timeout, @ionian_timeout
+        skip_select   = kwargs.fetch :skip_select, @ionian_skip_select
+        build_methods = kwargs.fetch :build_methods, @ionian_build_methods
         unless skip_select
           return nil unless ::IO.select [self], nil, nil, timeout
@@ -113,13 +113,13 @@ module Ionian
       end
       # Start a thread that checks for data and notifies listeners (do |match, socket|).
-      # Passes kvargs to #read_match.
+      # Passes kwargs to #read_match.
       # This method SHOULD NOT be used if #read_match is used.
-      def run_match(**kvargs)
+      def run_match(**kwargs)
         @match_listener ||= Thread.new do
           begin
             while not closed? do
-                matches = read_match kvargs
+                matches = read_match kwargs
                 matches.each {|match|
                   @ionian_listeners.each {|listener| listener.call match, self}
                 } if matches

data/lib/ionian/extension/socket.rb CHANGED Viewed

@@ -18,6 +18,8 @@ module Ionian
         obj.initialize_ionian_socket
       end
+      # Initialize the Ionian Socket variables.
+      # This is called automatically if #extend is called on an object.
       def initialize_ionian_socket
       end

data/lib/ionian/socket.rb CHANGED Viewed

@@ -1,25 +1,26 @@
 require 'ionian/extension/socket'
 module Ionian
+  # A convenient wrapper for TCP, UDP, and Unix sockets.
   class Socket
-    ############
-    # TODO NOTES
-    ############
-    # Always lazily instiantiate @socket, even when persistent?
-    # May not work with forwarding method calls.
-    # Oh! Unless the forwarded methods check for @socket to exist.
-    # Will persistent methods have to check for the socket not to be
-    # closed as well?
-    def initialize(**kvargs)
+    # Args:
+    #   host: IP or hostname to connect to.
+    #   port: Connection's port number. Default is 23. Unused by :unix protocol.
+    #   protocol: Type of socket to create. :tcp, :udp, :unix. Default is :tcp.
+    #   persistent: The socket remains open after data is sent if this is true.
+    #               The socket closes after data is sent and a packet is received
+    #               if this is false. Default is true.
+    #   expression: Overrides the #read_match regular expression for received data.
+    def initialize(**kwargs)
       @socket         = nil
-      @host           = kvargs.fetch :host
-      @port           = kvargs.fetch :port, 23
-      @expression     = kvargs.fetch :expression, nil
-      @protocol       = kvargs.fetch :protocol, :tcp
-      @persistent     = kvargs.fetch :persistent, true
+      @host           = kwargs.fetch :host
+      @port           = kwargs.fetch :port, 23
+      @protocol       = kwargs.fetch :protocol, :tcp
+      @persistent     = kwargs.fetch :persistent, true
+      @expression     = kwargs.fetch :expression, nil
       create_socket if @persistent
     end
@@ -35,15 +36,22 @@ module Ionian
       @persistent == false || @persistent == nil ? false : true
     end
-    # Send a command (data) to the socket. Returns received matches.
+    # Send a command (data) to the socket.
+    # Returns an array of received matches.
     # Block yields received match.
-    # See Ionian::Extension::IO#read_match
-    def cmd(string, **kvargs, &block)
+    # See Ionian::Extension::IO#read_match.
+    def cmd(string, **kwargs, &block)
       create_socket unless @persistent
-      @socket.write string
+      if @protocol == :udp
+        @socket.send string, 0
+      else
+        @socket.write string
+      end
       @socket.flush
-      matches = @socket.read_match(kvargs) {|match| yield match if block_given?}
+      matches = @socket.read_match(kwargs) {|match| yield match if block_given?}
       @socket.close unless @persistent
       matches
@@ -56,9 +64,9 @@ module Ionian
     # Args:
     #   Timeout: Number of seconds to wait for data until
     #     giving up. Set to nil for blocking.
-    def has_data?(**kvargs)
+    def has_data?(**kwargs)
       return false unless @socket
-      @socket.has_data? kvargs
+      @socket.has_data? kwargs
     end
     # Returns true if the socket is closed.
@@ -83,7 +91,14 @@ module Ionian
     # bytes written.
     def write(string)
       create_socket unless @persistent
-      num_bytes = @socket.write string
+      num_bytes = 0
+      if @protocol == :udp
+        num_bytes = @socket.send string, 0
+      else
+        num_bytes = @socket.write string
+      end
       unless @persistent
         # Read in data to prevent RST packets.
@@ -101,6 +116,7 @@ module Ionian
     private
+    # Initialize or reinitialize @socket.
     def create_socket
       @socket.close if @socket and not @socket.closed?
@@ -109,6 +125,7 @@ module Ionian
         @socket = ::TCPSocket.new @host, @port
       when :udp
         @socket = ::UDPSocket.new
+        @socket.bind '', @port
         @socket.connect @host, @port
       when :unix
         @socket = ::UNIXSocket.new @host

data/lib/ionian.rb CHANGED Viewed

@@ -7,4 +7,9 @@ require 'ionian/socket'
 # serial streams like the console and RS232. Features
 # regular expression matching and notification of
 # received data.
-module Ionian; end
+module Ionian
+  # A collection of mixins.
+  module Extension; end
+end

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ionian
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Alex McLain
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-12-01 00:00:00.000000000 Z
+date: 2013-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: fivemat
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A library to simplify interaction with IO streams. This includes network
   sockets, file sockets, and serial streams like the console and RS232. Features regular
   expression matching and notification of received data.
@@ -117,7 +131,6 @@ files:
 - doc/Ionian.html
 - doc/fonts.css
 - doc/Ionian/Extension.html
-- doc/Ionian/IO.html
 - doc/Ionian/Socket.html
 - doc/Ionian/Extension/IO.html
 - doc/Ionian/Extension/Socket.html

data/doc/Ionian/IO.html DELETED Viewed

@@ -1,598 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-<meta charset="UTF-8">
-<title>module Ionian::IO - RDoc Documentation</title>
-<link href="../fonts.css" rel="stylesheet">
-<link href="../rdoc.css" rel="stylesheet">
-<script type="text/javascript">
-  var rdoc_rel_prefix = "../";
-</script>
-<script src="../js/jquery.js"></script>
-<script src="../js/navigation.js"></script>
-<script src="../js/search_index.js"></script>
-<script src="../js/search.js"></script>
-<script src="../js/searcher.js"></script>
-<script src="../js/darkfish.js"></script>
-<body id="top" role="document" class="module">
-<nav role="navigation">
-  <div id="project-navigation">
-    <div id="home-section" role="banner" class="nav-section">
-  <h2>
-    <a href="../index.html" rel="home">Home</a>
-  </h2>
-  <h3>
-    <a href="../table_of_contents.html#pages">Pages</a>
-    <a href="../table_of_contents.html#classes">Classes</a>
-    <a href="../table_of_contents.html#methods">Methods</a>
-  </h3>
-</div>
-    <div id="search-section" role="search" class="project-section initially-hidden">
-  <form action="#" method="get" accept-charset="utf-8">
-    <div id="search-field-wrapper">
-      <input id="search-field" role="combobox" aria-label="Search"
-             aria-autocomplete="list" aria-controls="search-results"
-             type="text" name="search" placeholder="Search"
-             title="Type to search, Up and Down to navigate, Enter to load">
-    </div>
-    <ul id="search-results" aria-label="Search Results"
-        aria-busy="false" aria-expanded="false"
-        aria-atomic="false" aria-live="polite"
-        aria-relevant="all" class="initially-hidden"></ul>
-  </form>
-</div>
-  </div>
-  <div id="class-metadata">
-    <!-- Method Quickref -->
-<div id="method-list-section" class="nav-section">
-  <h3>Methods</h3>
-  <ul class="link-list" role="directory">
-    <li ><a href="#method-c-extended">::extended</a>
-    <li ><a href="#method-i-expression">#expression</a>
-    <li ><a href="#method-i-expression-3D">#expression=</a>
-    <li ><a href="#method-i-initialize_ionian">#initialize_ionian</a>
-    <li ><a href="#method-i-on_match">#on_match</a>
-    <li ><a href="#method-i-purge">#purge</a>
-    <li ><a href="#method-i-read_match">#read_match</a>
-    <li ><a href="#method-i-register_observer">#register_observer</a>
-    <li ><a href="#method-i-run_match">#run_match</a>
-    <li ><a href="#method-i-unregister_observer">#unregister_observer</a>
-  </ul>
-</div>
-  </div>
-</nav>
-<main role="main" aria-labelledby="module-Ionian::IO">
-  <h1 id="module-Ionian::IO" class="module">
-    module Ionian::IO
-  </h1>
-  <section class="description">
-<p>A mixin for <a href="IO.html">IO</a> objects that allows regular expression
-matching and convenient notification of received data.</p>
-<p>This module was designed to be extended by instantiated objects that
-implement the standard library <a href="IO.html">IO</a> class.
-my_socket.extend <a href="IO.html">Ionian::IO</a></p>
-  </section>
-  <section id="5Buntitled-5D" class="documentation-section">
-    <section class="attribute-method-details" class="method-section">
-      <header>
-        <h3>Attributes</h3>
-      </header>
-      <div id="attribute-i-ionian_timeout" class="method-detail">
-        <div class="method-heading attribute-method-heading">
-          <span class="method-name">ionian_timeout</span><span
-            class="attribute-access-type">[RW]</span>
-        </div>
-        <div class="method-description">
-        <p>Number of seconds to attempt an <a href="IO.html">IO</a> operation before
-timing out. See standard library IO::select.</p>
-        </div>
-      </div>
-    </section>
-     <section id="public-class-5Buntitled-5D-method-details" class="method-section">
-       <header>
-         <h3>Public Class Methods</h3>
-       </header>
-      <div id="method-c-extended" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-name">extended</span><span
-            class="method-args">(obj)</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <p>Called automaticallly when the object is extended with extend.</p>
-          <div class="method-source-code" id="extended-source">
-            <pre><span class="ruby-comment"># File lib/ionian/io.rb, line 14</span>
-<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">extended</span>(<span class="ruby-identifier">obj</span>)
-  <span class="ruby-identifier">obj</span>.<span class="ruby-identifier">initialize_ionian</span>
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-      </div>
-    </section>
-     <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
-       <header>
-         <h3>Public Instance Methods</h3>
-       </header>
-      <div id="method-i-expression" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-name">expression</span><span
-            class="method-args">()</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <p>Returns the regular expression used for <a
-href="IO.html#method-i-read_match">read_match</a>.</p>
-          <div class="method-source-code" id="expression-source">
-            <pre><span class="ruby-comment"># File lib/ionian/io.rb, line 30</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier">expression</span>
-  <span class="ruby-ivar">@ionian_expression</span>
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-      </div>
-      <div id="method-i-expression-3D" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-name">expression=</span><span
-            class="method-args">(exp)</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <p>Set the expression to match against the read buffer. Can be a regular
-expression specifying capture groups, or a string specifying the separator
-or line terminator sequence. It is possible to use named captures in a
-regex, which allows for convienient accessors like <a
-href=":parameter">match</a>.</p>
-          <div class="method-source-code" id="expression-3D-source">
-            <pre><span class="ruby-comment"># File lib/ionian/io.rb, line 40</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier">expression=</span>(<span class="ruby-identifier">exp</span>)
-  <span class="ruby-ivar">@ionian_expression</span> = <span class="ruby-identifier">exp</span>
-  <span class="ruby-ivar">@ionian_expression</span> = <span class="ruby-constant">Regexp</span>.<span class="ruby-identifier">new</span> <span class="ruby-node">&quot;(.*?)#{expression}&quot;</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">exp</span>.<span class="ruby-identifier">is_a?</span> <span class="ruby-constant">String</span>
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-      </div>
-      <div id="method-i-initialize_ionian" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-name">initialize_ionian</span><span
-            class="method-args">()</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <p>Initialize the <a href="../Ionian.html">Ionian</a> instance variables. This
-is called automatically if extend is called on an object.</p>
-          <div class="method-source-code" id="initialize_ionian-source">
-            <pre><span class="ruby-comment"># File lib/ionian/io.rb, line 20</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize_ionian</span>
-  <span class="ruby-ivar">@ionian_listeners</span>     = []
-  <span class="ruby-ivar">@ionian_buf</span>           = <span class="ruby-string">&#39;&#39;</span>
-  <span class="ruby-ivar">@ionian_expression</span>    = <span class="ruby-regexp">/(.*?)\n/</span>
-  <span class="ruby-ivar">@ionian_timeout</span>       = <span class="ruby-keyword">nil</span>
-  <span class="ruby-ivar">@ionian_skip_select</span>   = <span class="ruby-keyword">false</span>
-  <span class="ruby-ivar">@ionian_build_methods</span> = <span class="ruby-keyword">true</span>
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-      </div>
-      <div id="method-i-on_match" class="method-detail method-alias">
-        <div class="method-heading">
-          <span class="method-name">on_match</span><span
-            class="method-args">(&block)</span>
-        </div>
-        <div class="method-description">
-        </div>
-        <div class="aliases">
-          Alias for: <a href="IO.html#method-i-register_observer">register_observer</a>
-        </div>
-      </div>
-      <div id="method-i-purge" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-name">purge</span><span
-            class="method-args">()</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <p>Erase the data in the <a href="IO.html">IO</a> and <a
-href="../Ionian.html">Ionian</a> buffers. This is typically handled
-automatically.</p>
-          <div class="method-source-code" id="purge-source">
-            <pre><span class="ruby-comment"># File lib/ionian/io.rb, line 128</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier">purge</span>
-  <span class="ruby-comment"># Erase IO buffer.</span>
-  <span class="ruby-keyword">while</span> <span class="ruby-operator">::</span><span class="ruby-constant">IO</span>.<span class="ruby-identifier">select</span> [<span class="ruby-keyword">self</span>], <span class="ruby-keyword">nil</span>, <span class="ruby-keyword">nil</span>, <span class="ruby-value">0</span>
-    <span class="ruby-identifier">readpartial</span>(<span class="ruby-value">0xFFFF</span>)
-  <span class="ruby-keyword">end</span>
-  <span class="ruby-ivar">@ionian_buf</span> = <span class="ruby-string">&#39;&#39;</span>
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-      </div>
-      <div id="method-i-read_match" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-name">read_match</span><span
-            class="method-args">(**kvargs) { |$~| ... }</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <p>Read matched data from the buffer. This method SHOULD NOT be used if <a
-href="IO.html#method-i-run_match">run_match</a> 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>
-<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 <a href="IO.html#method-i-read_match">read_match</a> cycle. This is
-helpful for protocols like RS232 that do not have packet boundries.</p>
-<p>kvargs:</p>
-<pre>timeout:        Timeout in seconds IO::select will block.
-skip_select:    Skip over the IO::select statement. Use if you
-                are calling IO::select ahead of this method.
-build_methods:  Build method accessors from named captures.
-                Enabled by default.</pre>
-          <div class="method-source-code" id="read_match-source">
-            <pre><span class="ruby-comment"># File lib/ionian/io.rb, line 68</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier">read_match</span>(<span class="ruby-operator">**</span><span class="ruby-identifier">kvargs</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
-  <span class="ruby-identifier">timeout</span>       = <span class="ruby-identifier">kvargs</span>.<span class="ruby-identifier">fetch</span> <span class="ruby-value">:timeout</span>, <span class="ruby-ivar">@ionian_timeout</span>
-  <span class="ruby-identifier">skip_select</span>   = <span class="ruby-identifier">kvargs</span>.<span class="ruby-identifier">fetch</span> <span class="ruby-value">:skip_select</span>, <span class="ruby-ivar">@ionian_skip_select</span>
-  <span class="ruby-identifier">build_methods</span> = <span class="ruby-identifier">kvargs</span>.<span class="ruby-identifier">fetch</span> <span class="ruby-value">:build_methods</span>, <span class="ruby-ivar">@ionian_build_methods</span>
-  <span class="ruby-keyword">unless</span> <span class="ruby-identifier">skip_select</span>
-    <span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">unless</span> <span class="ruby-operator">::</span><span class="ruby-constant">IO</span>.<span class="ruby-identifier">select</span> [<span class="ruby-keyword">self</span>], <span class="ruby-keyword">nil</span>, <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">timeout</span>
-  <span class="ruby-keyword">end</span>
-  <span class="ruby-comment"># Read data from the IO buffer until it&#39;s empty.</span>
-  <span class="ruby-identifier">loop</span> <span class="ruby-keyword">do</span>
-    <span class="ruby-ivar">@ionian_buf</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">readpartial</span>(<span class="ruby-value">0xFFFF</span>)
-    <span class="ruby-keyword">break</span> <span class="ruby-keyword">unless</span> <span class="ruby-operator">::</span><span class="ruby-constant">IO</span>.<span class="ruby-identifier">select</span> [<span class="ruby-keyword">self</span>], <span class="ruby-keyword">nil</span>, <span class="ruby-keyword">nil</span>, <span class="ruby-value">0</span>
-  <span class="ruby-keyword">end</span>
-  <span class="ruby-ivar">@matches</span> = []
-  <span class="ruby-keyword">while</span> <span class="ruby-ivar">@ionian_buf</span> <span class="ruby-operator">=~</span> <span class="ruby-ivar">@ionian_expression</span>
-    <span class="ruby-ivar">@matches</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">$~</span> <span class="ruby-comment"># Match data.</span>
-    <span class="ruby-keyword">yield</span> <span class="ruby-identifier">$~</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">block_given?</span>
-    <span class="ruby-ivar">@ionian_buf</span> = <span class="ruby-node">$&#39;</span> <span class="ruby-comment"># Leave post match data in the buffer.</span>
-  <span class="ruby-keyword">end</span>
-  <span class="ruby-comment"># Convert named captures to methods.</span>
-  <span class="ruby-keyword">if</span> <span class="ruby-identifier">build_methods</span>
-    <span class="ruby-ivar">@matches</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">match</span><span class="ruby-operator">|</span>
-      <span class="ruby-identifier">match</span>.<span class="ruby-identifier">names</span>
-        .<span class="ruby-identifier">map</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">name</span><span class="ruby-operator">|</span> <span class="ruby-identifier">name</span>.<span class="ruby-identifier">to_sym</span>}
-        .<span class="ruby-identifier">each</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">symbol</span><span class="ruby-operator">|</span> <span class="ruby-identifier">match</span>.<span class="ruby-identifier">singleton_class</span>
-          .<span class="ruby-identifier">send</span>(<span class="ruby-value">:define_method</span>, <span class="ruby-identifier">symbol</span>) { <span class="ruby-identifier">match</span>[<span class="ruby-identifier">symbol</span>] }                  <span class="ruby-keyword">unless</span> <span class="ruby-identifier">match</span>.<span class="ruby-identifier">respond_to?</span> <span class="ruby-identifier">symbol</span>
-        }
-    <span class="ruby-keyword">end</span>
-  <span class="ruby-keyword">end</span>
-  <span class="ruby-ivar">@matches</span>
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-      </div>
-      <div id="method-i-register_observer" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-name">register_observer</span><span
-            class="method-args">(&block)</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <p>Register a block to be called when <a
-href="IO.html#method-i-run_match">run_match</a> 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>
-          <div class="method-source-code" id="register_observer-source">
-            <pre><span class="ruby-comment"># File lib/ionian/io.rb, line 141</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier">register_observer</span>(<span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
-  <span class="ruby-ivar">@ionian_listeners</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">block</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@ionian_listeners</span>.<span class="ruby-identifier">include?</span> <span class="ruby-identifier">block</span>
-  <span class="ruby-identifier">block</span>
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-        <div class="aliases">
-          Also aliased as: <a href="IO.html#method-i-on_match">on_match</a>
-        </div>
-      </div>
-      <div id="method-i-run_match" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-name">run_match</span><span
-            class="method-args">(**kvargs)</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <p>Start a thread that checks for data and notifies listeners (do |match,
-socket|). Passes kvargs to <a
-href="IO.html#method-i-read_match">read_match</a>. This method SHOULD NOT
-be used if <a href="IO.html#method-i-read_match">read_match</a> is used.</p>
-          <div class="method-source-code" id="run_match-source">
-            <pre><span class="ruby-comment"># File lib/ionian/io.rb, line 109</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier">run_match</span>(<span class="ruby-operator">**</span><span class="ruby-identifier">kvargs</span>)
-  <span class="ruby-ivar">@match_listener</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">Thread</span>.<span class="ruby-identifier">new</span> <span class="ruby-keyword">do</span>
-    <span class="ruby-keyword">begin</span>
-      <span class="ruby-keyword">while</span> <span class="ruby-keyword">not</span> <span class="ruby-identifier">closed?</span> <span class="ruby-keyword">do</span>
-          <span class="ruby-identifier">matches</span> = <span class="ruby-identifier">read_match</span> <span class="ruby-identifier">kvargs</span>
-          <span class="ruby-identifier">matches</span>.<span class="ruby-identifier">each</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">match</span><span class="ruby-operator">|</span>
-            <span class="ruby-ivar">@ionian_listeners</span>.<span class="ruby-identifier">each</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">listener</span><span class="ruby-operator">|</span> <span class="ruby-identifier">listener</span>.<span class="ruby-identifier">call</span> <span class="ruby-identifier">match</span>, <span class="ruby-keyword">self</span>}
-          } <span class="ruby-keyword">if</span> <span class="ruby-identifier">matches</span>
-      <span class="ruby-keyword">end</span>
-    <span class="ruby-keyword">rescue</span> <span class="ruby-constant">EOFError</span>
-    <span class="ruby-keyword">rescue</span> <span class="ruby-constant">IOError</span>
-    <span class="ruby-keyword">end</span>
-    <span class="ruby-ivar">@match_listener</span> = <span class="ruby-keyword">nil</span>
-  <span class="ruby-keyword">end</span>
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-      </div>
-      <div id="method-i-unregister_observer" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-name">unregister_observer</span><span
-            class="method-args">(&block)</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <p>Unregister a block from being called when matched data is received.</p>
-          <div class="method-source-code" id="unregister_observer-source">
-            <pre><span class="ruby-comment"># File lib/ionian/io.rb, line 149</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier">unregister_observer</span>(<span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
-  <span class="ruby-ivar">@ionian_listeners</span>.<span class="ruby-identifier">delete_if</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">o</span><span class="ruby-operator">|</span> <span class="ruby-identifier">o</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">block</span>}
-  <span class="ruby-identifier">block</span>
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-      </div>
-    </section>
-  </section>
-</main>
-<footer id="validator-badges" role="contentinfo">
-  <p><a href="http://validator.w3.org/check/referer">Validate</a>
-  <p>Generated by <a href="http://rdoc.rubyforge.org">RDoc</a> 4.1.0.preview.1.
-  <p>Based on <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
-</footer>