steam-condenser 1.3.8 → 1.3.8.1

data/doc/SteamSocket.html

@@ -90,7 +90,9 @@
 
 <h2>Overview</h2><div class="docstring">
   <div class="discussion">
-    <p>This module implements common functionality for sockets used to connect to
+    
+<p>This module implements common functionality for sockets used to connect
+to
 game and master servers</p>
 
 
@@ -107,7 +109,8 @@ game and master servers</p>
       
       
         
-        <div class='inline'><p>Sebastian Staudt</p>
+        <div class='inline'>
+<p>Sebastian Staudt</p>
 </div>
       
     </li>
@@ -122,7 +125,8 @@ game and master servers</p>
         <dt id="timeout-classvariable" class="">@@timeout =
           <div class="docstring">
   <div class="discussion">
-    <p>The default socket timeout</p>
+    
+<p>The default socket timeout</p>
 
 
   </div>
@@ -168,7 +172,8 @@ game and master servers</p>
   
 
   
-    <span class="summary_desc"><div class='inline'><p>Sets the timeout for socket operations.</p>
+    <span class="summary_desc"><div class='inline'>
+<p>Sets the timeout for socket operations.</p>
 </div></span>
   
 </li>
@@ -200,7 +205,8 @@ game and master servers</p>
   
 
   
-    <span class="summary_desc"><div class='inline'><p>Closes the underlying socket.</p>
+    <span class="summary_desc"><div class='inline'>
+<p>Closes the underlying socket.</p>
 </div></span>
   
 </li>
@@ -223,7 +229,9 @@ game and master servers</p>
   
 
   
-    <span class="summary_desc"><div class='inline'><p>Creates a new UDP socket to communicate with the server on the given IP address and port.</p>
+    <span class="summary_desc"><div class='inline'>
+<p>Creates a new UDP socket to communicate with the server on the given IP
+address and port.</p>
 </div></span>
   
 </li>
@@ -246,7 +254,9 @@ game and master servers</p>
   
 
   
-    <span class="summary_desc"><div class='inline'><p>Reads the given amount of data from the socket and wraps it into the buffer.</p>
+    <span class="summary_desc"><div class='inline'>
+<p>Reads the given amount of data from the socket and wraps it into the
+buffer.</p>
 </div></span>
   
 </li>
@@ -269,7 +279,8 @@ game and master servers</p>
   
 
   
-    <span class="summary_desc"><div class='inline'><p>Sends the given packet to the server.</p>
+    <span class="summary_desc"><div class='inline'>
+<p>Sends the given packet to the server.</p>
 </div></span>
   
 </li>
@@ -295,9 +306,11 @@ game and master servers</p>
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>Sets the timeout for socket operations</p>
+    
+<p>Sets the timeout for socket operations</p>
 
-<p>Any request that takes longer than this time will cause a
+<p>Any request that takes longer than this time will cause
+a
 <span class='object_link'><a href="SteamCondenser/TimeoutError.html" title="SteamCondenser::TimeoutError (class)">SteamCondenser::TimeoutError</a></span>.</p>
 
 
@@ -317,7 +330,8 @@ game and master servers</p>
       
       
         &mdash;
-        <div class='inline'><p>The amount of milliseconds before a request times
+        <div class='inline'>
+<p>The amount of milliseconds before a request times
 out</p>
 </div>
       
@@ -364,7 +378,8 @@ out</p>
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>Closes the underlying socket</p>
+    
+<p>Closes the underlying socket</p>
 
 
   </div>
@@ -404,7 +419,9 @@ out</p>
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>Creates a new UDP socket to communicate with the server on the given IP
+    
+<p>Creates a new UDP socket to communicate with the server on the given
+IP
 address and port</p>
 
 
@@ -424,7 +441,8 @@ address and port</p>
       
       
         &mdash;
-        <div class='inline'><p>Either the IP address or the DNS name of the
+        <div class='inline'>
+<p>Either the IP address or the DNS name of the
 server</p>
 </div>
       
@@ -442,7 +460,8 @@ server</p>
       
       
         &mdash;
-        <div class='inline'><p>The port the server is listening on</p>
+        <div class='inline'>
+<p>The port the server is listening on</p>
 </div>
       
     </li>
