RubyGems - steam-condenser - Versions diffs - 1.3.9 → 1.3.10 - Mend

steam-condenser 1.3.9 → 1.3.10

Files changed (958) hide show

data/pkg/steam-condenser-1.3.9/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Sockets/SourceSocket.html ADDED

@@ -0,0 +1,367 @@
+<!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::SourceSocket
+    &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 (S)</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">SourceSocket</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::SourceSocket
+</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::SourceSocket</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/source_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 game servers based
+on the Source engine (e.g. Team Fortress 2, Counter-Strike: Source)</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 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 packet from the socket</p>
+<p>The Source query protocol specifies a maximum packet size of 1,400 bytes.
+Bigger packets will be split over several UDP packets. This method
+reassembles split packets into single packet objects. Additionally Source
+may compress big packets using bzip2. Those packets will be compressed.</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>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+29
+30
+31
+32
+33
+34
+35
+36
+37
+38
+39
+40
+41
+42
+43
+44
+45
+46
+47
+48
+49
+50
+51
+52
+53
+54
+55
+56
+57
+58
+59
+60
+61
+62
+63
+64
+65
+66
+67
+68
+69
+70
+71
+72
+73
+74
+75
+76
+77</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/servers/sockets/source_socket.rb', line 29</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'>1400</span>
+  <span class='rubyid_is_compressed identifier id'>is_compressed</span> <span class='assign token'>=</span> <span class='rubyid_false false kw'>false</span>
+  <span class='rubyid_packet_checksum identifier id'>packet_checksum</span> <span class='assign token'>=</span> <span class='integer val'>0</span>
+  <span class='rubyid_if if kw'>if</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_FFFFFFFE constant id'>FFFFFFFE</span>
+    <span class='rubyid_split_packets identifier id'>split_packets</span> <span class='assign token'>=</span> <span class='lbrack token'>[</span><span class='rbrack token'>]</span>
+    <span class='rubyid_begin begin kw'>begin</span>
+      <span class='rubyid_request_id identifier id'>request_id</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_is_compressed identifier id'>is_compressed</span> <span class='assign token'>=</span> <span class='lparen token'>(</span><span class='lparen token'>(</span><span class='rubyid_request_id identifier id'>request_id</span> <span class='bitand op'>&amp;</span> <span class='integer val'>0x80000000</span><span class='rparen token'>)</span> <span class='neq op'>!=</span> <span class='integer val'>0</span><span class='rparen token'>)</span>
+      <span class='rubyid_packet_count identifier id'>packet_count</span> <span class='assign token'>=</span> <span class='rubyid_@buffer ivar id'>@buffer</span><span class='dot token'>.</span><span class='rubyid_getbyte identifier id'>getbyte</span>
+      <span class='rubyid_packet_number identifier id'>packet_number</span> <span class='assign token'>=</span> <span class='rubyid_@buffer ivar id'>@buffer</span><span class='dot token'>.</span><span class='rubyid_getbyte identifier id'>getbyte</span> <span class='plus op'>+</span> <span class='integer val'>1</span>
+      <span class='rubyid_if if kw'>if</span> <span class='rubyid_is_compressed identifier id'>is_compressed</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_checksum identifier id'>packet_checksum</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_else else kw'>else</span>
+        <span class='rubyid_@buffer ivar id'>@buffer</span><span class='dot token'>.</span><span class='rubyid_short identifier id'>short</span>
+      <span class='rubyid_end end kw'>end</span>
+      <span class='rubyid_split_packets identifier id'>split_packets</span><span class='lbrack token'>[</span><span class='rubyid_packet_number identifier id'>packet_number</span> <span class='minus op'>-</span> <span class='integer val'>1</span><span class='rbrack token'>]</span> <span class='assign token'>=</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;Received packet #{packet_number} of #{packet_count} for request ##{request_id}&quot;</span>
+      <span class='rubyid_bytes_read identifier id'>bytes_read</span> <span class='assign token'>=</span> <span class='integer val'>0</span>
+      <span class='rubyid_if if kw'>if</span> <span class='rubyid_split_packets identifier id'>split_packets</span><span class='dot token'>.</span><span class='rubyid_size identifier id'>size</span> <span class='lt op'>&lt;</span> <span class='rubyid_packet_count identifier id'>packet_count</span>
+        <span class='rubyid_begin begin kw'>begin</span>
+          <span class='rubyid_bytes_read identifier id'>bytes_read</span> <span class='assign token'>=</span> <span class='rubyid_receive_packet identifier id'>receive_packet</span>
+        <span class='rubyid_rescue rescue kw'>rescue</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>
+    <span class='rubyid_end end kw'>end</span> <span class='rubyid_while while_mod kw'>while</span> <span class='rubyid_bytes_read identifier id'>bytes_read</span> <span class='gt op'>&gt;</span> <span class='integer val'>0</span> <span class='andop op'>&amp;&amp;</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_FFFFFFFE constant id'>FFFFFFFE</span>
+    <span class='rubyid_packet identifier id'>packet</span> <span class='assign token'>=</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_reassemble_packet identifier id'>reassemble_packet</span><span class='lparen token'>(</span><span class='rubyid_split_packets identifier id'>split_packets</span><span class='comma token'>,</span> <span class='rubyid_is_compressed identifier id'>is_compressed</span><span class='comma token'>,</span> <span class='rubyid_packet_checksum identifier id'>packet_checksum</span><span class='rparen token'>)</span>
+  <span class='rubyid_else else kw'>else</span>
+    <span class='rubyid_packet identifier id'>packet</span> <span class='assign token'>=</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='lparen token'>(</span><span class='rubyid_@buffer ivar id'>@buffer</span><span class='dot token'>.</span><span class='rubyid_get identifier id'>get</span><span class='rparen token'>)</span>
+  <span class='rubyid_end end kw'>end</span>
+  <span class='rubyid_if if kw'>if</span> <span class='rubyid_log identifier id'>log</span><span class='dot token'>.</span><span class='rubyid_debug? fid id'>debug?</span>
+    <span class='rubyid_packet_class identifier id'>packet_class</span> <span class='assign token'>=</span> <span class='rubyid_packet identifier id'>packet</span><span class='dot token'>.</span><span class='rubyid_class identifier id'>class</span><span class='dot token'>.</span><span class='rubyid_name identifier id'>name</span><span class='lbrack token'>[</span><span class='regexp val'>/[^:]*\z/</span><span class='rbrack token'>]</span>
+    <span class='rubyid_if if kw'>if</span> <span class='rubyid_is_compressed identifier id'>is_compressed</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 compressed reply of type \&quot;#{packet_class}\&quot;.&quot;</span>
+    <span class='rubyid_else else kw'>else</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}\&quot;.&quot;</span>
+    <span class='rubyid_end end kw'>end</span>
+  <span class='rubyid_end end kw'>end</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: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>

