ionian 0.6.5 → 0.6.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7bf864733d5bbfd958bf4d506a57f2b5823574f4
-  data.tar.gz: 38dd61bf25fe9ebf638cccbd3b8ec6da92f8812e
+  metadata.gz: 1cb36e7af34abe393cc46d7f30ce072f409a5c9b
+  data.tar.gz: d65cc6850c15fc177751cd29a9594ae47cdd4d8a
 SHA512:
-  metadata.gz: d894ba9d981ed524d43c4397ae1cb420520e1e051684b4f9d425a03f96dc400df9d8cc0fa8a66fb118371276eeee2be5d7afc6970912f453b8353f8711d87502
-  data.tar.gz: 8f706f1afad7e4e32ae664b00603a9875bb5f369581b8bb550a35aa6503c3c2c4b698d9b387cda7aa12a2af83480faaf4b87268c843fc5bdd69d7d596a99e38e
+  metadata.gz: 1dfb53195818fe11aedad450bafdaefe9c72e34ee2394e5aed5fa78db750a2a417bc88151534da055f1395d70eea8e46d0e7dc4fd3020fa7b86ad622a761fa39
+  data.tar.gz: 287ba033ae14c028c1c58b9ca7ca838341a61181ef078f4c1914f4908abc17b0b519e030a2cb10ce83c934176b0047fb5e2103485da615eb2f4e38636457f2bf

data/README.md

@@ -38,8 +38,7 @@ socket.read_match { |match| p match; puts '' }
 # A simple IRC client.
 
 socket = Ionian::Socket.new \
-  host: 'chat.freenode.net',
-  port: 6667,
+  host: 'chat.freenode.net:6667',
   # Break up the matches into named captures so it's easier
   # to sort through the server's responses.
   expression: /:(?<server>.*?)\s*:(?<msg>.*?)[\r\n]+/
@@ -61,3 +60,18 @@ loop do
   end
 end
 ```
+
+### Simple Server
+
+``` ruby
+host = 'localhost:5000'
+
+server = Ionian::Server.new interface: host do |client|
+  # Greet the connected client.
+  client.write "Welcome! You are connected to the server.\n"
+end
+
+socket = Ionian::Socket.new host: host
+# Retrieve the greeting message.
+puts socket.read_all
+```

data/doc/Ionian/Extension/IO.html

@@ -751,14 +751,14 @@ automatically.</p>
       <pre class="lines">
 
 
-154
-155
-156
 157
-158</pre>
+158
+159
+160
+161</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ionian/extension/io.rb', line 154</span>
+      <pre class="code"><span class="info file"># File 'lib/ionian/extension/io.rb', line 157</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_purge'>purge</span>
   <span class='comment'># Erase IO buffer.
@@ -783,7 +783,7 @@ automatically.</p>
   <div class="discussion">
     
 <p>Read all data in the buffer. An alternative to using #readpartial with a
-large length.</p>
+large length. Blocks until data is available.</p>
 
 
   </div>
@@ -797,18 +797,22 @@ large length.</p>
       <pre class="lines">
 
 
-56
 57
 58
 59
-60</pre>
+60
+61
+62
+63</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ionian/extension/io.rb', line 56</span>
+      <pre class="code"><span class="info file"># File 'lib/ionian/extension/io.rb', line 57</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_read_all'>read_all</span>
-  <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span>
-  <span class='id identifier rubyid_data'>data</span> <span class='op'>+=</span> <span class='id identifier rubyid_readpartial'>readpartial</span> <span class='int'>0xFFFF</span> <span class='kw'>while</span> <span class='id identifier rubyid_has_data?'>has_data?</span>
+  <span class='comment'># Block until data has arrived.
+</span>  <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span>  <span class='id identifier rubyid_readpartial'>readpartial</span> <span class='int'>0xFFFF</span>
+  <span class='comment'># If there is more data in the buffer, retrieve it nonblocking.
+</span>  <span class='id identifier rubyid_data'>data</span> <span class='op'>+=</span> <span class='id identifier rubyid_readpartial'>readpartial</span> <span class='int'>0xFFFF</span> <span class='kw'>while</span> <span class='id identifier rubyid_has_data?'>has_data?</span>
   <span class='id identifier rubyid_data'>data</span>
 <span class='kw'>end</span></pre>
     </td>
@@ -868,9 +872,6 @@ build_methods:  Build accessor methods from named capture groups.
       <pre class="lines">
 
 
-88
-89
-90
 91
 92
 93
@@ -912,10 +913,13 @@ build_methods:  Build accessor methods from named capture groups.
 129
 130
 131
-132</pre>
+132
+133
+134
+135</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ionian/extension/io.rb', line 88</span>
+      <pre class="code"><span class="info file"># File 'lib/ionian/extension/io.rb', line 91</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>
@@ -999,13 +1003,13 @@ reference to the given block. block = ionian_socket.register_observer { … }</p
       <pre class="lines">
 
 
-164
-165
-166
-167</pre>
+167
+168
+169
+170</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ionian/extension/io.rb', line 164</span>
+      <pre class="code"><span class="info file"># File 'lib/ionian/extension/io.rb', line 167</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>
@@ -1044,9 +1048,6 @@ socket|). Passes kwargs to #read_match. This method SHOULD NOT be used if
       <pre class="lines">
 
 
-137
-138
-139
 140
 141
 142
@@ -1057,10 +1058,13 @@ socket|). Passes kwargs to #read_match. This method SHOULD NOT be used if
 147
 148
 149
-150</pre>
+150
+151
+152
+153</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ionian/extension/io.rb', line 137</span>
+      <pre class="code"><span class="info file"># File 'lib/ionian/extension/io.rb', line 140</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>
@@ -1107,13 +1111,13 @@ socket|). Passes kwargs to #read_match. This method SHOULD NOT be used if
       <pre class="lines">
 
 
-172
-173
-174
-175</pre>
+175
+176
+177
+178</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 175</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>
@@ -1129,7 +1133,7 @@ socket|). Passes kwargs to #read_match. This method SHOULD NOT be used if
 </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/Extension/Socket.html

@@ -2519,7 +2519,7 @@ true. ( SO_LINGER )</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/Extension.html

@@ -119,7 +119,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>