@@ -484,7 +503,8 @@ server</p>
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>Reads the given amount of data from the socket and wraps it into the buffer</p>
+    
+<p>Reads the given amount of data from the socket and wraps it into the buffer</p>
 
 
   </div>
@@ -505,7 +525,8 @@ server</p>
       
       
         &mdash;
-        <div class='inline'><p>The data length to read from the socket</p>
+        <div class='inline'>
+<p>The data length to read from the socket</p>
 </div>
       
     </li>
@@ -523,7 +544,8 @@ server</p>
       
       
         &mdash;
-        <div class='inline'><p>The number of bytes that have been read from the socket</p>
+        <div class='inline'>
+<p>The number of bytes that have been read from the socket</p>
 </div>
       
     </li>
@@ -540,7 +562,8 @@ server</p>
       
       
         &mdash;
-        <div class='inline'><p>if no packet is received on time</p>
+        <div class='inline'>
+<p>if no packet is received on time</p>
 </div>
       
     </li>
@@ -626,9 +649,11 @@ server</p>
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>Sends the given packet to the server</p>
+    
+<p>Sends the given packet to the server</p>
 
-<p>This converts the packet into a byte stream first before writing it to the
+<p>This converts the packet into a byte stream first before writing it to
+the
 socket.</p>
 
 
@@ -648,7 +673,8 @@ socket.</p>
       
       
         &mdash;
-        <div class='inline'><p>The packet to send to the server</p>
+        <div class='inline'>
+<p>The packet to send to the server</p>
 </div>
       
     </li>
@@ -693,9 +719,9 @@ socket.</p>
 </div>
 
     <div id="footer">
-  Generated on Sun Oct 27 11:01:18 2013 by
+  Generated on Tue Dec 31 18:50:04 2013 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.8.7.1 (ruby-2.0.0).
+  0.8.7.3 (ruby-2.0.0).
 </div>
 
   </body>

data/doc/StringIO.html

@@ -101,8 +101,11 @@
 
 <h2>Overview</h2><div class="docstring">
   <div class="discussion">
-    <p>This extends the <code>StringIO</code> class from Ruby&#39;s standard library. It adds some
-methods to handle byte-wise input from a <code>StringIO</code> object.</p>
+    
+<p>This extends the <code>StringIO</code> class from Ruby&#39;s standard
+library. It adds some
+methods to handle byte-wise input from a
+<code>StringIO</code> object.</p>
 
 
   </div>
@@ -118,7 +121,8 @@ methods to handle byte-wise input from a <code>StringIO</code> object.</p>
       
       
         
-        <div class='inline'><p>Sebastian Staudt</p>
+        <div class='inline'>
+<p>Sebastian Staudt</p>
 </div>
       
     </li>
@@ -157,7 +161,9 @@ methods to handle byte-wise input from a <code>StringIO</code> object.</p>
   
 
   
-    <span class="summary_desc"><div class='inline'><p>Creates a new instance of <code>StringIO</code> with the given size and fills it with zero-bytes.</p>
+    <span class="summary_desc"><div class='inline'>
+<p>Creates a new instance of <code>StringIO</code> with the given size and
+fills it with zero-bytes.</p>
 </div></span>
   
 </li>
@@ -189,7 +195,8 @@ methods to handle byte-wise input from a <code>StringIO</code> object.</p>
   
 
   
-    <span class="summary_desc"><div class='inline'><p>Reads a single byte from the current position of the byte stream.</p>
+    <span class="summary_desc"><div class='inline'>
+<p>Reads a single byte from the current position of the byte stream.</p>
 </div></span>
   
 </li>
@@ -212,7 +219,9 @@ methods to handle byte-wise input from a <code>StringIO</code> object.</p>
   
 
   
-    <span class="summary_desc"><div class='inline'><p>Reads a zero-byte terminated string from the current position of the byte stream.</p>
+    <span class="summary_desc"><div class='inline'>
+<p>Reads a zero-byte terminated string from the current position of the byte
+stream.</p>
 </div></span>
   
 </li>
@@ -235,7 +244,9 @@ methods to handle byte-wise input from a <code>StringIO</code> object.</p>
   
 
   
