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

steam-condenser 1.3.6 → 1.3.7

Files changed (500) hide show

data/doc/RCONPacketFactory.html ADDED Viewed

@@ -0,0 +1,300 @@
+<!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>
+  Module: RCONPacketFactory
+    &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">RCONPacketFactory</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>Module: RCONPacketFactory
+</h1>
+<dl class="box">
+    <dt class="r1 last">Defined in:</dt>
+    <dd class="r1 last">lib/steam/packets/rcon/rcon_packet_factory.rb</dd>
+</dl>
+<div class="clear"></div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <p>This module provides functionality to handle raw packet data for Source RCON</p>
+<p>It&#39;s is used to transform data bytes into packet objects for RCON
+communication with Source servers.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+      <li><span class='object_link'><a href="RCONPacket.html" title="RCONPacket (module)">RCONPacket</a></span></li>
+  </ul>
+<p class="tag_title">Author:</p>
+<ul class="author">
+    <li>
+        <div class='inline'><p>Sebastian Staudt</p>
+</div>
+    </li>
+</ul>
+</div>
+    <h2>
+      Class Method Summary
+      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+    </h2>
+    <ul class="summary">
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#packet_from_data-class_method" title="packet_from_data (class method)">+ (RCONPacket) <strong>packet_from_data</strong>(raw_data) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Creates a new packet object based on the header byte of the given raw data.</p>
+</div></span>
+</li>
+    </ul>
+  <div id="class_method_details" class="method_details_list">
+    <h2>Class Method Details</h2>
+      <div class="method_details first">
+  <h3 class="signature first" id="packet_from_data-class_method">
+    + (<tt><span class='object_link'><a href="RCONPacket.html" title="RCONPacket (module)">RCONPacket</a></span></tt>) <strong>packet_from_data</strong>(raw_data)
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Creates a new packet object based on the header byte of the given raw data</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>raw_data</span>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The raw data of the packet</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt><span class='object_link'><a href="RCONPacket.html" title="RCONPacket (module)">RCONPacket</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'><p>The packet object generated from the packet data</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Raises:</p>
+<ul class="raise">
+    <li>
+        <span class='type'>(<tt><span class='object_link'><a href="PacketFormatError.html" title="PacketFormatError (class)">PacketFormatError</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'><p>if the packet header is not recognized</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+26
+27
+28
+29
+30
+31
+32
+33
+34
+35
+36
+37
+38
+39
+40
+41</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/packets/rcon/rcon_packet_factory.rb', line 26</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_self self kw'>self</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_raw_data identifier id'>raw_data</span><span class='rparen token'>)</span>
+  <span class='rubyid_byte_buffer identifier id'>byte_buffer</span> <span class='assign token'>=</span> <span class='rubyid_StringIO constant id'>StringIO</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span> <span class='rubyid_raw_data identifier id'>raw_data</span>
+  <span class='rubyid_request_id identifier id'>request_id</span> <span class='assign token'>=</span> <span class='rubyid_byte_buffer identifier id'>byte_buffer</span><span class='dot token'>.</span><span class='rubyid_long identifier id'>long</span>
+  <span class='rubyid_header identifier id'>header</span> <span class='assign token'>=</span> <span class='rubyid_byte_buffer identifier id'>byte_buffer</span><span class='dot token'>.</span><span class='rubyid_long identifier id'>long</span>
+  <span class='rubyid_data identifier id'>data</span> <span class='assign token'>=</span> <span class='rubyid_byte_buffer identifier id'>byte_buffer</span><span class='dot token'>.</span><span class='rubyid_cstring identifier id'>cstring</span>
+  <span class='rubyid_case case kw'>case</span> <span class='rubyid_header identifier id'>header</span>
+    <span class='rubyid_when when kw'>when</span> <span class='rubyid_RCONPacket constant id'>RCONPacket</span><span class='colon2 op'>::</span><span class='rubyid_SERVERDATA_AUTH_RESPONSE constant id'>SERVERDATA_AUTH_RESPONSE</span> <span class='rubyid_then then kw'>then</span>
+      <span class='rubyid_return return kw'>return</span> <span class='rubyid_RCONAuthResponse constant id'>RCONAuthResponse</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_request_id identifier id'>request_id</span><span class='rparen token'>)</span>
+    <span class='rubyid_when when kw'>when</span> <span class='rubyid_RCONPacket constant id'>RCONPacket</span><span class='colon2 op'>::</span><span class='rubyid_SERVERDATA_RESPONSE_VALUE constant id'>SERVERDATA_RESPONSE_VALUE</span> <span class='rubyid_then then kw'>then</span>
+      <span class='rubyid_return return kw'>return</span> <span class='rubyid_RCONExecResponse constant id'>RCONExecResponse</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_request_id identifier id'>request_id</span><span class='comma token'>,</span> <span class='rubyid_data identifier id'>data</span><span class='rparen token'>)</span>
+    <span class='rubyid_else else kw'>else</span>
+      <span class='rubyid_raise identifier id'>raise</span> <span class='rubyid_PacketFormatError constant id'>PacketFormatError</span><span class='comma token'>,</span> <span class='dstring node'>&quot;Unknown packet with header #{header.to_s(16)} received.&quot;</span>
+  <span class='rubyid_end end kw'>end</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+</div>
+    <div id="footer">
+  Generated on Mon Sep  2 07:12:52 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/doc/RCONSocket.html ADDED Viewed

@@ -0,0 +1,696 @@
+<!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: 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">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: 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">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="SteamSocket.html" title="SteamSocket (module)">SteamSocket</a></span></dd>
+    <dt class="r1 last">Defined in:</dt>
+    <dd class="r1 last">lib/steam/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)">- (RCONPacket) <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="SteamSocket.html" title="SteamSocket (module)">SteamSocket</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="SteamSocket.html#receive_packet-instance_method" title="SteamSocket#receive_packet (method)">#receive_packet</a></span>, <span class='object_link'><a href="SteamSocket.html#timeout%3D-class_method" title="SteamSocket.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="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">
+34
+35
+36
+37
+38
+39</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/sockets/rcon_socket.rb', line 34</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">
+44
+45
+46</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/sockets/rcon_socket.rb', line 44</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="SteamCondenser/TimeoutError.html" title="SteamCondenser::TimeoutError (class)">SteamCondenser::TimeoutError</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">
+52
+53
+54
+55
+56
+57
+58</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/sockets/rcon_socket.rb', line 52</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='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_TimeoutError constant id'>TimeoutError</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="RCONPacket.html" title="RCONPacket (module)">RCONPacket</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="RCONPacket.html" title="RCONPacket (module)">RCONPacket</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="RCONBanError.html" title="RCONBanError (class)">RCONBanError</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>RCONNoAuthException</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">
+81
+82
+83
+84
+85
+86
+87
+88
+89
+90
+91
+92
+93
+94
+95
+96
+97
+98
+99
+100
+101</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/sockets/rcon_socket.rb', line 81</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_RCONBanError constant id'>RCONBanError</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_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_puts identifier id'>puts</span> <span class='dstring node'>&quot;Received packet of type \&quot;#{packet.class}\&quot;.&quot;</span> <span class='rubyid_if if_mod kw'>if</span> <span class='rubyid_$DEBUG gvar id'>$DEBUG</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="RCONPacket.html" title="RCONPacket (module)">RCONPacket</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="RCONSocket#connect (method)">#connect</a></span></li>
+  </ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+64
+65
+66
+67
+68</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/sockets/rcon_socket.rb', line 64</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 Mon Sep  2 07:12:58 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>