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/Server.html ADDED Viewed

@@ -0,0 +1,874 @@
+<!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: Server
+    &mdash; Metior — API Documentation
+</title>
+  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '';
+  framesUrl = "frames.html#!" + escape(window.location.href);
+</script>
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+    <a href="_index.html">Index (S)</a> &raquo;
+    <span class="title">Server</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: Server
+</h1>
+<dl class="box">
+    <dt class="r1">Included in:</dt>
+    <dd class="r1"><span class='object_link'><a href="GameServer.html" title="GameServer (module)">GameServer</a></span>, <span class='object_link'><a href="MasterServer.html" title="MasterServer (class)">MasterServer</a></span></dd>
+    <dt class="r2 last">Defined in:</dt>
+    <dd class="r2 last">lib/steam/servers/server.rb</dd>
+</dl>
+<div class="clear"></div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <p>This module is included by all classes implementing server functionality</p>
+<p>It provides basic name resolution features and the ability to rotate between
+different IP addresses belonging to a single DNS name.</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 <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
+  <ul class="summary">
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#host_names-instance_method" title="#host_names (instance method)">- (Array&lt;String&gt;) <strong>host_names</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Returns a list of host names associated with this server.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#ip_addresses-instance_method" title="#ip_addresses (instance method)">- (Array&lt;String&gt;) <strong>ip_addresses</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Returns a list of IP addresses associated with this server.</p>
+</div></span>
+</li>
+  </ul>
+    <h2>
+      Instance Method Summary
+      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+    </h2>
+    <ul class="summary">
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#disconnect-instance_method" title="#disconnect (instance method)">- (Object) <strong>disconnect</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Disconnect the connections to this server.</p>
+</div></span>
+</li>
+        <li class="protected ">
+  <span class="summary_signature">
+      <a href="#failsafe-instance_method" title="#failsafe (instance method)">- (Object) <strong>failsafe</strong>(&amp;proc) </a>
+  </span>
+  <span class="note title protected">protected</span>
+    <span class="summary_desc"><div class='inline'><p>Execute an action in the context of this server&#39;s current IP address.</p>
+</div></span>
+</li>
+        <li class="protected ">
+  <span class="summary_signature">
+      <a href="#init_socket-instance_method" title="#init_socket (instance method)">- (Object) <strong>init_socket</strong> </a>
+  </span>
+  <span class="note title protected">protected</span>
+  <span class="abstract note title">abstract</span>
+    <span class="summary_desc"><div class='inline'><p>Initializes the socket(s) to communicate with the server.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#initialize-instance_method" title="#initialize (instance method)">- (Server) <strong>initialize</strong>(address, port = nil) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Creates a new server instance with the given address and port.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#rotate_ip-instance_method" title="#rotate_ip (instance method)">- (Boolean) <strong>rotate_ip</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Rotate this server&#39;s IP address to the next one in the IP list.</p>
+</div></span>
+</li>
+    </ul>
+  <div id="instance_attr_details" class="attr_details">
+    <h2>Instance Attribute Details</h2>
+      <span id=""></span>
+      <div class="method_details first">
+  <h3 class="signature first" id="host_names-instance_method">
+    - (<tt>Array&lt;String&gt;</tt>) <strong>host_names</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns a list of host names associated with this server</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Array&lt;String&gt;</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The host names of this server</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+19
+20
+21</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/servers/server.rb', line 19</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_host_names identifier id'>host_names</span>
+  <span class='rubyid_@host_names ivar id'>@host_names</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id=""></span>
+      <div class="method_details ">
+  <h3 class="signature " id="ip_addresses-instance_method">
+    - (<tt>Array&lt;String&gt;</tt>) <strong>ip_addresses</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns a list of IP addresses associated with this server</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Array&lt;String&gt;</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The IP addresses of this server</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+24
+25
+26</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/servers/server.rb', line 24</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_ip_addresses identifier id'>ip_addresses</span>
+  <span class='rubyid_@ip_addresses ivar id'>@ip_addresses</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+  <div id="instance_method_details" class="method_details_list">
+    <h2>Instance Method Details</h2>
+      <div class="method_details first">
+  <h3 class="signature first" id="disconnect-instance_method">
+    - (<tt>Object</tt>) <strong>disconnect</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+  <div class="note notetag">
+    <strong>Note:</strong>
+    <div class='inline'><p>In the base implementation this does nothing, only connection-based
+communication channels have to be disconnected.</p>
+</div>
+  </div>
+<p>Disconnect the connections to this server</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+59
+60</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/servers/server.rb', line 59</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_disconnect identifier id'>disconnect</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="failsafe-instance_method">
+    - (<tt>Object</tt>) <strong>failsafe</strong>(&amp;proc)  <span class="extras">(protected)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Execute an action in the context of this server&#39;s current IP address</p>
+<p>Any failure will cause the IP to rotate to the next IP in the server&#39;s IP
+list and the execution will be repeated for the next IP address. If the IP
+rotation reaches the end of the list, the error will be reraised.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>proc</span>
+        <span class='type'>(<tt>Proc</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The action to be executed in a failsafe way</p>
+</div>
+    </li>
+</ul>
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+      <li><span class='object_link'><a href="#rotate_ip-instance_method" title="Server#rotate_ip (method)">#rotate_ip</a></span></li>
+  </ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+96
+97
+98
+99
+100
+101
+102
+103
+104
+105
+106</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/servers/server.rb', line 96</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_failsafe identifier id'>failsafe</span><span class='lparen token'>(</span><span class='bitand op'>&amp;</span><span class='rubyid_proc identifier id'>proc</span><span class='rparen token'>)</span>
+  <span class='rubyid_begin begin kw'>begin</span>
+    <span class='rubyid_proc identifier id'>proc</span><span class='dot token'>.</span><span class='rubyid_call identifier id'>call</span>
+  <span class='rubyid_rescue rescue kw'>rescue</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='rubyid_rotate_ip identifier id'>rotate_ip</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 failed, retrying for #@ip_address...&quot;</span>
+    <span class='rubyid_end end kw'>end</span>
+    <span class='rubyid_failsafe identifier id'>failsafe</span> <span class='bitand op'>&amp;</span><span class='rubyid_proc identifier id'>proc</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>  <span class="extras">(protected)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <div class="note abstract">
+  <strong>This method is abstract.</strong>
+  <div class='inline'><p>Must be implemented in including classes to prepare sockets for
+server communication</p>
+</div>
+</div>
+<p>Initializes the socket(s) to communicate with the server</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+112
+113</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/servers/server.rb', line 112</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_init_socket identifier id'>init_socket</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="initialize-instance_method">
+    - (<tt><span class='object_link'><a href="" title="Server (module)">Server</a></span></tt>) <strong>initialize</strong>(address, port = nil)
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Creates a new server instance with the given address and port</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>nil</tt>)</em>
+        &mdash;
+        <div class='inline'><p>The port the server is listening on</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt><span class='object_link'><a href="" title="Server (module)">Server</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'><p>a new instance of Server</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Raises:</p>
+<ul class="raise">
+    <li>
+        <span class='type'>(<tt><span class='object_link'><a href="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>
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+      <li>init_socket</li>
+  </ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+34
+35
+36
+37
+38
+39
+40
+41
+42
+43
+44
+45
+46
+47
+48
+49
+50
+51
+52</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/servers/server.rb', line 34</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='rubyid_address identifier id'>address</span><span class='comma token'>,</span> <span class='rubyid_port identifier id'>port</span> <span class='assign token'>=</span> <span class='rubyid_nil nil kw'>nil</span><span class='rparen token'>)</span>
+  <span class='rubyid_address identifier id'>address</span> <span class='assign token'>=</span> <span class='rubyid_address identifier id'>address</span><span class='dot token'>.</span><span class='rubyid_to_s identifier id'>to_s</span>
+  <span class='rubyid_address identifier id'>address</span><span class='comma token'>,</span> <span class='rubyid_port identifier id'>port</span> <span class='assign token'>=</span> <span class='rubyid_address identifier id'>address</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='comma token'>,</span> <span class='integer val'>2</span><span class='rparen token'>)</span> <span class='rubyid_if if_mod kw'>if</span> <span class='rubyid_address identifier id'>address</span><span class='dot token'>.</span><span class='rubyid_include? fid id'>include?</span> <span class='string val'>':'</span>
+  <span class='rubyid_@host_names ivar id'>@host_names</span>   <span class='assign token'>=</span> <span class='lbrack token'>[</span><span class='rbrack token'>]</span>
+  <span class='rubyid_@ip_addresses ivar id'>@ip_addresses</span> <span class='assign token'>=</span> <span class='lbrack token'>[</span><span class='rbrack token'>]</span>
+  <span class='rubyid_@ip_index ivar id'>@ip_index</span>     <span class='assign token'>=</span> <span class='integer val'>0</span>
+  <span class='rubyid_@port ivar id'>@port</span>         <span class='assign token'>=</span> <span class='rubyid_port identifier id'>port</span>
+  <span class='rubyid_Socket constant id'>Socket</span><span class='dot token'>.</span><span class='rubyid_getaddrinfo identifier id'>getaddrinfo</span><span class='lparen token'>(</span><span class='rubyid_address identifier id'>address</span><span class='comma token'>,</span> <span class='rubyid_port identifier id'>port</span><span class='comma token'>,</span> <span class='rubyid_Socket constant id'>Socket</span><span class='colon2 op'>::</span><span class='rubyid_AF_INET constant id'>AF_INET</span><span class='comma token'>,</span> <span class='rubyid_Socket constant id'>Socket</span><span class='colon2 op'>::</span><span class='rubyid_SOCK_DGRAM constant id'>SOCK_DGRAM</span><span class='rparen token'>)</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_address identifier id'>address</span><span class='bitor op'>|</span>
+    <span class='rubyid_@host_names ivar id'>@host_names</span> <span class='lshft op'>&lt;&lt;</span> <span class='rubyid_address identifier id'>address</span><span class='lbrack token'>[</span><span class='integer val'>2</span><span class='rbrack token'>]</span>
+    <span class='rubyid_@ip_addresses ivar id'>@ip_addresses</span> <span class='lshft op'>&lt;&lt;</span> <span class='rubyid_address identifier id'>address</span><span class='lbrack token'>[</span><span class='integer val'>3</span><span class='rbrack token'>]</span>
+  <span class='rubyid_end end kw'>end</span>
+  <span class='rubyid_@ip_address ivar id'>@ip_address</span> <span class='assign token'>=</span> <span class='rubyid_@ip_addresses ivar id'>@ip_addresses</span><span class='dot token'>.</span><span class='rubyid_first identifier id'>first</span>
+  <span class='rubyid_init_socket identifier id'>init_socket</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="rotate_ip-instance_method">
+    - (<tt>Boolean</tt>) <strong>rotate_ip</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Rotate this server&#39;s IP address to the next one in the IP list</p>
+<p>If this method returns <code>true</code>, it indicates that all IP addresses have been
+used, hinting at the server(s) being unreachable. An appropriate action
+should be taken to inform the user.</p>
+<p>Servers with only one IP address will always cause this method to return
+<code>true</code> and the sockets will not be reinitialized.</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 IP list reached its end. If the list
+contains only one IP address, this method will instantly return
+<code>true</code></p>
+</div>
+    </li>
+</ul>
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+      <li><span class='object_link'><a href="#init_socket-instance_method" title="Server#init_socket (method)">#init_socket</a></span></li>
+  </ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+75
+76
+77
+78
+79
+80
+81
+82
+83
+84</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/servers/server.rb', line 75</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_rotate_ip identifier id'>rotate_ip</span>
+  <span class='rubyid_return return kw'>return</span> <span class='rubyid_true true kw'>true</span> <span class='rubyid_if if_mod kw'>if</span> <span class='rubyid_@ip_addresses ivar id'>@ip_addresses</span><span class='dot token'>.</span><span class='rubyid_size identifier id'>size</span> <span class='eq op'>==</span> <span class='integer val'>1</span>
+  <span class='rubyid_@ip_index ivar id'>@ip_index</span> <span class='assign token'>=</span> <span class='lparen token'>(</span><span class='rubyid_@ip_index ivar id'>@ip_index</span> <span class='plus op'>+</span> <span class='integer val'>1</span><span class='rparen token'>)</span> <span class='mod op'>%</span> <span class='rubyid_@ip_addresses ivar id'>@ip_addresses</span><span class='dot token'>.</span><span class='rubyid_size identifier id'>size</span>
+  <span class='rubyid_@ip_address ivar id'>@ip_address</span> <span class='assign token'>=</span> <span class='rubyid_@ip_addresses ivar id'>@ip_addresses</span><span class='lbrack token'>[</span><span class='rubyid_@ip_index ivar id'>@ip_index</span><span class='rbrack token'>]</span>
+  <span class='rubyid_init_socket identifier id'>init_socket</span>
+  <span class='rubyid_@ip_index ivar id'>@ip_index</span> <span class='eq op'>==</span> <span class='integer val'>0</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+</div>
+    <div id="footer">
+  Generated on Mon Sep  2 07:12:48 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>