data/pkg/steam-condenser-1.3.9/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/SourceServer.html ADDED

@@ -0,0 +1,892 @@
+<!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::SourceServer
+    &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 (S)</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">SourceServer</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::SourceServer
+</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::SourceServer</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="GameServer.html" title="SteamCondenser::Servers::GameServer (module)">GameServer</a></span></dd>
+    <dt class="r1 last">Defined in:</dt>
+    <dd class="r1 last">lib/steam-condenser/servers/source_server.rb</dd>
+</dl>
+<div class="clear"></div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <p>This class represents a Source game server and can be used to query
+information about and remotely execute commands via RCON on the server</p>
+<p>A Source game server is an instance of the Source Dedicated Server (SrcDS)
+running games using Valve&#39;s Source engine, like Counter-Strike: Source,
+Team Fortress 2 or Left4Dead.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+      <li><span class='object_link'><a href="GoldSrcServer.html" title="SteamCondenser::Servers::GoldSrcServer (class)">GoldSrcServer</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>Instance Attribute Summary</h2>
+  <h3 class="inherited">Attributes included from <span class='object_link'><a href="BaseServer.html" title="SteamCondenser::Servers::BaseServer (module)">BaseServer</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="BaseServer.html#host_names-instance_method" title="SteamCondenser::Servers::BaseServer#host_names (method)">#host_names</a></span>, <span class='object_link'><a href="BaseServer.html#ip_addresses-instance_method" title="SteamCondenser::Servers::BaseServer#ip_addresses (method)">#ip_addresses</a></span></p>
+    <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="#master-class_method" title="master (class method)">+ (MasterServer) <strong>master</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Returns a master server instance for the default master server for Source games.</p>
+</div></span>
+</li>
+    </ul>
+    <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="#disconnect-instance_method" title="#disconnect (instance method)">- (Object) <strong>disconnect</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Disconnects the TCP-based channel used for RCON commands.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#init_socket-instance_method" title="#init_socket (instance method)">- (Object) <strong>init_socket</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Initializes the sockets to communicate with the Source server.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#initialize-instance_method" title="#initialize (instance method)">- (SourceServer) <strong>initialize</strong>(address, port = 27015) </a>
+  </span>
+    <span class="note title constructor">constructor</span>
+    <span class="summary_desc"><div class='inline'><p>Creates a new instance of a server object representing a Source server, i.e.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#rcon_auth-instance_method" title="#rcon_auth (instance method)">- (Boolean) <strong>rcon_auth</strong>(password) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Authenticates the connection for RCON communication with the server.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#rcon_exec-instance_method" title="#rcon_exec (instance method)">- (String) <strong>rcon_exec</strong>(command) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Remotely executes a command on the server via RCON.</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="GameServer.html" title="SteamCondenser::Servers::GameServer (module)">GameServer</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="GameServer.html#handle_response_for_request-instance_method" title="SteamCondenser::Servers::GameServer#handle_response_for_request (method)">#handle_response_for_request</a></span>, <span class='object_link'><a href="GameServer.html#init-instance_method" title="SteamCondenser::Servers::GameServer#init (method)">#init</a></span>, <span class='object_link'><a href="GameServer.html#ping-instance_method" title="SteamCondenser::Servers::GameServer#ping (method)">#ping</a></span>, <span class='object_link'><a href="GameServer.html#player_status_attributes-class_method" title="SteamCondenser::Servers::GameServer.player_status_attributes (method)">player_status_attributes</a></span>, <span class='object_link'><a href="GameServer.html#players-instance_method" title="SteamCondenser::Servers::GameServer#players (method)">#players</a></span>, <span class='object_link'><a href="GameServer.html#rcon_authenticated%3F-instance_method" title="SteamCondenser::Servers::GameServer#rcon_authenticated? (method)">#rcon_authenticated?</a></span>, <span class='object_link'><a href="GameServer.html#reply-instance_method" title="SteamCondenser::Servers::GameServer#reply (method)">#reply</a></span>, <span class='object_link'><a href="GameServer.html#rules-instance_method" title="SteamCondenser::Servers::GameServer#rules (method)">#rules</a></span>, <span class='object_link'><a href="GameServer.html#send_request-instance_method" title="SteamCondenser::Servers::GameServer#send_request (method)">#send_request</a></span>, <span class='object_link'><a href="GameServer.html#server_info-instance_method" title="SteamCondenser::Servers::GameServer#server_info (method)">#server_info</a></span>, <span class='object_link'><a href="GameServer.html#split_player_status-class_method" title="SteamCondenser::Servers::GameServer.split_player_status (method)">split_player_status</a></span>, <span class='object_link'><a href="GameServer.html#to_s-instance_method" title="SteamCondenser::Servers::GameServer#to_s (method)">#to_s</a></span>, <span class='object_link'><a href="GameServer.html#update_challenge_number-instance_method" title="SteamCondenser::Servers::GameServer#update_challenge_number (method)">#update_challenge_number</a></span>, <span class='object_link'><a href="GameServer.html#update_ping-instance_method" title="SteamCondenser::Servers::GameServer#update_ping (method)">#update_ping</a></span>, <span class='object_link'><a href="GameServer.html#update_players-instance_method" title="SteamCondenser::Servers::GameServer#update_players (method)">#update_players</a></span>, <span class='object_link'><a href="GameServer.html#update_rules-instance_method" title="SteamCondenser::Servers::GameServer#update_rules (method)">#update_rules</a></span>, <span class='object_link'><a href="GameServer.html#update_server_info-instance_method" title="SteamCondenser::Servers::GameServer#update_server_info (method)">#update_server_info</a></span></p>
+  <h3 class="inherited">Methods included from <span class='object_link'><a href="BaseServer.html" title="SteamCondenser::Servers::BaseServer (module)">BaseServer</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="BaseServer.html#failsafe-instance_method" title="SteamCondenser::Servers::BaseServer#failsafe (method)">#failsafe</a></span>, <span class='object_link'><a href="BaseServer.html#rotate_ip-instance_method" title="SteamCondenser::Servers::BaseServer#rotate_ip (method)">#rotate_ip</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::SourceServer (class)">SourceServer</a></span></tt>) <strong>initialize</strong>(address, port = 27015)
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Creates a new instance of a server object representing a Source server,
+i.e. SrcDS instance</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>address</span>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'><p>Either an IP address, a DNS name or one of them
+combined with the port number. If a port number is given, e.g.
+&#39;server.example.com:27016&#39; it will override the second argument.</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>port</span>
+        <span class='type'>(<tt>Fixnum</tt>)</span>
+        <em class="default">(defaults to: <tt>27015</tt>)</em>
+        &mdash;
+        <div class='inline'><p>The port the server is listening on</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.html" title="SteamCondenser::Error (class)">Error</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'><p>if an host name cannot be resolved</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+51
+52
+53</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/servers/source_server.rb', line 51</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_address identifier id'>address</span><span class='comma token'>,</span> <span class='rubyid_port identifier id'>port</span> <span class='assign token'>=</span> <span class='integer val'>27015</span><span class='rparen token'>)</span>
+  <span class='rubyid_super super kw'>super</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+</div>
+  <div id="class_method_details" class="method_details_list">
+    <h2>Class Method Details</h2>
+      <div class="method_details first">
+  <h3 class="signature first" id="master-class_method">
+    + (<tt><span class='object_link'><a href="MasterServer.html" title="SteamCondenser::Servers::MasterServer (class)">MasterServer</a></span></tt>) <strong>master</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns a master server instance for the default master server for Source
+games</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="MasterServer.html" title="SteamCondenser::Servers::MasterServer (class)">MasterServer</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'><p>The Source master server</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+39
+40
+41</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/servers/source_server.rb', line 39</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_master identifier id'>master</span>
+  <span class='rubyid_MasterServer constant id'>MasterServer</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span> <span class='mult op'>*</span><span class='rubyid_MasterServer constant id'>MasterServer</span><span class='colon2 op'>::</span><span class='rubyid_SOURCE_MASTER_SERVER constant id'>SOURCE_MASTER_SERVER</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="disconnect-instance_method">
+    - (<tt>Object</tt>) <strong>disconnect</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Disconnects the TCP-based channel used for RCON commands</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+      <li>RCONSocket#close</li>
+  </ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+58
+59
+60</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/servers/source_server.rb', line 58</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_disconnect identifier id'>disconnect</span>
+  <span class='rubyid_@rcon_socket ivar id'>@rcon_socket</span><span class='dot token'>.</span><span class='rubyid_close identifier id'>close</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="init_socket-instance_method">
+    - (<tt>Object</tt>) <strong>init_socket</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Initializes the sockets to communicate with the Source server</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+      <li>RCONSocket</li>
+      <li>SourceSocket</li>
+  </ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+66
+67
+68
+69</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/servers/source_server.rb', line 66</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_init_socket identifier id'>init_socket</span>
+  <span class='rubyid_@rcon_socket ivar id'>@rcon_socket</span> <span class='assign token'>=</span> <span class='rubyid_Sockets constant id'>Sockets</span><span class='colon2 op'>::</span><span class='rubyid_RCONSocket constant id'>RCONSocket</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span> <span class='rubyid_@ip_address ivar id'>@ip_address</span><span class='comma token'>,</span> <span class='rubyid_@port ivar id'>@port</span>
+  <span class='rubyid_@socket ivar id'>@socket</span>      <span class='assign token'>=</span> <span class='rubyid_Sockets constant id'>Sockets</span><span class='colon2 op'>::</span><span class='rubyid_SourceSocket constant id'>SourceSocket</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span> <span class='rubyid_@ip_address ivar id'>@ip_address</span><span class='comma token'>,</span> <span class='rubyid_@port ivar id'>@port</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="rcon_auth-instance_method">
+    - (<tt>Boolean</tt>) <strong>rcon_auth</strong>(password)
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Authenticates the connection for RCON communication with the server</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>password</span>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The RCON password of the server</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Boolean</tt>)</span>
+        &mdash;
+        <div class='inline'><p>whether authentication was successful</p>
+</div>
+    </li>
+</ul>
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+      <li><span class='object_link'><a href="GameServer.html#rcon_authenticated%3F-instance_method" title="SteamCondenser::Servers::GameServer#rcon_authenticated? (method)">GameServer#rcon_authenticated?</a></span></li>
+      <li><span class='object_link'><a href="#rcon_exec-instance_method" title="SteamCondenser::Servers::SourceServer#rcon_exec (method)">#rcon_exec</a></span></li>
+  </ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+77
+78
+79
+80
+81
+82
+83
+84
+85
+86
+87
+88
+89</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/servers/source_server.rb', line 77</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_rcon_auth identifier id'>rcon_auth</span><span class='lparen token'>(</span><span class='rubyid_password identifier id'>password</span><span class='rparen token'>)</span>
+  <span class='rubyid_@rcon_request_id ivar id'>@rcon_request_id</span> <span class='assign token'>=</span> <span class='rubyid_rand identifier id'>rand</span> <span class='integer val'>2</span><span class='pow op'>**</span><span class='integer val'>16</span>
+  <span class='rubyid_@rcon_socket ivar id'>@rcon_socket</span><span class='dot token'>.</span><span class='rubyid_send identifier id'>send</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_RCONAuthRequest constant id'>RCONAuthRequest</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span> <span class='rubyid_@rcon_request_id ivar id'>@rcon_request_id</span><span class='comma token'>,</span> <span class='rubyid_password identifier id'>password</span>
+  <span class='rubyid_begin begin kw'>begin</span>
+    <span class='rubyid_@rcon_socket ivar id'>@rcon_socket</span><span class='dot token'>.</span><span class='rubyid_reply identifier id'>reply</span>
+    <span class='rubyid_reply identifier id'>reply</span> <span class='assign token'>=</span> <span class='rubyid_@rcon_socket ivar id'>@rcon_socket</span><span class='dot token'>.</span><span class='rubyid_reply identifier id'>reply</span>
+    <span class='rubyid_@rcon_authenticated ivar id'>@rcon_authenticated</span> <span class='assign token'>=</span> <span class='rubyid_reply identifier id'>reply</span><span class='dot token'>.</span><span class='rubyid_request_id identifier id'>request_id</span> <span class='eq op'>==</span> <span class='rubyid_@rcon_request_id ivar id'>@rcon_request_id</span>
+  <span class='rubyid_rescue rescue kw'>rescue</span> <span class='rubyid_Errno constant id'>Errno</span><span class='colon2 op'>::</span><span class='rubyid_ECONNRESET constant id'>ECONNRESET</span>
+    <span class='rubyid_raise identifier id'>raise</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_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="rcon_exec-instance_method">
+    - (<tt>String</tt>) <strong>rcon_exec</strong>(command)
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Remotely executes a command on the server via RCON</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>command</span>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The command to execute on the server via RCON</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The output of the executed command</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Raises:</p>
+<ul class="raise">
+    <li>
+        <span class='type'>(<tt>RCONBanException</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 not authenticated with the server</p>
+</div>
+    </li>
+</ul>
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+      <li><span class='object_link'><a href="#rcon_auth-instance_method" title="SteamCondenser::Servers::SourceServer#rcon_auth (method)">#rcon_auth</a></span></li>
+  </ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+99
+100
+101
+102
+103
+104
+105
+106
+107
+108
+109
+110
+111
+112
+113
+114
+115
+116
+117
+118
+119
+120
+121</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/servers/source_server.rb', line 99</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_rcon_exec identifier id'>rcon_exec</span><span class='lparen token'>(</span><span class='rubyid_command identifier id'>command</span><span class='rparen token'>)</span>
+  <span class='rubyid_raise identifier id'>raise</span> <span class='rubyid_Error constant id'>Error</span><span class='colon2 op'>::</span><span class='rubyid_RCONNoAuth constant id'>RCONNoAuth</span> <span class='rubyid_unless unless_mod kw'>unless</span> <span class='rubyid_@rcon_authenticated ivar id'>@rcon_authenticated</span>
+  <span class='rubyid_@rcon_socket ivar id'>@rcon_socket</span><span class='dot token'>.</span><span class='rubyid_send identifier id'>send</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_RCONExecRequest constant id'>RCONExecRequest</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_@rcon_request_id ivar id'>@rcon_request_id</span><span class='comma token'>,</span> <span class='rubyid_command identifier id'>command</span><span class='rparen token'>)</span>
+  <span class='rubyid_@rcon_socket ivar id'>@rcon_socket</span><span class='dot token'>.</span><span class='rubyid_send identifier id'>send</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_RCONTerminator constant id'>RCONTerminator</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_@rcon_request_id ivar id'>@rcon_request_id</span><span class='rparen token'>)</span>
+  <span class='rubyid_response identifier id'>response</span> <span class='assign token'>=</span> <span class='lbrack token'>[</span><span class='rbrack token'>]</span>
+  <span class='rubyid_begin begin kw'>begin</span>
+    <span class='rubyid_begin begin kw'>begin</span>
+      <span class='rubyid_response_packet identifier id'>response_packet</span> <span class='assign token'>=</span> <span class='rubyid_@rcon_socket ivar id'>@rcon_socket</span><span class='dot token'>.</span><span class='rubyid_reply identifier id'>reply</span>
+      <span class='rubyid_if if kw'>if</span> <span class='rubyid_response_packet identifier id'>response_packet</span><span class='dot token'>.</span><span class='rubyid_is_a? fid id'>is_a?</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_RCONAuthResponse constant id'>RCONAuthResponse</span>
+        <span class='rubyid_@rcon_authenticated ivar id'>@rcon_authenticated</span> <span class='assign token'>=</span> <span class='rubyid_false false kw'>false</span>
+        <span class='rubyid_raise identifier id'>raise</span> <span class='rubyid_Error constant id'>Error</span><span class='colon2 op'>::</span><span class='rubyid_RCONNoAuth constant id'>RCONNoAuth</span>
+      <span class='rubyid_end end kw'>end</span>
+    <span class='rubyid_rescue rescue kw'>rescue</span> <span class='rubyid_Errno constant id'>Errno</span><span class='colon2 op'>::</span><span class='rubyid_ECONNRESET constant id'>ECONNRESET</span>
+      <span class='rubyid_@rcon_authenticated ivar id'>@rcon_authenticated</span> <span class='assign token'>=</span> <span class='rubyid_false false kw'>false</span>
+      <span class='rubyid_raise identifier id'>raise</span> <span class='rubyid_Error constant id'>Error</span><span class='colon2 op'>::</span><span class='rubyid_RCONNoAuth constant id'>RCONNoAuth</span>
+    <span class='rubyid_end end kw'>end</span>
+    <span class='rubyid_response identifier id'>response</span> <span class='lshft op'>&lt;&lt;</span> <span class='rubyid_response_packet identifier id'>response_packet</span><span class='dot token'>.</span><span class='rubyid_response identifier id'>response</span>
+  <span class='rubyid_end end kw'>end</span> <span class='rubyid_while while_mod kw'>while</span> <span class='rubyid_response identifier id'>response</span><span class='dot token'>.</span><span class='rubyid_size identifier id'>size</span> <span class='lt op'>&lt;</span> <span class='integer val'>3</span> <span class='orop op'>||</span> <span class='rubyid_response_packet identifier id'>response_packet</span><span class='dot token'>.</span><span class='rubyid_response identifier id'>response</span><span class='dot token'>.</span><span class='rubyid_size identifier id'>size</span> <span class='gt op'>&gt;</span> <span class='integer val'>0</span>
+  <span class='rubyid_response identifier id'>response</span><span class='dot token'>.</span><span class='rubyid_join identifier id'>join</span><span class='lparen token'>(</span><span class='string val'>''</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='rubyid_strip identifier id'>strip</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:47:51 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>