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

steam-condenser 1.3.9 → 1.3.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (958) hide show

data/pkg/steam-condenser-1.3.9/doc/GameServer.html ADDED

@@ -0,0 +1,2495 @@
+<!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: GameServer
+    &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 (G)</a> &raquo;
+    <span class="title">GameServer</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: GameServer
+</h1>
+<dl class="box">
+      <dt class="r1">Includes:</dt>
+      <dd class="r1"><span class='object_link'><a href="Server.html" title="Server (module)">Server</a></span></dd>
+    <dt class="r2">Included in:</dt>
+    <dd class="r2"><span class='object_link'><a href="GoldSrcServer.html" title="GoldSrcServer (class)">GoldSrcServer</a></span>, <span class='object_link'><a href="SourceServer.html" title="SourceServer (class)">SourceServer</a></span></dd>
+    <dt class="r1 last">Defined in:</dt>
+    <dd class="r1 last">lib/steam/servers/game_server.rb</dd>
+</dl>
+<div class="clear"></div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+<p>This module is included by classes representing different game
+server
+implementations and provides the basic functionality to communicate
+with
+them using the common query protocol</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 Attribute Summary</h2>
+  <h3 class="inherited">Attributes included from <span class='object_link'><a href="Server.html" title="Server (module)">Server</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="Server.html#host_names-instance_method" title="Server#host_names (method)">#host_names</a></span>, <span class='object_link'><a href="Server.html#ip_addresses-instance_method" title="Server#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="#player_status_attributes-class_method" title="player_status_attributes (class method)">+ (Array&lt;Symbol&gt;) <strong>player_status_attributes</strong>(status_header) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Parses the player attribute names supplied by <code>rcon status</code>.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#split_player_status-class_method" title="split_player_status (class method)">+ (Hash&lt;Symbol, String&gt;) <strong>split_player_status</strong>(attributes, player_status) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Splits the player status obtained with <code>rcon status</code>.</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="#handle_response_for_request-instance_method" title="#handle_response_for_request (instance method)">- (Object) <strong>handle_response_for_request</strong>(request_type, repeat_on_failure = true) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Sends the specified request to the server and handles the returned
+response.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#init-instance_method" title="#init (instance method)">- (Object) <strong>init</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Initializes this server object with basic information.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#initialize-instance_method" title="#initialize (instance method)">- (Object) <strong>initialize</strong>(address, port = 27015) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Creates a new instance of a game server object.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#ping-instance_method" title="#ping (instance method)">- (Fixnum) <strong>ping</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the last measured response time of this server.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#players-instance_method" title="#players (instance method)">- (Hash) <strong>players</strong>(rcon_password = nil) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns a list of players currently playing on this server.</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="abstract note title">abstract</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_authenticated%3F-instance_method" title="#rcon_authenticated? (instance method)">- (Boolean) <strong>rcon_authenticated?</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns whether the RCON connection to this server is already
+authenticated.</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="abstract note title">abstract</span>
+    <span class="summary_desc"><div class='inline'>
+<p>Remotely executes a command on the server via RCON.</p>
+</div></span>
+</li>
+        <li class="protected ">
+  <span class="summary_signature">
+      <a href="#reply-instance_method" title="#reply (instance method)">- (SteamPacket) <strong>reply</strong> </a>
+  </span>
+  <span class="note title protected">protected</span>
+    <span class="summary_desc"><div class='inline'>
+<p>Receives a response from the server.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#rules-instance_method" title="#rules (instance method)">- (Hash&lt;String, String&gt;) <strong>rules</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the settings applied on the server.</p>
+</div></span>
+</li>
+        <li class="protected ">
+  <span class="summary_signature">
+      <a href="#send_request-instance_method" title="#send_request (instance method)">- (Object) <strong>send_request</strong>(packet) </a>
+  </span>
+  <span class="note title protected">protected</span>
+    <span class="summary_desc"><div class='inline'>
+<p>Sends a request packet to the server.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#server_info-instance_method" title="#server_info (instance method)">- (Hash) <strong>server_info</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns a hash with basic information on the server.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#to_s-instance_method" title="#to_s (instance method)">- (String) <strong>to_s</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns a human-readable text representation of the server.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#update_challenge_number-instance_method" title="#update_challenge_number (instance method)">- (Object) <strong>update_challenge_number</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Sends a A2S_SERVERQUERY_GETCHALLENGE request to the server and updates the
+challenge number used to communicate with this server.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#update_ping-instance_method" title="#update_ping (instance method)">- (Fixnum) <strong>update_ping</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Sends a A2S_INFO request to the server and measures the time needed for the
+reply.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#update_players-instance_method" title="#update_players (instance method)">- (Object) <strong>update_players</strong>(rcon_password = nil) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Sends a A2S_PLAYERS request to the server and updates the players&#39; data
+for this server.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#update_rules-instance_method" title="#update_rules (instance method)">- (Object) <strong>update_rules</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Sends a A2S_RULES request to the server and updates the rules of this
+server.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#update_server_info-instance_method" title="#update_server_info (instance method)">- (Object) <strong>update_server_info</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Sends a A2S_INFO request to the server and updates this server&#39;s basic
+information.</p>
+</div></span>
+</li>
+    </ul>
+  <h3 class="inherited">Methods included from <span class='object_link'><a href="Server.html" title="Server (module)">Server</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="Server.html#disconnect-instance_method" title="Server#disconnect (method)">#disconnect</a></span>, <span class='object_link'><a href="Server.html#failsafe-instance_method" title="Server#failsafe (method)">#failsafe</a></span>, <span class='object_link'><a href="Server.html#init_socket-instance_method" title="Server#init_socket (method)">#init_socket</a></span>, <span class='object_link'><a href="Server.html#rotate_ip-instance_method" title="Server#rotate_ip (method)">#rotate_ip</a></span></p>
+  <div id="class_method_details" class="method_details_list">
+    <h2>Class Method Details</h2>
+      <div class="method_details first">
+  <h3 class="signature first" id="player_status_attributes-class_method">
+    + (<tt>Array&lt;Symbol&gt;</tt>) <strong>player_status_attributes</strong>(status_header)
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Parses the player attribute names supplied by <code>rcon status</code></p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>status_header</span>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>The header line provided by <code>rcon status</code></p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Array&lt;Symbol&gt;</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>Split player attribute names</p>
+</div>
+    </li>
+</ul>
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+      <li><span class='object_link'><a href="#split_player_status-class_method" title="GameServer.split_player_status (method)">split_player_status</a></span></li>
+  </ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+33
+34
+35
+36
+37
+38
+39
+40
+41
+42
+43
+44</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/servers/game_server.rb', line 33</span>
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_player_status_attributes'>player_status_attributes</span><span class='lparen'>(</span><span class='id identifier rubyid_status_header'>status_header</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_status_header'>status_header</span><span class='period'>.</span><span class='id identifier rubyid_split'>split</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_attribute'>attribute</span><span class='op'>|</span>
+    <span class='kw'>case</span> <span class='id identifier rubyid_attribute'>attribute</span>
+      <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>connected</span><span class='tstring_end'>&#39;</span></span>
+        <span class='symbol'>:time</span>
+      <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>frag</span><span class='tstring_end'>&#39;</span></span>
+        <span class='symbol'>:score</span>
+      <span class='kw'>else</span>
+        <span class='id identifier rubyid_attribute'>attribute</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span>
+    <span class='kw'>end</span>
+  <span class='kw'>end</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="split_player_status-class_method">
+    + (<tt>Hash&lt;Symbol, String&gt;</tt>) <strong>split_player_status</strong>(attributes, player_status)
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Splits the player status obtained with <code>rcon status</code></p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>attributes</span>
+        <span class='type'>(<tt>Array&lt;Symbol&gt;</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>The attribute names</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>player_status</span>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>The status line of a single player</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Hash&lt;Symbol, String&gt;</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>The attributes with the corresponding values
+for this player</p>
+</div>
+    </li>
+</ul>
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+      <li><span class='object_link'><a href="#player_status_attributes-class_method" title="GameServer.player_status_attributes (method)">player_status_attributes</a></span></li>
+  </ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+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
+78</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/servers/game_server.rb', line 53</span>
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_split_player_status'>split_player_status</span><span class='lparen'>(</span><span class='id identifier rubyid_attributes'>attributes</span><span class='comma'>,</span> <span class='id identifier rubyid_player_status'>player_status</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_player_status'>player_status</span><span class='period'>.</span><span class='id identifier rubyid_sub!'>sub!</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>^\d+ +</span><span class='regexp_end'>/</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_attributes'>attributes</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span> <span class='op'>!=</span> <span class='symbol'>:userid</span>
+  <span class='id identifier rubyid_first_quote'>first_quote</span> <span class='op'>=</span> <span class='id identifier rubyid_player_status'>player_status</span><span class='period'>.</span><span class='id identifier rubyid_index'>index</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>&quot;</span><span class='tstring_end'>&#39;</span></span>
+  <span class='id identifier rubyid_last_quote'>last_quote</span>  <span class='op'>=</span> <span class='id identifier rubyid_player_status'>player_status</span><span class='period'>.</span><span class='id identifier rubyid_rindex'>rindex</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>&quot;</span><span class='tstring_end'>&#39;</span></span>
+  <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbracket'>[</span>
+    <span class='id identifier rubyid_player_status'>player_status</span><span class='lbracket'>[</span><span class='int'>0</span><span class='comma'>,</span> <span class='id identifier rubyid_first_quote'>first_quote</span><span class='rbracket'>]</span><span class='comma'>,</span>
+    <span class='id identifier rubyid_player_status'>player_status</span><span class='lbracket'>[</span><span class='id identifier rubyid_first_quote'>first_quote</span> <span class='op'>+</span> <span class='int'>1</span><span class='op'>..</span><span class='id identifier rubyid_last_quote'>last_quote</span> <span class='op'>-</span> <span class='int'>1</span><span class='rbracket'>]</span><span class='comma'>,</span>
+    <span class='id identifier rubyid_player_status'>player_status</span><span class='lbracket'>[</span><span class='id identifier rubyid_last_quote'>last_quote</span> <span class='op'>+</span> <span class='int'>1</span><span class='op'>..</span><span class='op'>-</span><span class='int'>1</span><span class='rbracket'>]</span>
+  <span class='rbracket'>]</span>
+  <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbracket'>[</span> <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_split'>split</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='int'>2</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_split'>split</span> <span class='rbracket'>]</span>
+  <span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_flatten!'>flatten!</span>
+  <span class='kw'>if</span> <span class='id identifier rubyid_attributes'>attributes</span><span class='period'>.</span><span class='id identifier rubyid_size'>size</span> <span class='op'>&gt;</span> <span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_size'>size</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_attributes'>attributes</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='symbol'>:state</span><span class='rparen'>)</span>
+    <span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_insert'>insert</span> <span class='int'>3</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='kw'>nil</span>
+  <span class='kw'>elsif</span> <span class='id identifier rubyid_attributes'>attributes</span><span class='period'>.</span><span class='id identifier rubyid_size'>size</span> <span class='op'>&lt;</span> <span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_size'>size</span>
+    <span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_delete_at'>delete_at</span> <span class='int'>1</span>
+  <span class='kw'>end</span>
+  <span class='id identifier rubyid_player_data'>player_data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
+  <span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_each_index'>each_index</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_i'>i</span><span class='op'>|</span>
+    <span class='id identifier rubyid_player_data'>player_data</span><span class='lbracket'>[</span><span class='id identifier rubyid_attributes'>attributes</span><span class='lbracket'>[</span><span class='id identifier rubyid_i'>i</span><span class='rbracket'>]</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='id identifier rubyid_i'>i</span><span class='rbracket'>]</span>
+  <span class='kw'>end</span>
+  <span class='id identifier rubyid_player_data'>player_data</span>
+<span class='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="handle_response_for_request-instance_method">
+    - (<tt>Object</tt>) <strong>handle_response_for_request</strong>(request_type, repeat_on_failure = true)
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Sends the specified request to the server and handles the returned response</p>
+<p>Depending on the given request type this will fill the various
+data
+attributes of the server object.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>request_type</span>
+        <span class='type'>(<tt>Symbol</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>The type of request to send to the server</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>repeat_on_failure</span>
+        <span class='type'>(<tt>Boolean</tt>)</span>
+        <em class="default">(defaults to: <tt>true</tt>)</em>
+        &mdash;
+        <div class='inline'>
+<p>Whether the request should be repeated,
+if the replied packet isn&#39;t
+expected. This is useful to handle
+missing challenge numbers, which will be
+automatically filled in,
+although not requested explicitly.</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Raises:</p>
+<ul class="raise">
+    <li>
+        <span class='type'>(<tt><span class='object_link'><a href="SteamCondenserError.html" title="SteamCondenserError (class)">SteamCondenserError</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>if either the request type or the response
+packet is not known</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+203
+204
+205
+206
+207
+208
+209
+210
+211
+212
+213
+214
+215
+216
+217
+218
+219
+220
+221
+222
+223
+224
+225
+226
+227
+228
+229
+230
+231
+232
+233
+234
+235
+236
+237
+238
+239
+240</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/servers/game_server.rb', line 203</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_handle_response_for_request'>handle_response_for_request</span><span class='lparen'>(</span><span class='id identifier rubyid_request_type'>request_type</span><span class='comma'>,</span> <span class='id identifier rubyid_repeat_on_failure'>repeat_on_failure</span> <span class='op'>=</span> <span class='kw'>true</span><span class='rparen'>)</span>
+  <span class='kw'>case</span> <span class='id identifier rubyid_request_type'>request_type</span>
+    <span class='kw'>when</span> <span class='symbol'>:challenge</span> <span class='kw'>then</span>
+      <span class='id identifier rubyid_request_packet'>request_packet</span> <span class='op'>=</span> <span class='const'>A2S_PLAYER_Packet</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
+      <span class='id identifier rubyid_expected_response'>expected_response</span> <span class='op'>=</span> <span class='const'>S2C_CHALLENGE_Packet</span>
+    <span class='kw'>when</span> <span class='symbol'>:info</span> <span class='kw'>then</span>
+      <span class='id identifier rubyid_request_packet'>request_packet</span> <span class='op'>=</span> <span class='const'>A2S_INFO_Packet</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
+      <span class='id identifier rubyid_expected_response'>expected_response</span> <span class='op'>=</span> <span class='const'>S2A_INFO_BasePacket</span>
+    <span class='kw'>when</span> <span class='symbol'>:players</span> <span class='kw'>then</span>
+      <span class='id identifier rubyid_request_packet'>request_packet</span> <span class='op'>=</span> <span class='const'>A2S_PLAYER_Packet</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='ivar'>@challenge_number</span><span class='rparen'>)</span>
+      <span class='id identifier rubyid_expected_response'>expected_response</span> <span class='op'>=</span> <span class='const'>S2A_PLAYER_Packet</span>
+    <span class='kw'>when</span> <span class='symbol'>:rules</span> <span class='kw'>then</span>
+      <span class='id identifier rubyid_request_packet'>request_packet</span> <span class='op'>=</span> <span class='const'>A2S_RULES_Packet</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='ivar'>@challenge_number</span><span class='rparen'>)</span>
+      <span class='id identifier rubyid_expected_response'>expected_response</span> <span class='op'>=</span> <span class='const'>S2A_RULES_Packet</span>
+    <span class='kw'>else</span>
+      <span class='id identifier rubyid_raise'>raise</span> <span class='const'>SteamCondenserError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Called with wrong request type.</span><span class='tstring_end'>&#39;</span></span>
+  <span class='kw'>end</span>
+  <span class='id identifier rubyid_send_request'>send_request</span> <span class='id identifier rubyid_request_packet'>request_packet</span>
+  <span class='id identifier rubyid_response_packet'>response_packet</span> <span class='op'>=</span> <span class='id identifier rubyid_reply'>reply</span>
+  <span class='kw'>if</span> <span class='id identifier rubyid_response_packet'>response_packet</span><span class='period'>.</span><span class='id identifier rubyid_kind_of?'>kind_of?</span> <span class='const'>S2A_INFO_BasePacket</span>
+    <span class='ivar'>@info_hash</span> <span class='op'>=</span> <span class='id identifier rubyid_response_packet'>response_packet</span><span class='period'>.</span><span class='id identifier rubyid_info'>info</span>
+  <span class='kw'>elsif</span> <span class='id identifier rubyid_response_packet'>response_packet</span><span class='period'>.</span><span class='id identifier rubyid_kind_of?'>kind_of?</span> <span class='const'>S2A_PLAYER_Packet</span>
+    <span class='ivar'>@player_hash</span> <span class='op'>=</span> <span class='id identifier rubyid_response_packet'>response_packet</span><span class='period'>.</span><span class='id identifier rubyid_player_hash'>player_hash</span>
+  <span class='kw'>elsif</span> <span class='id identifier rubyid_response_packet'>response_packet</span><span class='period'>.</span><span class='id identifier rubyid_kind_of?'>kind_of?</span> <span class='const'>S2A_RULES_Packet</span>
+    <span class='ivar'>@rules_hash</span> <span class='op'>=</span> <span class='id identifier rubyid_response_packet'>response_packet</span><span class='period'>.</span><span class='id identifier rubyid_rules_hash'>rules_hash</span>
+  <span class='kw'>elsif</span> <span class='id identifier rubyid_response_packet'>response_packet</span><span class='period'>.</span><span class='id identifier rubyid_kind_of?'>kind_of?</span> <span class='const'>S2C_CHALLENGE_Packet</span>
+    <span class='ivar'>@challenge_number</span> <span class='op'>=</span> <span class='id identifier rubyid_response_packet'>response_packet</span><span class='period'>.</span><span class='id identifier rubyid_challenge_number'>challenge_number</span>
+  <span class='kw'>else</span>
+    <span class='id identifier rubyid_raise'>raise</span> <span class='const'>SteamCondenserError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Response of type </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_response_packet'>response_packet</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='embexpr_end'>}</span><span class='tstring_content'> cannot be handled by this method.</span><span class='tstring_end'>&quot;</span></span>
+  <span class='kw'>end</span>
+  <span class='kw'>unless</span> <span class='id identifier rubyid_response_packet'>response_packet</span><span class='period'>.</span><span class='id identifier rubyid_kind_of?'>kind_of?</span> <span class='id identifier rubyid_expected_response'>expected_response</span>
+    <span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Expected </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_expected_response'>expected_response</span><span class='embexpr_end'>}</span><span class='tstring_content'>, got </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_response_packet'>response_packet</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='embexpr_end'>}</span><span class='tstring_content'>.</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span> <span class='gvar'>$DEBUG</span>
+    <span class='id identifier rubyid_handle_response_for_request'>handle_response_for_request</span><span class='lparen'>(</span><span class='id identifier rubyid_request_type'>request_type</span><span class='comma'>,</span> <span class='kw'>false</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_repeat_on_failure'>repeat_on_failure</span>
+  <span class='kw'>end</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="init-instance_method">
+    - (<tt>Object</tt>) <strong>init</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Initializes this server object with basic information</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+      <li><span class='object_link'><a href="#update_challenge_number-instance_method" title="GameServer#update_challenge_number (method)">#update_challenge_number</a></span></li>
+      <li><span class='object_link'><a href="#update_ping-instance_method" title="GameServer#update_ping (method)">#update_ping</a></span></li>
+      <li><span class='object_link'><a href="#update_server_info-instance_method" title="GameServer#update_server_info (method)">#update_server_info</a></span></li>
+  </ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+247
+248
+249
+250
+251</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/servers/game_server.rb', line 247</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_init'>init</span>
+  <span class='id identifier rubyid_update_ping'>update_ping</span>
+  <span class='id identifier rubyid_update_server_info'>update_server_info</span>
+  <span class='id identifier rubyid_update_challenge_number'>update_challenge_number</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="initialize-instance_method">
+    - (<tt>Object</tt>) <strong>initialize</strong>(address, port = 27015)
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Creates a new instance of a game server object</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="SteamCondenserError.html" title="SteamCondenserError (class)">SteamCondenserError</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">
+87
+88
+89
+90
+91</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/servers/game_server.rb', line 87</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_address'>address</span><span class='comma'>,</span> <span class='id identifier rubyid_port'>port</span> <span class='op'>=</span> <span class='int'>27015</span><span class='rparen'>)</span>
+  <span class='kw'>super</span>
+  <span class='ivar'>@rcon_authenticated</span> <span class='op'>=</span> <span class='kw'>false</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="ping-instance_method">
+    - (<tt>Fixnum</tt>) <strong>ping</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns the last measured response time of this server</p>
+<p>If the latency hasn&#39;t been measured yet, it is done when calling
+this
+method for the first time.</p>
+<p>If this information is vital to you, be sure to call
+<span class='object_link'><a href="#update_ping-instance_method" title="GameServer#update_ping (method)">#update_ping</a></span>
+regularly to stay up-to-date.</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Fixnum</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>The latency of this server in milliseconds</p>
+</div>
+    </li>
+</ul>
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+      <li><span class='object_link'><a href="#update_ping-instance_method" title="GameServer#update_ping (method)">#update_ping</a></span></li>
+  </ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+103
+104
+105
+106</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/servers/game_server.rb', line 103</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_ping'>ping</span>
+  <span class='id identifier rubyid_update_ping'>update_ping</span> <span class='kw'>if</span> <span class='ivar'>@ping</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
+  <span class='ivar'>@ping</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="players-instance_method">
+    - (<tt>Hash</tt>) <strong>players</strong>(rcon_password = nil)
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns a list of players currently playing on this server</p>
+<p>If the players haven&#39;t been fetched yet, it is done when calling
+this
+method for the first time.</p>
+<p>As the players and their scores change quite often be sure to update
+this
+list regularly by calling <span class='object_link'><a href="#update_players-instance_method" title="GameServer#update_players (method)">#update_players</a></span> if you rely on
+this
+information.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>rcon_password</span>
+        <span class='type'>(<tt>String</tt>)</span>
+        <em class="default">(defaults to: <tt>nil</tt>)</em>
+        &mdash;
+        <div class='inline'>
+<p>The RCON password of this server may be
+provided to gather more detailed
+information on the players, like
+STEAM_IDs.</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Hash</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>The players on this server</p>
+</div>
+    </li>
+</ul>
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+      <li>update_players</li>
+  </ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+122
+123
+124
+125</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/servers/game_server.rb', line 122</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_players'>players</span><span class='lparen'>(</span><span class='id identifier rubyid_rcon_password'>rcon_password</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_update_players'>update_players</span><span class='lparen'>(</span><span class='id identifier rubyid_rcon_password'>rcon_password</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='ivar'>@player_hash</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
+  <span class='ivar'>@player_hash</span>
+<span class='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">
+    <div class="note abstract">
+  <strong>This method is abstract.</strong>
+  <div class='inline'>
+<p>Must be be implemented by including classes to handle the
+authentication</p>
+</div>
+</div>
+<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 the authentication was successful</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Raises:</p>
+<ul class="raise">
+    <li>
+        <span class='type'>(<tt>NotImplementedError</tt>)</span>
+    </li>
+</ul>
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+      <li><span class='object_link'><a href="#rcon_exec-instance_method" title="GameServer#rcon_exec (method)">#rcon_exec</a></span></li>
+  </ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+134
+135
+136</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/servers/game_server.rb', line 134</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_rcon_auth'>rcon_auth</span><span class='lparen'>(</span><span class='id identifier rubyid_password'>password</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_raise'>raise</span> <span class='const'>NotImplementedError</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="rcon_authenticated?-instance_method">
+    - (<tt>Boolean</tt>) <strong>rcon_authenticated?</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns whether the RCON connection to this server is already authenticated</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Boolean</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p><code>true</code> if the RCON connection is authenticated</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="GameServer#rcon_auth (method)">#rcon_auth</a></span></li>
+  </ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+142
+143
+144</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/servers/game_server.rb', line 142</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_rcon_authenticated?'>rcon_authenticated?</span>
+  <span class='ivar'>@rcon_authenticated</span>
+<span class='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">
+    <div class="note abstract">
+  <strong>This method is abstract.</strong>
+  <div class='inline'>
+<p>Must be be implemented by including classes to handle the command
+execution</p>
+</div>
+</div>
+<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</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>NotImplementedError</tt>)</span>
+    </li>
+</ul>
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+      <li><span class='object_link'><a href="#rcon_auth-instance_method" title="GameServer#rcon_auth (method)">#rcon_auth</a></span></li>
+  </ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+153
+154
+155</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/servers/game_server.rb', line 153</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_rcon_exec'>rcon_exec</span><span class='lparen'>(</span><span class='id identifier rubyid_command'>command</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_raise'>raise</span> <span class='const'>NotImplementedError</span>
+<span class='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="SteamPacket.html" title="SteamPacket (module)">SteamPacket</a></span></tt>) <strong>reply</strong>  <span class="extras">(protected)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Receives a response from the server</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="SteamPacket.html" title="SteamPacket (module)">SteamPacket</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>The response packet replied by the server</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+382
+383
+384</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/servers/game_server.rb', line 382</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_reply'>reply</span>
+  <span class='ivar'>@socket</span><span class='period'>.</span><span class='id identifier rubyid_reply'>reply</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="rules-instance_method">
+    - (<tt>Hash&lt;String, String&gt;</tt>) <strong>rules</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns the settings applied on the server. These settings are also
+called
+rules.</p>
+<p>If the rules haven&#39;t been fetched yet, it is done when calling this
+method
+for the first time.</p>
+<p>As the rules usually don&#39;t change often, there&#39;s almost no need to
+update
+this hash. But if you need to, you can achieve this by
+calling
+<span class='object_link'><a href="#update_rules-instance_method" title="GameServer#update_rules (method)">#update_rules</a></span>.</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Hash&lt;String, String&gt;</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>The currently active server rules</p>
+</div>
+    </li>
+</ul>
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+      <li><span class='object_link'><a href="#update_rules-instance_method" title="GameServer#update_rules (method)">#update_rules</a></span></li>
+  </ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+169
+170
+171
+172</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/servers/game_server.rb', line 169</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_rules'>rules</span>
+  <span class='id identifier rubyid_update_rules'>update_rules</span> <span class='kw'>if</span> <span class='ivar'>@rules_hash</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
+  <span class='ivar'>@rules_hash</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="send_request-instance_method">
+    - (<tt>Object</tt>) <strong>send_request</strong>(packet)  <span class="extras">(protected)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Sends a request packet to the server</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>packet</span>
+        <span class='type'>(<tt><span class='object_link'><a href="SteamPacket.html" title="SteamPacket (module)">SteamPacket</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>The request packet to send to the server</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+389
+390
+391</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/servers/game_server.rb', line 389</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_send_request'>send_request</span><span class='lparen'>(</span><span class='id identifier rubyid_packet'>packet</span><span class='rparen'>)</span>
+  <span class='ivar'>@socket</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span> <span class='id identifier rubyid_packet'>packet</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="server_info-instance_method">
+    - (<tt>Hash</tt>) <strong>server_info</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns a hash with basic information on the server.</p>
+<p>If the server information haven&#39;t been fetched yet, it is done
+when
+calling this method for the first time.</p>
+<p>The server information usually only changes on map change and when
+players
+join or leave. As the latter changes can be monitored by
+calling
+<span class='object_link'><a href="#update_players-instance_method" title="GameServer#update_players (method)">#update_players</a></span>, there&#39;s no need to call
+<span class='object_link'><a href="#update_server_info-instance_method" title="GameServer#update_server_info (method)">#update_server_info</a></span> very
+often.</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Hash</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>Server attributes with their values</p>
+</div>
+    </li>
+</ul>
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+      <li><span class='object_link'><a href="#update_server_info-instance_method" title="GameServer#update_server_info (method)">#update_server_info</a></span></li>
+  </ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+186
+187
+188
+189</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/servers/game_server.rb', line 186</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_server_info'>server_info</span>
+  <span class='id identifier rubyid_update_server_info'>update_server_info</span> <span class='kw'>if</span> <span class='ivar'>@info_hash</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
+  <span class='ivar'>@info_hash</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="to_s-instance_method">
+    - (<tt>String</tt>) <strong>to_s</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns a human-readable text representation of the server</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>Available information about the server in a human-readable
+format</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+347
+348
+349
+350
+351
+352
+353
+354
+355
+356
+357
+358
+359
+360
+361
+362
+363
+364
+365
+366
+367
+368
+369
+370
+371
+372
+373
+374
+375</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/servers/game_server.rb', line 347</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_to_s'>to_s</span>
+  <span class='id identifier rubyid_return_string'>return_string</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span>
+  <span class='id identifier rubyid_return_string'>return_string</span> <span class='op'>&lt;&lt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Ping: </span><span class='embvar'>#</span><span class='ivar'>@ping</span><span class='tstring_content'>\n</span><span class='tstring_end'>&quot;</span></span>
+  <span class='id identifier rubyid_return_string'>return_string</span> <span class='op'>&lt;&lt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Challenge number: </span><span class='embvar'>#</span><span class='ivar'>@challenge_number</span><span class='tstring_content'>\n</span><span class='tstring_end'>&quot;</span></span>
+  <span class='kw'>unless</span> <span class='ivar'>@info_hash</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
+    <span class='id identifier rubyid_return_string'>return_string</span> <span class='op'>&lt;&lt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Info:\n</span><span class='tstring_end'>&quot;</span></span>
+    <span class='ivar'>@info_hash</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='op'>|</span>
+      <span class='id identifier rubyid_return_string'>return_string</span> <span class='op'>&lt;&lt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>  </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_key'>key</span><span class='embexpr_end'>}</span><span class='tstring_content'>: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_inspect'>inspect</span><span class='embexpr_end'>}</span><span class='tstring_content'>\n</span><span class='tstring_end'>&quot;</span></span>
+    <span class='kw'>end</span>
+  <span class='kw'>end</span>
+  <span class='kw'>unless</span> <span class='ivar'>@player_hash</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
+    <span class='id identifier rubyid_return_string'>return_string</span> <span class='op'>&lt;&lt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Players:\n</span><span class='tstring_end'>&quot;</span></span>
+    <span class='ivar'>@player_hash</span><span class='period'>.</span><span class='id identifier rubyid_each_value'>each_value</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_player'>player</span><span class='op'>|</span>
+      <span class='id identifier rubyid_return_string'>return_string</span> <span class='op'>&lt;&lt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>  </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_player'>player</span><span class='embexpr_end'>}</span><span class='tstring_content'>\n</span><span class='tstring_end'>&quot;</span></span>
+    <span class='kw'>end</span>
+  <span class='kw'>end</span>
+  <span class='kw'>unless</span> <span class='ivar'>@rules_hash</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
+    <span class='id identifier rubyid_return_string'>return_string</span> <span class='op'>&lt;&lt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Rules:\n</span><span class='tstring_end'>&quot;</span></span>
+    <span class='ivar'>@rules_hash</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='op'>|</span>
+      <span class='id identifier rubyid_return_string'>return_string</span> <span class='op'>&lt;&lt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>  </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_key'>key</span><span class='embexpr_end'>}</span><span class='tstring_content'>: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_value'>value</span><span class='embexpr_end'>}</span><span class='tstring_content'>\n</span><span class='tstring_end'>&quot;</span></span>
+    <span class='kw'>end</span>
+  <span class='kw'>end</span>
+  <span class='id identifier rubyid_return_string'>return_string</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="update_challenge_number-instance_method">
+    - (<tt>Object</tt>) <strong>update_challenge_number</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Sends a A2S_SERVERQUERY_GETCHALLENGE request to the server and updates
+the
+challenge number used to communicate with this server</p>
+<p>There&#39;s usually no need to call this method explicitly,
+because
+<span class='object_link'><a href="#handle_response_for_request-instance_method" title="GameServer#handle_response_for_request (method)">#handle_response_for_request</a></span> will automatically get the challenge
+number
+when the server assigns a new one.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+      <li><span class='object_link'><a href="#handle_response_for_request-instance_method" title="GameServer#handle_response_for_request (method)">#handle_response_for_request</a></span></li>
+      <li><span class='object_link'><a href="#init-instance_method" title="GameServer#init (method)">#init</a></span></li>
+  </ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+323
+324
+325</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/servers/game_server.rb', line 323</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_update_challenge_number'>update_challenge_number</span>
+  <span class='id identifier rubyid_handle_response_for_request'>handle_response_for_request</span> <span class='symbol'>:challenge</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="update_ping-instance_method">
+    - (<tt>Fixnum</tt>) <strong>update_ping</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Sends a A2S_INFO request to the server and measures the time needed for
+the
+reply</p>
+<p>If this information is vital to you, be sure to call this method
+regularly
+to stay up-to-date.</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Fixnum</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>The latency of this server in milliseconds</p>
+</div>
+    </li>
+</ul>
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+      <li><span class='object_link'><a href="#ping-instance_method" title="GameServer#ping (method)">#ping</a></span></li>
+  </ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+335
+336
+337
+338
+339
+340
+341</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/servers/game_server.rb', line 335</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_update_ping'>update_ping</span>
+  <span class='id identifier rubyid_send_request'>send_request</span> <span class='const'>A2S_INFO_Packet</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
+  <span class='id identifier rubyid_start_time'>start_time</span> <span class='op'>=</span> <span class='const'>Time</span><span class='period'>.</span><span class='id identifier rubyid_now'>now</span>
+  <span class='id identifier rubyid_reply'>reply</span>
+  <span class='id identifier rubyid_end_time'>end_time</span> <span class='op'>=</span> <span class='const'>Time</span><span class='period'>.</span><span class='id identifier rubyid_now'>now</span>
+  <span class='ivar'>@ping</span> <span class='op'>=</span> <span class='lparen'>(</span><span class='id identifier rubyid_end_time'>end_time</span> <span class='op'>-</span> <span class='id identifier rubyid_start_time'>start_time</span><span class='rparen'>)</span> <span class='op'>*</span> <span class='int'>1000</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="update_players-instance_method">
+    - (<tt>Object</tt>) <strong>update_players</strong>(rcon_password = nil)
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Sends a A2S_PLAYERS request to the server and updates the players&#39; data
+for
+this server</p>
+<p>As the players and their scores change quite often be sure to update
+this
+list regularly by calling this method if you rely on this
+information.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>rcon_password</span>
+        <span class='type'>(<tt>String</tt>)</span>
+        <em class="default">(defaults to: <tt>nil</tt>)</em>
+        &mdash;
+        <div class='inline'>
+<p>The RCON password of this server may be
+provided to gather more detailed
+information on the players, like
+STEAM_IDs.</p>
+</div>
+    </li>
+</ul>
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+      <li><span class='object_link'><a href="#handle_response_for_request-instance_method" title="GameServer#handle_response_for_request (method)">#handle_response_for_request</a></span></li>
+      <li><span class='object_link'><a href="#players-instance_method" title="GameServer#players (method)">#players</a></span></li>
+  </ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+265
+266
+267
+268
+269
+270
+271
+272
+273
+274
+275
+276
+277
+278
+279
+280
+281
+282
+283
+284
+285
+286
+287</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/servers/game_server.rb', line 265</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_update_players'>update_players</span><span class='lparen'>(</span><span class='id identifier rubyid_rcon_password'>rcon_password</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_handle_response_for_request'>handle_response_for_request</span> <span class='symbol'>:players</span>
+  <span class='kw'>unless</span> <span class='ivar'>@rcon_authenticated</span>
+    <span class='kw'>return</span> <span class='kw'>if</span> <span class='id identifier rubyid_rcon_password'>rcon_password</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
+    <span class='id identifier rubyid_rcon_auth'>rcon_auth</span> <span class='id identifier rubyid_rcon_password'>rcon_password</span>
+  <span class='kw'>end</span>
+  <span class='id identifier rubyid_players'>players</span> <span class='op'>=</span> <span class='id identifier rubyid_rcon_exec'>rcon_exec</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>status</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_lines'>lines</span><span class='period'>.</span><span class='id identifier rubyid_select'>select</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_line'>line</span><span class='op'>|</span>
+    <span class='id identifier rubyid_line'>line</span><span class='period'>.</span><span class='id identifier rubyid_start_with?'>start_with?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>#</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_line'>line</span> <span class='op'>!=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>#end\n</span><span class='tstring_end'>&quot;</span></span>
+  <span class='kw'>end</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_line'>line</span><span class='op'>|</span>
+    <span class='id identifier rubyid_line'>line</span><span class='lbracket'>[</span><span class='int'>1</span><span class='op'>..</span><span class='op'>-</span><span class='int'>1</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_strip'>strip</span>
+  <span class='kw'>end</span>
+  <span class='id identifier rubyid_attributes'>attributes</span> <span class='op'>=</span> <span class='const'>GameServer</span><span class='period'>.</span><span class='id identifier rubyid_player_status_attributes'>player_status_attributes</span> <span class='id identifier rubyid_players'>players</span><span class='period'>.</span><span class='id identifier rubyid_shift'>shift</span>
+  <span class='id identifier rubyid_players'>players</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_player'>player</span><span class='op'>|</span>
+    <span class='id identifier rubyid_player_data'>player_data</span> <span class='op'>=</span> <span class='const'>GameServer</span><span class='period'>.</span><span class='id identifier rubyid_split_player_status'>split_player_status</span><span class='lparen'>(</span><span class='id identifier rubyid_attributes'>attributes</span><span class='comma'>,</span> <span class='id identifier rubyid_player'>player</span><span class='rparen'>)</span>
+    <span class='id identifier rubyid_player_name'>player_name</span> <span class='op'>=</span> <span class='id identifier rubyid_player_data'>player_data</span><span class='lbracket'>[</span><span class='symbol'>:name</span><span class='rbracket'>]</span>
+    <span class='kw'>if</span> <span class='ivar'>@player_hash</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span> <span class='id identifier rubyid_player_name'>player_name</span>
+      <span class='ivar'>@player_hash</span><span class='lbracket'>[</span><span class='id identifier rubyid_player_name'>player_name</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_add_info'>add_info</span> <span class='id identifier rubyid_player_data'>player_data</span>
+    <span class='kw'>end</span>
+  <span class='kw'>end</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="update_rules-instance_method">
+    - (<tt>Object</tt>) <strong>update_rules</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Sends a A2S_RULES request to the server and updates the rules of
+this
+server</p>
+<p>As the rules usually don&#39;t change often, there&#39;s almost no need to
+update
+this hash. But if you need to, you can achieve this by calling this
+method.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+      <li><span class='object_link'><a href="#handle_response_for_request-instance_method" title="GameServer#handle_response_for_request (method)">#handle_response_for_request</a></span></li>
+      <li><span class='object_link'><a href="#rules-instance_method" title="GameServer#rules (method)">#rules</a></span></li>
+  </ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+297
+298
+299</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/servers/game_server.rb', line 297</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_update_rules'>update_rules</span>
+  <span class='id identifier rubyid_handle_response_for_request'>handle_response_for_request</span> <span class='symbol'>:rules</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="update_server_info-instance_method">
+    - (<tt>Object</tt>) <strong>update_server_info</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Sends a A2S_INFO request to the server and updates this server&#39;s
+basic
+information</p>
+<p>The server information usually only changes on map change and when
+players
+join or leave. As the latter changes can be monitored by
+calling
+<span class='object_link'><a href="#update_players-instance_method" title="GameServer#update_players (method)">#update_players</a></span>, there&#39;s no need to call this method very
+often.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+      <li><span class='object_link'><a href="#handle_response_for_request-instance_method" title="GameServer#handle_response_for_request (method)">#handle_response_for_request</a></span></li>
+      <li><span class='object_link'><a href="#server_info-instance_method" title="GameServer#server_info (method)">#server_info</a></span></li>
+  </ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+310
+311
+312</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/servers/game_server.rb', line 310</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_update_server_info'>update_server_info</span>
+  <span class='id identifier rubyid_handle_response_for_request'>handle_response_for_request</span> <span class='symbol'>:info</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+</div>
+    <div id="footer">
+  Generated on Tue Jul 22 07:10:16 2014 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.7.3 (ruby-2.0.0).
+</div>
+  </body>
+</html>