RubyGems - steam-condenser - Versions diffs - 1.3.7 → 1.3.8 - Mend

steam-condenser 1.3.7 → 1.3.8

Files changed (883) hide show

data/pkg/steam-condenser-1.3.7/doc/SteamCondenser/Servers/Sockets/MasterServerSocket.html ADDED Viewed

@@ -0,0 +1,306 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Class: SteamCondenser::Servers::Sockets::MasterServerSocket
+    &mdash; Metior — API Documentation
+</title>
+  <link rel="stylesheet" href="../../../css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="../../../css/common.css" type="text/css" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '../../../';
+  framesUrl = "../../../frames.html#!" + escape(window.location.href);
+</script>
+  <script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+    <a href="../../../_index.html">Index (M)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../../../SteamCondenser.html" title="SteamCondenser (module)">SteamCondenser</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Servers.html" title="SteamCondenser::Servers (module)">Servers</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Sockets.html" title="SteamCondenser::Servers::Sockets (module)">Sockets</a></span></span>
+     &raquo;
+    <span class="title">MasterServerSocket</span>
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+      <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="../../../class_list.html">
+      Class List
+    </a>
+    <a class="full_list_link" id="method_list_link"
+        href="../../../method_list.html">
+      Method List
+    </a>
+    <a class="full_list_link" id="file_list_link"
+        href="../../../file_list.html">
+      File List
+    </a>
+</div>
+      <div class="clear"></div>
+    </div>
+    <iframe id="search_frame"></iframe>
+    <div id="content"><h1>Class: SteamCondenser::Servers::Sockets::MasterServerSocket
+</h1>
+<dl class="box">
+    <dt class="r1">Inherits:</dt>
+    <dd class="r1">
+      <span class="inheritName">Object</span>
+        <ul class="fullTree">
+          <li>Object</li>
+            <li class="next">SteamCondenser::Servers::Sockets::MasterServerSocket</li>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      </dd>
+      <dt class="r2">Includes:</dt>
+      <dd class="r2"><span class='object_link'><a href="../../Logging.html" title="SteamCondenser::Logging (module)">Logging</a></span>, <span class='object_link'><a href="BaseSocket.html" title="SteamCondenser::Servers::Sockets::BaseSocket (module)">BaseSocket</a></span></dd>
+    <dt class="r1 last">Defined in:</dt>
+    <dd class="r1 last">lib/steam-condenser/servers/sockets/master_server_socket.rb</dd>
+</dl>
+<div class="clear"></div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <p>This class represents a socket used to communicate with master servers</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Author:</p>
+<ul class="author">
+    <li>
+        <div class='inline'><p>Sebastian Staudt</p>
+</div>
+    </li>
+</ul>
+</div>
+    <h2>
+      Instance Method Summary
+      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+    </h2>
+    <ul class="summary">
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#reply-instance_method" title="#reply (instance method)">- (BasePacket) <strong>reply</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Reads a single packet from the socket.</p>
+</div></span>
+</li>
+    </ul>
+  <h3 class="inherited">Methods included from <span class='object_link'><a href="../../Logging.html" title="SteamCondenser::Logging (module)">Logging</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="../../Logging.html#formatter%3D-class_method" title="SteamCondenser::Logging.formatter= (method)">formatter=</a></span>, <span class='object_link'><a href="../../Logging.html#included-class_method" title="SteamCondenser::Logging.included (method)">included</a></span>, <span class='object_link'><a href="../../Logging.html#level%3D-class_method" title="SteamCondenser::Logging.level= (method)">level=</a></span>, <span class='object_link'><a href="../../Logging.html#log-instance_method" title="SteamCondenser::Logging#log (method)">#log</a></span>, <span class='object_link'><a href="../../Logging.html#logdev%3D-class_method" title="SteamCondenser::Logging.logdev= (method)">logdev=</a></span></p>
+  <h3 class="inherited">Methods included from <span class='object_link'><a href="BaseSocket.html" title="SteamCondenser::Servers::Sockets::BaseSocket (module)">BaseSocket</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="BaseSocket.html#close-instance_method" title="SteamCondenser::Servers::Sockets::BaseSocket#close (method)">#close</a></span>, <span class='object_link'><a href="BaseSocket.html#initialize-instance_method" title="SteamCondenser::Servers::Sockets::BaseSocket#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="BaseSocket.html#receive_packet-instance_method" title="SteamCondenser::Servers::Sockets::BaseSocket#receive_packet (method)">#receive_packet</a></span>, <span class='object_link'><a href="BaseSocket.html#send-instance_method" title="SteamCondenser::Servers::Sockets::BaseSocket#send (method)">#send</a></span>, <span class='object_link'><a href="BaseSocket.html#timeout%3D-class_method" title="SteamCondenser::Servers::Sockets::BaseSocket.timeout= (method)">timeout=</a></span></p>
+  <div id="instance_method_details" class="method_details_list">
+    <h2>Instance Method Details</h2>
+      <div class="method_details first">
+  <h3 class="signature first" id="reply-instance_method">
+    - (<tt>BasePacket</tt>) <strong>reply</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Reads a single packet from the socket</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>BasePacket</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The packet replied from the server</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Raises:</p>
+<ul class="raise">
+    <li>
+        <span class='type'>(<tt><span class='object_link'><a href="../../Error/PacketFormat.html" title="SteamCondenser::Error::PacketFormat (class)">Error::PacketFormat</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'><p>if the packet has the wrong format</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+23
+24
+25
+26
+27
+28
+29
+30
+31
+32
+33
+34
+35</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/servers/sockets/master_server_socket.rb', line 23</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_reply identifier id'>reply</span>
+  <span class='rubyid_receive_packet identifier id'>receive_packet</span> <span class='integer val'>1500</span>
+  <span class='rubyid_unless unless kw'>unless</span> <span class='rubyid_@buffer ivar id'>@buffer</span><span class='dot token'>.</span><span class='rubyid_long identifier id'>long</span> <span class='eq op'>==</span> <span class='integer val'>0x</span><span class='rubyid_FFFFFFFF constant id'>FFFFFFFF</span>
+    <span class='rubyid_raise identifier id'>raise</span> <span class='rubyid_SteamCondenser constant id'>SteamCondenser</span><span class='colon2 op'>::</span><span class='rubyid_Error constant id'>Error</span><span class='colon2 op'>::</span><span class='rubyid_PacketFormat constant id'>PacketFormat</span><span class='comma token'>,</span> <span class='string val'>'Master query response has wrong packet header.'</span>
+  <span class='rubyid_end end kw'>end</span>
+  <span class='rubyid_packet identifier id'>packet</span> <span class='assign token'>=</span> <span class='rubyid_SteamCondenser constant id'>SteamCondenser</span><span class='colon2 op'>::</span><span class='rubyid_Servers constant id'>Servers</span><span class='colon2 op'>::</span><span class='rubyid_Packets constant id'>Packets</span><span class='colon2 op'>::</span><span class='rubyid_SteamPacketFactory constant id'>SteamPacketFactory</span><span class='dot token'>.</span><span class='rubyid_packet_from_data identifier id'>packet_from_data</span> <span class='rubyid_@buffer ivar id'>@buffer</span><span class='dot token'>.</span><span class='rubyid_get identifier id'>get</span>
+  <span class='rubyid_log identifier id'>log</span><span class='dot token'>.</span><span class='rubyid_debug identifier id'>debug</span> <span class='dstring node'>&quot;Got reply of type \&quot;#{packet.class.to_s}\&quot;.&quot;</span>
+  <span class='rubyid_packet identifier id'>packet</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+</div>
+    <div id="footer">
+  Generated on Wed Aug 14 21:48:05 2013 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.7 (ruby-1.8.7).
+</div>
+  </body>
+</html>

data/pkg/steam-condenser-1.3.7/doc/SteamCondenser/Servers/Sockets/RCONSocket.html ADDED Viewed

@@ -0,0 +1,709 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Class: SteamCondenser::Servers::Sockets::RCONSocket
+    &mdash; Metior — API Documentation
+</title>
+  <link rel="stylesheet" href="../../../css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="../../../css/common.css" type="text/css" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '../../../';
+  framesUrl = "../../../frames.html#!" + escape(window.location.href);
+</script>
+  <script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+    <a href="../../../_index.html">Index (R)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../../../SteamCondenser.html" title="SteamCondenser (module)">SteamCondenser</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Servers.html" title="SteamCondenser::Servers (module)">Servers</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Sockets.html" title="SteamCondenser::Servers::Sockets (module)">Sockets</a></span></span>
+     &raquo;
+    <span class="title">RCONSocket</span>
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+      <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="../../../class_list.html">
+      Class List
+    </a>
+    <a class="full_list_link" id="method_list_link"
+        href="../../../method_list.html">
+      Method List
+    </a>
+    <a class="full_list_link" id="file_list_link"
+        href="../../../file_list.html">
+      File List
+    </a>
+</div>
+      <div class="clear"></div>
+    </div>
+    <iframe id="search_frame"></iframe>
+    <div id="content"><h1>Class: SteamCondenser::Servers::Sockets::RCONSocket
+</h1>
+<dl class="box">
+    <dt class="r1">Inherits:</dt>
+    <dd class="r1">
+      <span class="inheritName">Object</span>
+        <ul class="fullTree">
+          <li>Object</li>
+            <li class="next">SteamCondenser::Servers::Sockets::RCONSocket</li>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      </dd>
+      <dt class="r2">Includes:</dt>
+      <dd class="r2"><span class='object_link'><a href="../../Logging.html" title="SteamCondenser::Logging (module)">Logging</a></span>, <span class='object_link'><a href="BaseSocket.html" title="SteamCondenser::Servers::Sockets::BaseSocket (module)">BaseSocket</a></span></dd>
+    <dt class="r1 last">Defined in:</dt>
+    <dd class="r1 last">lib/steam-condenser/servers/sockets/rcon_socket.rb</dd>
+</dl>
+<div class="clear"></div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <p>This class represents a socket used for RCON communication with game
+servers based on the Source engine (e.g. Team Fortress 2, Counter-Strike:
+Source)</p>
+<p>The Source engine uses a stateful TCP connection for RCON communication and
+uses an additional socket of this type to handle RCON requests.</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Author:</p>
+<ul class="author">
+    <li>
+        <div class='inline'><p>Sebastian Staudt</p>
+</div>
+    </li>
+</ul>
+</div>
+    <h2>
+      Instance Method Summary
+      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+    </h2>
+    <ul class="summary">
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#close-instance_method" title="#close (instance method)">- (Object) <strong>close</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Closes the underlying TCP socket if it exists.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#connect-instance_method" title="#connect (instance method)">- (Object) <strong>connect</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Connects a new TCP socket to the server.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#initialize-instance_method" title="#initialize (instance method)">- (RCONSocket) <strong>initialize</strong>(ip, port) </a>
+  </span>
+    <span class="note title constructor">constructor</span>
+    <span class="summary_desc"><div class='inline'><p>Creates a new TCP socket to communicate with the server on the given IP address and port.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#reply-instance_method" title="#reply (instance method)">- (Packets::RCON::BasePacket) <strong>reply</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Reads a packet from the socket.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#send-instance_method" title="#send (instance method)">- (Object) <strong>send</strong>(data_packet) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Sends the given RCON packet to the server.</p>
+</div></span>
+</li>
+    </ul>
+  <h3 class="inherited">Methods included from <span class='object_link'><a href="../../Logging.html" title="SteamCondenser::Logging (module)">Logging</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="../../Logging.html#formatter%3D-class_method" title="SteamCondenser::Logging.formatter= (method)">formatter=</a></span>, <span class='object_link'><a href="../../Logging.html#included-class_method" title="SteamCondenser::Logging.included (method)">included</a></span>, <span class='object_link'><a href="../../Logging.html#level%3D-class_method" title="SteamCondenser::Logging.level= (method)">level=</a></span>, <span class='object_link'><a href="../../Logging.html#log-instance_method" title="SteamCondenser::Logging#log (method)">#log</a></span>, <span class='object_link'><a href="../../Logging.html#logdev%3D-class_method" title="SteamCondenser::Logging.logdev= (method)">logdev=</a></span></p>
+  <h3 class="inherited">Methods included from <span class='object_link'><a href="BaseSocket.html" title="SteamCondenser::Servers::Sockets::BaseSocket (module)">BaseSocket</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="BaseSocket.html#receive_packet-instance_method" title="SteamCondenser::Servers::Sockets::BaseSocket#receive_packet (method)">#receive_packet</a></span>, <span class='object_link'><a href="BaseSocket.html#timeout%3D-class_method" title="SteamCondenser::Servers::Sockets::BaseSocket.timeout= (method)">timeout=</a></span></p>
+<div id="constructor_details" class="method_details_list">
+  <h2>Constructor Details</h2>
+    <div class="method_details first">
+  <h3 class="signature first" id="initialize-instance_method">
+    - (<tt><span class='object_link'><a href="" title="SteamCondenser::Servers::Sockets::RCONSocket (class)">RCONSocket</a></span></tt>) <strong>initialize</strong>(ip, port)
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Creates a new TCP socket to communicate with the server on the given IP
+address and port</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>ip</span>
+        <span class='type'>(<tt>String</tt>, <tt>IPAddr</tt>)</span>
+        &mdash;
+        <div class='inline'><p>Either the IP address or the DNS name of the
+server</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>port</span>
+        <span class='type'>(<tt>Fixnum</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The port the server is listening on</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+37
+38
+39
+40
+41
+42</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/servers/sockets/rcon_socket.rb', line 37</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='rubyid_ip identifier id'>ip</span><span class='comma token'>,</span> <span class='rubyid_port identifier id'>port</span><span class='rparen token'>)</span>
+  <span class='rubyid_ip identifier id'>ip</span> <span class='assign token'>=</span> <span class='rubyid_IPSocket constant id'>IPSocket</span><span class='dot token'>.</span><span class='rubyid_getaddress identifier id'>getaddress</span><span class='lparen token'>(</span><span class='rubyid_ip identifier id'>ip</span><span class='rparen token'>)</span> <span class='rubyid_unless unless_mod kw'>unless</span> <span class='rubyid_ip identifier id'>ip</span><span class='dot token'>.</span><span class='rubyid_is_a? fid id'>is_a?</span> <span class='rubyid_IPAddr constant id'>IPAddr</span>
+  <span class='rubyid_@ip ivar id'>@ip</span>     <span class='assign token'>=</span> <span class='rubyid_ip identifier id'>ip</span>
+  <span class='rubyid_@port ivar id'>@port</span>   <span class='assign token'>=</span> <span class='rubyid_port identifier id'>port</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+</div>
+  <div id="instance_method_details" class="method_details_list">
+    <h2>Instance Method Details</h2>
+      <div class="method_details first">
+  <h3 class="signature first" id="close-instance_method">
+    - (<tt>Object</tt>) <strong>close</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Closes the underlying TCP socket if it exists</p>
+<p>SteamSocket#close</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+47
+48
+49</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/servers/sockets/rcon_socket.rb', line 47</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_close identifier id'>close</span>
+  <span class='rubyid_super super kw'>super</span> <span class='rubyid_unless unless_mod kw'>unless</span> <span class='rubyid_@socket ivar id'>@socket</span><span class='dot token'>.</span><span class='rubyid_nil? fid id'>nil?</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="connect-instance_method">
+    - (<tt>Object</tt>) <strong>connect</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Connects a new TCP socket to the server</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Raises:</p>
+<ul class="raise">
+    <li>
+        <span class='type'>(<tt><span class='object_link'><a href="../../Error/Timeout.html" title="SteamCondenser::Error::Timeout (class)">Error::Timeout</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'><p>if the connection could not be
+established</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+55
+56
+57
+58
+59
+60
+61</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/servers/sockets/rcon_socket.rb', line 55</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_connect identifier id'>connect</span>
+  <span class='rubyid_begin begin kw'>begin</span>
+    <span class='rubyid_timeout identifier id'>timeout</span><span class='lparen token'>(</span><span class='rubyid_@@timeout ivar id'>@@timeout</span> <span class='div op'>/</span> <span class='float val'>1000.0</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> <span class='rubyid_@socket ivar id'>@socket</span> <span class='assign token'>=</span> <span class='rubyid_TCPSocket constant id'>TCPSocket</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span> <span class='rubyid_@ip ivar id'>@ip</span><span class='comma token'>,</span> <span class='rubyid_@port ivar id'>@port</span> <span class='rbrace token'>}</span>
+  <span class='rubyid_rescue rescue kw'>rescue</span> <span class='colon2 op'>::</span><span class='rubyid_Timeout constant id'>Timeout</span><span class='colon2 op'>::</span><span class='rubyid_Error constant id'>Error</span>
+    <span class='rubyid_raise identifier id'>raise</span> <span class='rubyid_SteamCondenser constant id'>SteamCondenser</span><span class='colon2 op'>::</span><span class='rubyid_Error constant id'>Error</span><span class='colon2 op'>::</span><span class='rubyid_Timeout constant id'>Timeout</span>
+  <span class='rubyid_end end kw'>end</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="reply-instance_method">
+    - (<tt><span class='object_link'><a href="../Packets/RCON/BasePacket.html" title="SteamCondenser::Servers::Packets::RCON::BasePacket (module)">Packets::RCON::BasePacket</a></span></tt>) <strong>reply</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Reads a packet from the socket</p>
+<p>The Source RCON protocol allows packets of an arbitrary sice transmitted
+using multiple TCP packets. The data is received in chunks and
+concatenated into a single response packet.</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt><span class='object_link'><a href="../Packets/RCON/BasePacket.html" title="SteamCondenser::Servers::Packets::RCON::BasePacket (module)">Packets::RCON::BasePacket</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'><p>The packet replied from the server</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Raises:</p>
+<ul class="raise">
+    <li>
+        <span class='type'>(<tt><span class='object_link'><a href="../../Error/RCONBan.html" title="SteamCondenser::Error::RCONBan (class)">Error::RCONBan</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'><p>if the IP of the local machine has been banned on
+the game server</p>
+</div>
+    </li>
+    <li>
+        <span class='type'>(<tt><span class='object_link'><a href="../../Error/RCONNoAuth.html" title="SteamCondenser::Error::RCONNoAuth (class)">Error::RCONNoAuth</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'><p>if an authenticated connection has been
+dropped by the server</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+85
+86
+87
+88
+89
+90
+91
+92
+93
+94
+95
+96
+97
+98
+99
+100
+101
+102
+103
+104
+105</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/servers/sockets/rcon_socket.rb', line 85</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_reply identifier id'>reply</span>
+  <span class='rubyid_if if kw'>if</span> <span class='rubyid_receive_packet identifier id'>receive_packet</span><span class='lparen token'>(</span><span class='integer val'>4</span><span class='rparen token'>)</span> <span class='eq op'>==</span> <span class='integer val'>0</span>
+    <span class='rubyid_@socket ivar id'>@socket</span><span class='dot token'>.</span><span class='rubyid_close identifier id'>close</span>
+    <span class='rubyid_raise identifier id'>raise</span> <span class='rubyid_SteamCondenser constant id'>SteamCondenser</span><span class='colon2 op'>::</span><span class='rubyid_Error constant id'>Error</span><span class='colon2 op'>::</span><span class='rubyid_RCONBan constant id'>RCONBan</span>
+  <span class='rubyid_end end kw'>end</span>
+  <span class='rubyid_remaining_bytes identifier id'>remaining_bytes</span> <span class='assign token'>=</span> <span class='rubyid_@buffer ivar id'>@buffer</span><span class='dot token'>.</span><span class='rubyid_long identifier id'>long</span>
+  <span class='rubyid_packet_data identifier id'>packet_data</span> <span class='assign token'>=</span> <span class='string val'>''</span>
+  <span class='rubyid_begin begin kw'>begin</span>
+    <span class='rubyid_received_bytes identifier id'>received_bytes</span> <span class='assign token'>=</span> <span class='rubyid_receive_packet identifier id'>receive_packet</span> <span class='rubyid_remaining_bytes identifier id'>remaining_bytes</span>
+    <span class='rubyid_remaining_bytes identifier id'>remaining_bytes</span> <span class='opasgn op'>-=</span> <span class='rubyid_received_bytes identifier id'>received_bytes</span>
+    <span class='rubyid_packet_data identifier id'>packet_data</span> <span class='lshft op'>&lt;&lt;</span> <span class='rubyid_@buffer ivar id'>@buffer</span><span class='dot token'>.</span><span class='rubyid_get identifier id'>get</span>
+  <span class='rubyid_end end kw'>end</span> <span class='rubyid_while while_mod kw'>while</span> <span class='rubyid_remaining_bytes identifier id'>remaining_bytes</span> <span class='gt op'>&gt;</span> <span class='integer val'>0</span>
+  <span class='rubyid_packet identifier id'>packet</span> <span class='assign token'>=</span> <span class='rubyid_SteamCondenser constant id'>SteamCondenser</span><span class='colon2 op'>::</span><span class='rubyid_Servers constant id'>Servers</span><span class='colon2 op'>::</span><span class='rubyid_Packets constant id'>Packets</span><span class='colon2 op'>::</span><span class='rubyid_RCON constant id'>RCON</span><span class='colon2 op'>::</span><span class='rubyid_RCONPacketFactory constant id'>RCONPacketFactory</span><span class='dot token'>.</span><span class='rubyid_packet_from_data identifier id'>packet_from_data</span><span class='lparen token'>(</span><span class='rubyid_packet_data identifier id'>packet_data</span><span class='rparen token'>)</span>
+  <span class='rubyid_log identifier id'>log</span><span class='dot token'>.</span><span class='rubyid_debug identifier id'>debug</span> <span class='dstring node'>&quot;Received packet of type \&quot;#{packet.class}\&quot;.&quot;</span>
+  <span class='rubyid_packet identifier id'>packet</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="send-instance_method">
+    - (<tt>Object</tt>) <strong>send</strong>(data_packet)
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Sends the given RCON packet to the server</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>data_packet</span>
+        <span class='type'>(<tt><span class='object_link'><a href="../Packets/RCON/BasePacket.html" title="SteamCondenser::Servers::Packets::RCON::BasePacket (module)">Packets::RCON::BasePacket</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'><p>The RCON packet to send to
+the server</p>
+</div>
+    </li>
+</ul>
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+      <li><span class='object_link'><a href="#connect-instance_method" title="SteamCondenser::Servers::Sockets::RCONSocket#connect (method)">#connect</a></span></li>
+  </ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+68
+69
+70
+71
+72</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/servers/sockets/rcon_socket.rb', line 68</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_send identifier id'>send</span><span class='lparen token'>(</span><span class='rubyid_data_packet identifier id'>data_packet</span><span class='rparen token'>)</span>
+  <span class='rubyid_connect identifier id'>connect</span> <span class='rubyid_if if_mod kw'>if</span> <span class='rubyid_@socket ivar id'>@socket</span><span class='dot token'>.</span><span class='rubyid_nil? fid id'>nil?</span> <span class='orop op'>||</span> <span class='rubyid_@socket ivar id'>@socket</span><span class='dot token'>.</span><span class='rubyid_closed? fid id'>closed?</span>
+  <span class='rubyid_super super kw'>super</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+</div>
+    <div id="footer">
+  Generated on Wed Aug 14 21:48:02 2013 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.7 (ruby-1.8.7).
+</div>
+  </body>
+</html>