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

steam-condenser 1.3.6 → 1.3.7

Files changed (500) hide show

data/doc/MasterServer.html ADDED Viewed

@@ -0,0 +1,1069 @@
+<!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: MasterServer
+    &mdash; Metior — API Documentation
+</title>
+  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '';
+  framesUrl = "frames.html#!" + escape(window.location.href);
+</script>
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+    <a href="_index.html">Index (M)</a> &raquo;
+    <span class="title">MasterServer</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: MasterServer
+</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">MasterServer</li>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      </dd>
+      <dt class="r2">Includes:</dt>
+      <dd class="r2"><span class='object_link'><a href="Server.html" title="Server (module)">Server</a></span></dd>
+    <dt class="r1 last">Defined in:</dt>
+    <dd class="r1 last">lib/steam/servers/master_server.rb</dd>
+</dl>
+<div class="clear"></div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <p>This class represents a Steam master server and can be used to get game
+servers which are publicly available</p>
+<p>An intance of this class can be used much like Steam&#39;s server browser to get
+a list of available game servers, including filters to narrow down the search
+results.</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>Constant Summary</h2>
+    <dl class="constants">
+        <dt id="GOLDSRC_MASTER_SERVER-constant" class="">GOLDSRC_MASTER_SERVER =
+          <div class="docstring">
+  <div class="discussion">
+    <p>The master server address to query for GoldSrc game servers</p>
+  </div>
+</div>
+<div class="tags">
+</div>
+        </dt>
+        <dd><pre class="code"><span class='string val'>'hl1master.steampowered.com'</span><span class='comma token'>,</span> <span class='integer val'>27011</span>
+</pre></dd>
+        <dt id="SOURCE_MASTER_SERVER-constant" class="">SOURCE_MASTER_SERVER =
+          <div class="docstring">
+  <div class="discussion">
+    <p>The master server address to query for Source game servers</p>
+  </div>
+</div>
+<div class="tags">
+</div>
+        </dt>
+        <dd><pre class="code"><span class='string val'>'hl2master.steampowered.com'</span><span class='comma token'>,</span> <span class='integer val'>27011</span>
+</pre></dd>
+        <dt id="REGION_US_EAST_COAST-constant" class="">REGION_US_EAST_COAST =
+          <div class="docstring">
+  <div class="discussion">
+    <p>The region code for the US east coast</p>
+  </div>
+</div>
+<div class="tags">
+</div>
+        </dt>
+        <dd><pre class="code"><span class='integer val'>0x00</span>
+</pre></dd>
+        <dt id="REGION_US_WEST_COAST-constant" class="">REGION_US_WEST_COAST =
+          <div class="docstring">
+  <div class="discussion">
+    <p>The region code for the US west coast</p>
+  </div>
+</div>
+<div class="tags">
+</div>
+        </dt>
+        <dd><pre class="code"><span class='integer val'>0x01</span>
+</pre></dd>
+        <dt id="REGION_SOUTH_AMERICA-constant" class="">REGION_SOUTH_AMERICA =
+          <div class="docstring">
+  <div class="discussion">
+    <p>The region code for South America</p>
+  </div>
+</div>
+<div class="tags">
+</div>
+        </dt>
+        <dd><pre class="code"><span class='integer val'>0x02</span>
+</pre></dd>
+        <dt id="REGION_EUROPE-constant" class="">REGION_EUROPE =
+          <div class="docstring">
+  <div class="discussion">
+    <p>The region code for Europe</p>
+  </div>
+</div>
+<div class="tags">
+</div>
+        </dt>
+        <dd><pre class="code"><span class='integer val'>0x03</span>
+</pre></dd>
+        <dt id="REGION_ASIA-constant" class="">REGION_ASIA =
+          <div class="docstring">
+  <div class="discussion">
+    <p>The region code for Asia</p>
+  </div>
+</div>
+<div class="tags">
+</div>
+        </dt>
+        <dd><pre class="code"><span class='integer val'>0x04</span>
+</pre></dd>
+        <dt id="REGION_AUSTRALIA-constant" class="">REGION_AUSTRALIA =
+          <div class="docstring">
+  <div class="discussion">
+    <p>The region code for Australia</p>
+  </div>
+</div>
+<div class="tags">
+</div>
+        </dt>
+        <dd><pre class="code"><span class='integer val'>0x05</span>
+</pre></dd>
+        <dt id="REGION_MIDDLE_EAST-constant" class="">REGION_MIDDLE_EAST =
+          <div class="docstring">
+  <div class="discussion">
+    <p>The region code for the Middle East</p>
+  </div>
+</div>
+<div class="tags">
+</div>
+        </dt>
+        <dd><pre class="code"><span class='integer val'>0x06</span>
+</pre></dd>
+        <dt id="REGION_AFRICA-constant" class="">REGION_AFRICA =
+          <div class="docstring">
+  <div class="discussion">
+    <p>The region code for Africa</p>
+  </div>
+</div>
+<div class="tags">
+</div>
+        </dt>
+        <dd><pre class="code"><span class='integer val'>0x07</span>
+</pre></dd>
+        <dt id="REGION_ALL-constant" class="">REGION_ALL =
+          <div class="docstring">
+  <div class="discussion">
+    <p>The region code for the whole world</p>
+  </div>
+</div>
+<div class="tags">
+</div>
+        </dt>
+        <dd><pre class="code"><span class='integer val'>0x</span><span class='rubyid_FF constant id'>FF</span>
+</pre></dd>
+        <dt id="retries-classvariable" class="">@@retries =
+          <div class="docstring">
+  <div class="discussion">
+    <p>The default number of allowed retries</p>
+  </div>
+</div>
+<div class="tags">
+</div>
+        </dt>
+        <dd><pre class="code"><span class='integer val'>3</span>
+</pre></dd>
+    </dl>
+  <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="#retries%3D-class_method" title="retries= (class method)">+ (Object) <strong>retries=</strong>(retries) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Sets the number of consecutive requests that may fail, before getting the server list is cancelled (default: 3).</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 deprecated">
+  <span class="summary_signature">
+      <a href="#challenge-instance_method" title="#challenge (instance method)">- (Fixnum) <strong>challenge</strong> </a>
+  </span>
+  <span class="deprecated note title">deprecated</span>
+    <span class="summary_desc"><strong>Deprecated.</strong> <div class='inline'></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 socket to communicate with the master server.</p>
+</div></span>
+</li>
+        <li class="public deprecated">
+  <span class="summary_signature">
+      <a href="#send_heartbeat-instance_method" title="#send_heartbeat (instance method)">- (Array&lt;SteamPacket&gt;) <strong>send_heartbeat</strong>(data) </a>
+  </span>
+  <span class="deprecated note title">deprecated</span>
+    <span class="summary_desc"><strong>Deprecated.</strong> <div class='inline'></div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#servers-instance_method" title="#servers (instance method)">- (Array&lt;Array&lt;String&gt;&gt;) <strong>servers</strong>(region_code = MasterServer::REGION_ALL, filters = '', force = false) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Returns a list of game server matching the given region and filters.</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#initialize-instance_method" title="Server#initialize (method)">#initialize</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="retries=-class_method">
+    + (<tt>Object</tt>) <strong>retries=</strong>(retries)
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Sets the number of consecutive requests that may fail, before getting
+the server list is cancelled (default: 3)</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>retries</span>
+        <span class='type'>(<tt>Fixnum</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The number of allowed retries</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+65
+66
+67</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/servers/master_server.rb', line 65</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_retries identifier id'>retries</span><span class='assign token'>=</span><span class='lparen token'>(</span><span class='rubyid_retries identifier id'>retries</span><span class='rparen token'>)</span>
+  <span class='rubyid_@@retries ivar id'>@@retries</span> <span class='assign token'>=</span> <span class='rubyid_retries identifier id'>retries</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="challenge-instance_method">
+    - (<tt>Fixnum</tt>) <strong>challenge</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+    <div class="note deprecated"><strong>Deprecated.</strong> <div class='inline'></div></div>
+  <div class="note notetag">
+    <strong>Note:</strong>
+    <div class='inline'><p>Please note that this is <strong>not</strong> needed for finding servers using
+<span class='object_link'><a href="#servers-instance_method" title="MasterServer#servers (method)">#servers</a></span>.</p>
+</div>
+  </div>
+<p>Request a challenge number from the master server.</p>
+<p>This is used for further communication with the master server.</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 challenge number from the master server</p>
+</div>
+    </li>
+</ul>
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+      <li><span class='object_link'><a href="#send_heartbeat-instance_method" title="MasterServer#send_heartbeat (method)">#send_heartbeat</a></span></li>
+  </ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+78
+79
+80
+81
+82
+83</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/servers/master_server.rb', line 78</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_challenge identifier id'>challenge</span>
+  <span class='rubyid_failsafe identifier id'>failsafe</span> <span class='rubyid_do do kw'>do</span>
+    <span class='rubyid_@socket ivar id'>@socket</span><span class='dot token'>.</span><span class='rubyid_send identifier id'>send</span> <span class='rubyid_C2M_CHECKMD5_Packet constant id'>C2M_CHECKMD5_Packet</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span>
+    <span class='rubyid_@socket ivar id'>@socket</span><span class='dot token'>.</span><span class='rubyid_reply identifier id'>reply</span><span class='dot token'>.</span><span class='rubyid_challenge identifier id'>challenge</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="init_socket-instance_method">
+    - (<tt>Object</tt>) <strong>init_socket</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Initializes the socket to communicate with the master server</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+      <li><span class='object_link'><a href="MasterServerSocket.html" title="MasterServerSocket (class)">MasterServerSocket</a></span></li>
+  </ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+88
+89
+90</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/servers/master_server.rb', line 88</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_init_socket identifier id'>init_socket</span>
+  <span class='rubyid_@socket ivar id'>@socket</span> <span class='assign token'>=</span> <span class='rubyid_MasterServerSocket constant id'>MasterServerSocket</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="send_heartbeat-instance_method">
+    - (<tt>Array&lt;<span class='object_link'><a href="SteamPacket.html" title="SteamPacket (module)">SteamPacket</a></span>&gt;</tt>) <strong>send_heartbeat</strong>(data)
+</h3><div class="docstring">
+  <div class="discussion">
+    <div class="note deprecated"><strong>Deprecated.</strong> <div class='inline'></div></div>
+<p>Sends a constructed heartbeat to the master server</p>
+<p>This can be used to check server versions externally.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>data</span>
+        <span class='type'>(<tt>Hash&lt;Symbol, Object&gt;</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The data to send with the heartbeat
+request</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Array&lt;<span class='object_link'><a href="SteamPacket.html" title="SteamPacket (module)">SteamPacket</a></span>&gt;</tt>)</span>
+        &mdash;
+        <div class='inline'><p>Zero or more reply packets from the server.
+Zero means either the heartbeat was accepted by the master or there
+was a timeout. So usually it&#39;s best to repeat a heartbeat a few
+times when not receiving any packets.</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 heartbeat data is missing the
+challenge number or the reply cannot be parsed</p>
+</div>
+    </li>
+</ul>
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+      <li><span class='object_link'><a href="S2M_HEARTBEAT2_Packet.html" title="S2M_HEARTBEAT2_Packet (class)">S2M_HEARTBEAT2_Packet</a></span></li>
+  </ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+173
+174
+175
+176
+177
+178
+179
+180
+181
+182
+183
+184
+185
+186</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/servers/master_server.rb', line 173</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_send_heartbeat identifier id'>send_heartbeat</span><span class='lparen token'>(</span><span class='rubyid_data identifier id'>data</span><span class='rparen token'>)</span>
+  <span class='rubyid_reply_packets identifier id'>reply_packets</span> <span class='assign token'>=</span> <span class='lbrack token'>[</span><span class='rbrack token'>]</span>
+  <span class='rubyid_failsafe identifier id'>failsafe</span> <span class='rubyid_do do kw'>do</span>
+    <span class='rubyid_@socket ivar id'>@socket</span><span class='dot token'>.</span><span class='rubyid_send identifier id'>send</span> <span class='rubyid_S2M_HEARTBEAT2_Packet constant id'>S2M_HEARTBEAT2_Packet</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_data identifier id'>data</span><span class='rparen token'>)</span>
+    <span class='rubyid_begin begin kw'>begin</span>
+      <span class='rubyid_loop identifier id'>loop</span> <span class='lbrace token'>{</span> <span class='rubyid_reply_packets identifier id'>reply_packets</span> <span class='lshft op'>&lt;&lt;</span> <span class='rubyid_@socket ivar id'>@socket</span><span class='dot token'>.</span><span class='rubyid_reply identifier id'>reply</span> <span class='rbrace token'>}</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_reply_packets identifier id'>reply_packets</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="servers-instance_method">
+    - (<tt>Array&lt;Array&lt;String&gt;&gt;</tt>) <strong>servers</strong>(region_code = MasterServer::REGION_ALL, filters = '', force = false)
+</h3><div class="docstring">
+  <div class="discussion">
+  <div class="note notetag">
+    <strong>Note:</strong>
+    <div class='inline'><p>Receiving all servers from the master server is taking quite some
+time.</p>
+</div>
+  </div>
+<p>Returns a list of game server matching the given region and filters</p>
+<p>Filtering:
+Instead of filtering the results sent by the master server locally, you
+should at least use the following filters to narrow down the results sent
+by the master server.</p>
+<p>Available filters:</p>
+<ul>
+<li><code>\type\d</code>: Request only dedicated servers</li>
+<li><code>\secure\1</code>: Request only secure servers</li>
+<li><code>\gamedir\[mod]</code>: Request only servers of a specific mod</li>
+<li><code>\map\[mapname]</code>: Request only servers running a specific map</li>
+<li><code>\linux\1</code>: Request only linux servers</li>
+<li><code>\emtpy\1</code>: Request only <strong>non</strong>-empty servers</li>
+<li><code>\full\1</code>: Request only servers <strong>not</strong> full</li>
+<li><code>\proxy\1</code>: Request only spectator proxy servers</li>
+</ul>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>region_code</span>
+        <span class='type'>(<tt>Fixnum</tt>)</span>
+        <em class="default">(defaults to: <tt>MasterServer::REGION_ALL</tt>)</em>
+        &mdash;
+        <div class='inline'><p>The region code to specify a location of the
+game servers</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>filters</span>
+        <span class='type'>(<tt>String</tt>)</span>
+        <em class="default">(defaults to: <tt>''</tt>)</em>
+        &mdash;
+        <div class='inline'><p>The filters that game servers should match</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>force</span>
+        <span class='type'>(<tt>Boolean</tt>)</span>
+        <em class="default">(defaults to: <tt>false</tt>)</em>
+        &mdash;
+        <div class='inline'><p>Return a list of servers even if an error occured
+while fetching them from the master server</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Array&lt;Array&lt;String&gt;&gt;</tt>)</span>
+        &mdash;
+        <div class='inline'><p>A list of game servers matching the given
+region and filters</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Raises:</p>
+<ul class="raise">
+    <li>
+        <span class='type'>(<tt><span class='object_link'><a href="SteamCondenser/TimeoutError.html" title="SteamCondenser::TimeoutError (class)">SteamCondenser::TimeoutError</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'><p>if too many timeouts occur while
+querying the master server</p>
+</div>
+    </li>
+</ul>
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+      <li><span class='object_link'><a href="A2M_GET_SERVERS_BATCH2_Packet.html" title="A2M_GET_SERVERS_BATCH2_Packet (class)">A2M_GET_SERVERS_BATCH2_Packet</a></span></li>
+      <li><span class='object_link'><a href="#retries%3D-class_method" title="MasterServer.retries= (method)">retries=</a></span></li>
+  </ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+123
+124
+125
+126
+127
+128
+129
+130
+131
+132
+133
+134
+135
+136
+137
+138
+139
+140
+141
+142
+143
+144
+145
+146
+147
+148
+149
+150
+151
+152
+153
+154
+155
+156
+157</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/servers/master_server.rb', line 123</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_servers identifier id'>servers</span><span class='lparen token'>(</span><span class='rubyid_region_code identifier id'>region_code</span> <span class='assign token'>=</span> <span class='rubyid_MasterServer constant id'>MasterServer</span><span class='colon2 op'>::</span><span class='rubyid_REGION_ALL constant id'>REGION_ALL</span><span class='comma token'>,</span> <span class='rubyid_filters identifier id'>filters</span> <span class='assign token'>=</span> <span class='string val'>''</span><span class='comma token'>,</span> <span class='rubyid_force identifier id'>force</span> <span class='assign token'>=</span> <span class='rubyid_false false kw'>false</span><span class='rparen token'>)</span>
+  <span class='rubyid_finished identifier id'>finished</span>       <span class='assign token'>=</span> <span class='rubyid_false false kw'>false</span>
+  <span class='rubyid_current_server identifier id'>current_server</span> <span class='assign token'>=</span> <span class='string val'>'0.0.0.0:0'</span>
+  <span class='rubyid_server_array identifier id'>server_array</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_failsafe identifier id'>failsafe</span> <span class='rubyid_do do kw'>do</span>
+      <span class='rubyid_fail_count identifier id'>fail_count</span> <span class='assign token'>=</span> <span class='integer val'>0</span>
+      <span class='rubyid_begin begin kw'>begin</span>
+        <span class='rubyid_@socket ivar id'>@socket</span><span class='dot token'>.</span><span class='rubyid_send identifier id'>send</span> <span class='rubyid_A2M_GET_SERVERS_BATCH2_Packet constant id'>A2M_GET_SERVERS_BATCH2_Packet</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_region_code identifier id'>region_code</span><span class='comma token'>,</span> <span class='rubyid_current_server identifier id'>current_server</span><span class='comma token'>,</span> <span class='rubyid_filters identifier id'>filters</span><span class='rparen token'>)</span>
+        <span class='rubyid_begin begin kw'>begin</span>
+          <span class='rubyid_servers identifier id'>servers</span> <span class='assign token'>=</span> <span class='rubyid_@socket ivar id'>@socket</span><span class='dot token'>.</span><span class='rubyid_reply identifier id'>reply</span><span class='dot token'>.</span><span class='rubyid_servers identifier id'>servers</span>
+          <span class='rubyid_servers identifier id'>servers</span><span class='dot token'>.</span><span class='rubyid_each identifier id'>each</span> <span class='rubyid_do do kw'>do</span> <span class='bitor op'>|</span><span class='rubyid_server identifier id'>server</span><span class='bitor op'>|</span>
+            <span class='rubyid_if if kw'>if</span> <span class='rubyid_server identifier id'>server</span> <span class='eq op'>==</span> <span class='string val'>'0.0.0.0:0'</span>
+              <span class='rubyid_finished identifier id'>finished</span> <span class='assign token'>=</span> <span class='rubyid_true true kw'>true</span>
+            <span class='rubyid_else else kw'>else</span>
+              <span class='rubyid_current_server identifier id'>current_server</span> <span class='assign token'>=</span> <span class='rubyid_server identifier id'>server</span>
+              <span class='rubyid_server_array identifier id'>server_array</span> <span class='lshft op'>&lt;&lt;</span> <span class='rubyid_server identifier id'>server</span><span class='dot token'>.</span><span class='rubyid_split identifier id'>split</span><span class='lparen token'>(</span><span class='string val'>':'</span><span class='rparen token'>)</span>
+            <span class='rubyid_end end kw'>end</span>
+          <span class='rubyid_end end kw'>end</span>
+          <span class='rubyid_fail_count identifier id'>fail_count</span> <span class='assign token'>=</span> <span class='integer val'>0</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_raise identifier id'>raise</span> <span class='rubyid_$! gvar id'>$!</span> <span class='rubyid_if if_mod kw'>if</span> <span class='lparen token'>(</span><span class='rubyid_fail_count identifier id'>fail_count</span> <span class='opasgn op'>+=</span> <span class='integer val'>1</span><span class='rparen token'>)</span> <span class='eq op'>==</span> <span class='rubyid_@@retries ivar id'>@@retries</span>
+          <span class='rubyid_if if kw'>if</span> <span class='rubyid_$DEBUG gvar id'>$DEBUG</span>
+            <span class='rubyid_puts identifier id'>puts</span> <span class='string val'>&quot;Request to master server #@ip_address timed out, retrying...&quot;</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='notop op'>!</span><span class='rubyid_finished identifier id'>finished</span>
+    <span class='rubyid_end end kw'>end</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_raise identifier id'>raise</span> <span class='rubyid_$! gvar id'>$!</span> <span class='rubyid_unless unless_mod kw'>unless</span> <span class='rubyid_force identifier id'>force</span>
+  <span class='rubyid_end end kw'>end</span>
+  <span class='rubyid_server_array identifier id'>server_array</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+</div>
+    <div id="footer">
+  Generated on Mon Sep  2 07:13:00 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>