ionian 0.6.5 → 0.6.6

data/doc/Ionian/Socket.html

@@ -566,7 +566,7 @@ any string not already ending with one.</p>
 
 <p>Args:</p>
 
-<pre class="code ruby"><code class="ruby">host:       IP or hostname to connect to.
+<pre class="code ruby"><code class="ruby">host:       IP or hostname to connect to. Can contain the port in the format &quot;host:port&quot;.
 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.
             :udp will be automatically selected for addresses in the multicast range.
@@ -593,12 +593,6 @@ expression: Overrides the #read_match regular expression for received data.</cod
       <pre class="lines">
 
 
-34
-35
-36
-37
-38
-39
 40
 41
 42
@@ -653,10 +647,16 @@ expression: Overrides the #read_match regular expression for received data.</cod
 91
 92
 93
-94</pre>
+94
+95
+96
+97
+98
+99
+100</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ionian/socket.rb', line 34</span>
+      <pre class="code"><span class="info file"># File 'lib/ionian/socket.rb', line 40</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span> <span class='id identifier rubyid_existing_socket'>existing_socket</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_kwargs'>kwargs</span>
   <span class='ivar'>@socket</span> <span class='op'>=</span> <span class='id identifier rubyid_existing_socket'>existing_socket</span>
@@ -891,12 +891,12 @@ expression: Overrides the #read_match regular expression for received data.</cod
       <pre class="lines">
 
 
-98
-99
-100</pre>
+19
+20
+21</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ionian/socket.rb', line 98</span>
+      <pre class="code"><span class="info file"># File 'lib/ionian/socket.rb', line 19</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_protocol'>protocol</span>
   <span class='ivar'>@protocol</span>
@@ -952,13 +952,13 @@ expression: Overrides the #read_match regular expression for received data.</cod
       <pre class="lines">
 
 
-169
 170
 171
-172</pre>
+172
+173</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ionian/socket.rb', line 169</span>
+      <pre class="code"><span class="info file"># File 'lib/ionian/socket.rb', line 170</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>
@@ -996,7 +996,6 @@ Block yields received match. See Ionian::Extension::IO#read_match.</p>
       <pre class="lines">
 
 
-121
 122
 123
 124
@@ -1011,10 +1010,11 @@ Block yields received match. See Ionian::Extension::IO#read_match.</p>
 133
 134
 135
-136</pre>
+136
+137</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ionian/socket.rb', line 121</span>
+      <pre class="code"><span class="info file"># File 'lib/ionian/socket.rb', line 122</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_cmd'>cmd</span> <span class='id identifier rubyid_string'>string</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>
@@ -1063,12 +1063,12 @@ Block yields received match. See Ionian::Extension::IO#read_match.</p>
       <pre class="lines">
 
 
-102
 103
-104</pre>
+104
+105</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ionian/socket.rb', line 102</span>
+      <pre class="code"><span class="info file"># File 'lib/ionian/socket.rb', line 103</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>
@@ -1104,13 +1104,13 @@ Block yields received match. See Ionian::Extension::IO#read_match.</p>
       <pre class="lines">
 
 
-107
 108
 109
-110</pre>
+110
+111</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ionian/socket.rb', line 107</span>
+      <pre class="code"><span class="info file"># File 'lib/ionian/socket.rb', line 108</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>
@@ -1148,12 +1148,12 @@ non-persistent sockets.</p>
       <pre class="lines">
 
 
-176
 177
-178</pre>
+178
+179</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ionian/socket.rb', line 176</span>
+      <pre class="code"><span class="info file"># File 'lib/ionian/socket.rb', line 177</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>
@@ -1205,13 +1205,13 @@ non-persistent sockets.</p>
       <pre class="lines">
 
 
-163
 164
 165
-166</pre>
+166
+167</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ionian/socket.rb', line 163</span>
+      <pre class="code"><span class="info file"># File 'lib/ionian/socket.rb', line 164</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>
@@ -1261,12 +1261,12 @@ non-persistent sockets.</p>
       <pre class="lines">
 
 
-113
 114