-    <span class="summary_desc"><div class='inline'><p>Reads a floating-point integer (32 bit) from the current position of the byte stream.</p>
+    <span class="summary_desc"><div class='inline'>
+<p>Reads a floating-point integer (32 bit) from the current position of the
+byte stream.</p>
 </div></span>
   
 </li>
@@ -258,7 +269,9 @@ methods to handle byte-wise input from a <code>StringIO</code> object.</p>
   
 
   
-    <span class="summary_desc"><div class='inline'><p>Reads the whole remaining content of the byte stream from the current position to the end.</p>
+    <span class="summary_desc"><div class='inline'>
+<p>Reads the whole remaining content of the byte stream from the current
+position to the end.</p>
 </div></span>
   
 </li>
@@ -281,7 +294,9 @@ methods to handle byte-wise input from a <code>StringIO</code> object.</p>
   
 
   
-    <span class="summary_desc"><div class='inline'><p>Reads an unsigned long integer (32 bit) from the current position of the byte stream.</p>
+    <span class="summary_desc"><div class='inline'>
+<p>Reads an unsigned long integer (32 bit) from the current position of the
+byte stream.</p>
 </div></span>
   
 </li>
@@ -304,7 +319,9 @@ methods to handle byte-wise input from a <code>StringIO</code> object.</p>
   
 
   
-    <span class="summary_desc"><div class='inline'><p>Returns the remaining number of bytes from the current position to the end of the byte stream.</p>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the remaining number of bytes from the current position to the end
+of the byte stream.</p>
 </div></span>
   
 </li>
@@ -327,7 +344,9 @@ methods to handle byte-wise input from a <code>StringIO</code> object.</p>
   
 
   
-    <span class="summary_desc"><div class='inline'><p>Reads an unsigned short integer (16 bit) from the current position of the byte stream.</p>
+    <span class="summary_desc"><div class='inline'>
+<p>Reads an unsigned short integer (16 bit) from the current position of the
+byte stream.</p>
 </div></span>
   
 </li>
@@ -350,7 +369,9 @@ methods to handle byte-wise input from a <code>StringIO</code> object.</p>
   
 
   
-    <span class="summary_desc"><div class='inline'><p>Reads a signed long integer (32 bit) from the current position of the byte stream.</p>
+    <span class="summary_desc"><div class='inline'>
+<p>Reads a signed long integer (32 bit) from the current position of the byte
+stream.</p>
 </div></span>
   
 </li>
@@ -376,7 +397,9 @@ methods to handle byte-wise input from a <code>StringIO</code> object.</p>
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>Creates a new instance of <code>StringIO</code> with the given size and fills it with
+    
+<p>Creates a new instance of <code>StringIO</code> with the given size and
+fills it with
 zero-bytes.</p>
 
 
@@ -396,7 +419,8 @@ zero-bytes.</p>
       
       
         &mdash;
-        <div class='inline'><p>The size the new instance should have</p>
+        <div class='inline'>
+<p>The size the new instance should have</p>
 </div>
       
     </li>
@@ -414,8 +438,10 @@ zero-bytes.</p>
       
       
         &mdash;
-        <div class='inline'><p>A new <code>StringIO</code> instance with the given size, filled
-with zero-bytes</p>
+        <div class='inline'>
+<p>A new <code>StringIO</code> instance with the given size, filled
+with
+zero-bytes</p>
 </div>
       
     </li>
@@ -460,7 +486,8 @@ with zero-bytes</p>
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>Reads a single byte from the current position of the byte stream</p>
+    
+<p>Reads a single byte from the current position of the byte stream</p>
 
 
   </div>
@@ -478,7 +505,8 @@ with zero-bytes</p>
       
       
         &mdash;
-        <div class='inline'><p>The numeric value of the byte at the current position</p>
+        <div class='inline'>
+<p>The numeric value of the byte at the current position</p>
 </div>
       
     </li>
@@ -517,11 +545,15 @@ with zero-bytes</p>
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>Reads a zero-byte terminated string from the current position of the byte
+    
+<p>Reads a zero-byte terminated string from the current position of the
+byte
 stream</p>
 