-115</pre>
+115
+116</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ionian/socket.rb', line 113</span>
+      <pre class="code"><span class="info file"># File 'lib/ionian/socket.rb', line 114</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>
@@ -1303,12 +1303,12 @@ any string not already ending with one.</p>
       <pre class="lines">
 
 
-182
 183
-184</pre>
+184
+185</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ionian/socket.rb', line 182</span>
+      <pre class="code"><span class="info file"># File 'lib/ionian/socket.rb', line 183</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>
@@ -1350,14 +1350,14 @@ reference to the given block. block = ionian_socket.register_observer { … }</p
       <pre class="lines">
 
 
-142
 143
 144
 145
-146</pre>
+146
+147</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ionian/socket.rb', line 142</span>
+      <pre class="code"><span class="info file"># File 'lib/ionian/socket.rb', line 143</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>
@@ -1395,14 +1395,14 @@ reference to the given block. block = ionian_socket.register_observer { … }</p
       <pre class="lines">
 
 
-151
 152
 153
 154
-155</pre>
+155
+156</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ionian/socket.rb', line 151</span>
+      <pre class="code"><span class="info file"># File 'lib/ionian/socket.rb', line 152</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>
@@ -1444,7 +1444,6 @@ reference to the given block. block = ionian_socket.register_observer { … }</p
       <pre class="lines">
 
 
-188
 189
 190
 191
@@ -1464,10 +1463,11 @@ reference to the given block. block = ionian_socket.register_observer { … }</p
 205
 206
 207
-208</pre>
+208
+209</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ionian/socket.rb', line 188</span>
+      <pre class="code"><span class="info file"># File 'lib/ionian/socket.rb', line 189</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>
@@ -1500,7 +1500,7 @@ reference to the given block. block = ionian_socket.register_observer { … }</p
 </div>
 
     <div id="footer">
-  Generated on Fri Apr 11 21:18:17 2014 by
+  Generated on Sat Apr 12 13:24:31 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).
 </div>

data/doc/Ionian.html

@@ -123,7 +123,7 @@ Features regular expression matching and notification of received data.</p>
 </div>
 
     <div id="footer">
-  Generated on Fri Apr 11 21:18:17 2014 by
+  Generated on Sat Apr 12 13:24:31 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).
 </div>

data/doc/_index.html

@@ -155,7 +155,7 @@
 </div>
 
     <div id="footer">
-  Generated on Fri Apr 11 21:18:17 2014 by
+  Generated on Sat Apr 12 13:24:31 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).
 </div>

data/doc/file.README.html

@@ -98,8 +98,7 @@
 <pre class="code ruby"><code class="ruby"><span class='comment'># A simple IRC client.
 </span>
 <span class='id identifier rubyid_socket'>socket</span> <span class='op'>=</span> <span class='const'>Ionian</span><span class='op'>::</span><span class='const'>Socket</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> \
-  <span class='label'>host:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>chat.freenode.net</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
-  <span class='label'>port:</span> <span class='int'>6667</span><span class='comma'>,</span>
+  <span class='label'>host:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>chat.freenode.net:6667</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
   <span class='comment'># Break up the matches into named captures so it&#39;s easier
 </span>  <span class='comment'># to sort through the server&#39;s responses.
 </span>  <span class='label'>expression:</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>:(?&lt;server&gt;.*?)\s*:(?&lt;msg&gt;.*?)[\r\n]+</span><span class='regexp_end'>/</span></span>
@@ -121,10 +120,24 @@
   <span class='kw'>end</span>
 <span class='kw'>end</span>
 </code></pre>
+
+<h3>Simple Server</h3>
+
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_host'>host</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>localhost:5000</span><span class='tstring_end'>&#39;</span></span>
+
+<span class='id identifier rubyid_server'>server</span> <span class='op'>=</span> <span class='const'>Ionian</span><span class='op'>::</span><span class='const'>Server</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='label'>interface:</span> <span class='id identifier rubyid_host'>host</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_client'>client</span><span class='op'>|</span>
+  <span class='comment'># Greet the connected client.
+</span>  <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Welcome! You are connected to the server.\n</span><span class='tstring_end'>&quot;</span></span>
+<span class='kw'>end</span>
+
+<span class='id identifier rubyid_socket'>socket</span> <span class='op'>=</span> <span class='const'>Ionian</span><span class='op'>::</span><span class='const'>Socket</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='label'>host:</span> <span class='id identifier rubyid_host'>host</span>
+<span class='comment'># Retrieve the greeting message.
+</span><span class='id identifier rubyid_puts'>puts</span> <span class='id identifier rubyid_socket'>socket</span><span class='period'>.</span><span class='id identifier rubyid_read_all'>read_all</span>
+</code></pre>
 </div></div>
 
     <div id="footer">