-<p>This reads the stream up until the first occurrence of a zero-byte or the
-end of the stream. The zero-byte is not included in the returned string.</p>
+<p>This reads the stream up until the first occurrence of a zero-byte or
+the
+end of the stream. The zero-byte is not included in the returned
+string.</p>
 
 
   </div>
@@ -539,7 +571,8 @@ end of the stream. The zero-byte is not included in the returned string.</p>
       
       
         &mdash;
-        <div class='inline'><p>The zero-byte terminated string read from the byte stream</p>
+        <div class='inline'>
+<p>The zero-byte terminated string read from the byte stream</p>
 </div>
       
     </li>
@@ -582,7 +615,9 @@ end of the stream. The zero-byte is not included in the returned string.</p>
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>Reads a floating-point integer (32 bit) from the current position of the
+    
+<p>Reads a floating-point integer (32 bit) from the current position of
+the
 byte stream</p>
 
 
@@ -601,7 +636,8 @@ byte stream</p>
       
       
         &mdash;
-        <div class='inline'><p>The floating-point integer read from the byte stream</p>
+        <div class='inline'>
+<p>The floating-point integer read from the byte stream</p>
 </div>
       
     </li>
@@ -640,7 +676,9 @@ byte stream</p>
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>Reads the whole remaining content of the byte stream from the current
+    
+<p>Reads the whole remaining content of the byte stream from the
+current
 position to the end</p>
 
 
@@ -659,8 +697,10 @@ position to the end</p>
       
       
         &mdash;
-        <div class='inline'><p>The remainder of the byte stream starting from the current
-position of the byte stream</p>
+        <div class='inline'>
+<p>The remainder of the byte stream starting from the current
+position of the
+byte stream</p>
 </div>
       
     </li>
@@ -699,7 +739,9 @@ position of the byte stream</p>
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>Reads an unsigned long integer (32 bit) from the current position of the
+    
+<p>Reads an unsigned long integer (32 bit) from the current position of
+the
 byte stream</p>
 
 
@@ -718,7 +760,8 @@ byte stream</p>
       
       
         &mdash;
-        <div class='inline'><p>The unsigned long integer read from the byte stream</p>
+        <div class='inline'>
+<p>The unsigned long integer read from the byte stream</p>
 </div>
       
     </li>
@@ -757,7 +800,9 @@ byte stream</p>
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>Returns the remaining number of bytes from the current position to the end
+    
+<p>Returns the remaining number of bytes from the current position to the
+end
 of the byte stream</p>
 
 
@@ -776,7 +821,8 @@ of the byte stream</p>
       
       
         &mdash;
-        <div class='inline'><p>The number of bytes until the end of the stream</p>
+        <div class='inline'>
+<p>The number of bytes until the end of the stream</p>
 </div>
       
     </li>
@@ -815,7 +861,9 @@ of the byte stream</p>
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>Reads an unsigned short integer (16 bit) from the current position of the
+    
+<p>Reads an unsigned short integer (16 bit) from the current position of
+the
 byte stream</p>
 
 
@@ -834,7 +882,8 @@ byte stream</p>
       
       
         &mdash;
-        <div class='inline'><p>The unsigned short integer read from the byte stream</p>
+        <div class='inline'>
+<p>The unsigned short integer read from the byte stream</p>
 </div>
       
     </li>
@@ -873,7 +922,9 @@ byte stream</p>
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>Reads a signed long integer (32 bit) from the current position of the byte
+    
+<p>Reads a signed long integer (32 bit) from the current position of the
+byte
 stream</p>
 
 
@@ -892,7 +943,8 @@ stream</p>
       
       
         &mdash;
-        <div class='inline'><p>The signed long integer read from the byte stream</p>
+        <div class='inline'>
+<p>The signed long integer read from the byte stream</p>
 </div>
       
     </li>
@@ -925,9 +977,9 @@ stream</p>
 </div>
 
     <div id="footer">
-  Generated on Sun Oct 27 11:01:18 2013 by
+  Generated on Tue Dec 31 18:50:05 2013 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.8.7.1 (ruby-2.0.0).
+  0.8.7.3 (ruby-2.0.0).
 </div>
 
   </body>