-  Generated on Fri Apr 11 21:18:17 2014 by
+  Generated on Sat Apr 12 13:24:31 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).
 </div>

data/doc/file.license.html

@@ -64,7 +64,7 @@
     <div id="content"><div id='filecontents'>The MIT License (MIT)<br/><br/>Copyright (c) 2013 Alex McLain<br/><br/>Permission is hereby granted, free of charge, to any person obtaining a copy<br/>of this software and associated documentation files (the &quot;Software&quot;), to deal<br/>in the Software without restriction, including without limitation the rights<br/>to use, copy, modify, merge, publish, distribute, sublicense, and/or sell<br/>copies of the Software, and to permit persons to whom the Software is<br/>furnished to do so, subject to the following conditions:<br/><br/>The above copyright notice and this permission notice shall be included in<br/>all copies or substantial portions of the Software.<br/><br/>THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR<br/>IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,<br/>FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE<br/>AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER<br/>LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,<br/>OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN<br/>THE SOFTWARE.
 
     <div id="footer">
-  Generated on Fri Apr 11 21:18:17 2014 by
+  Generated on Sat Apr 12 13:24:31 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).
 </div>

data/doc/index.html

@@ -98,8 +98,7 @@
 <pre class="code ruby"><code class="ruby"><span class='comment'># A simple IRC client.
 </span>
 <span class='id identifier rubyid_socket'>socket</span> <span class='op'>=</span> <span class='const'>Ionian</span><span class='op'>::</span><span class='const'>Socket</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> \
-  <span class='label'>host:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>chat.freenode.net</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
-  <span class='label'>port:</span> <span class='int'>6667</span><span class='comma'>,</span>
+  <span class='label'>host:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>chat.freenode.net:6667</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
   <span class='comment'># Break up the matches into named captures so it&#39;s easier
 </span>  <span class='comment'># to sort through the server&#39;s responses.
 </span>  <span class='label'>expression:</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>:(?&lt;server&gt;.*?)\s*:(?&lt;msg&gt;.*?)[\r\n]+</span><span class='regexp_end'>/</span></span>
@@ -121,10 +120,24 @@
   <span class='kw'>end</span>
 <span class='kw'>end</span>
 </code></pre>
+
+<h3>Simple Server</h3>
+
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_host'>host</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>localhost:5000</span><span class='tstring_end'>&#39;</span></span>
+
+<span class='id identifier rubyid_server'>server</span> <span class='op'>=</span> <span class='const'>Ionian</span><span class='op'>::</span><span class='const'>Server</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='label'>interface:</span> <span class='id identifier rubyid_host'>host</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_client'>client</span><span class='op'>|</span>
+  <span class='comment'># Greet the connected client.
+</span>  <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Welcome! You are connected to the server.\n</span><span class='tstring_end'>&quot;</span></span>
+<span class='kw'>end</span>
+
+<span class='id identifier rubyid_socket'>socket</span> <span class='op'>=</span> <span class='const'>Ionian</span><span class='op'>::</span><span class='const'>Socket</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='label'>host:</span> <span class='id identifier rubyid_host'>host</span>
+<span class='comment'># Retrieve the greeting message.
+</span><span class='id identifier rubyid_puts'>puts</span> <span class='id identifier rubyid_socket'>socket</span><span class='period'>.</span><span class='id identifier rubyid_read_all'>read_all</span>
+</code></pre>
 </div></div>
 
     <div id="footer">
-  Generated on Fri Apr 11 21:18:17 2014 by
+  Generated on Sat Apr 12 13:24:31 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).
 </div>