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/SteamCondenser/Servers/GoldSrcServer.html ADDED Viewed

@@ -0,0 +1,738 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Class: SteamCondenser::Servers::GoldSrcServer
+    &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'><span class='object_link'><a href="../../SteamCondenser.html" title="SteamCondenser (module)">SteamCondenser</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Servers.html" title="SteamCondenser::Servers (module)">Servers</a></span></span>
+     &raquo;
+    <span class="title">GoldSrcServer</span>
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+      <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="../../class_list.html">
+      Class List
+    </a>
+    <a class="full_list_link" id="method_list_link"
+        href="../../method_list.html">
+      Method List
+    </a>
+    <a class="full_list_link" id="file_list_link"
+        href="../../file_list.html">
+      File List
+    </a>
+</div>
+      <div class="clear"></div>
+    </div>
+    <iframe id="search_frame"></iframe>
+    <div id="content"><h1>Class: SteamCondenser::Servers::GoldSrcServer
+</h1>
+<dl class="box">
+    <dt class="r1">Inherits:</dt>
+    <dd class="r1">
+      <span class="inheritName">Object</span>
+        <ul class="fullTree">
+          <li>Object</li>
+            <li class="next">SteamCondenser::Servers::GoldSrcServer</li>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      </dd>
+      <dt class="r2">Includes:</dt>
+      <dd class="r2"><span class='object_link'><a href="GameServer.html" title="SteamCondenser::Servers::GameServer (module)">GameServer</a></span></dd>
+    <dt class="r1 last">Defined in:</dt>
+    <dd class="r1 last">lib/steam-condenser/servers/goldsrc_server.rb</dd>
+</dl>
+<div class="clear"></div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <p>This class represents a GoldSrc game server and can be used to query
+information about and remotely execute commands via RCON on the server</p>
+<p>A GoldSrc game server is an instance of the Half-Life Dedicated Server
+(HLDS) running games using Valve&#39;s GoldSrc engine, like Half-Life
+Deathmatch, Counter-Strike 1.6 or Team Fortress Classic.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+      <li><span class='object_link'><a href="SourceServer.html" title="SteamCondenser::Servers::SourceServer (class)">SourceServer</a></span></li>
+  </ul>
+<p class="tag_title">Author:</p>
+<ul class="author">
+    <li>
+        <div class='inline'><p>Sebastian Staudt</p>
+</div>
+    </li>
+</ul>
+</div>
+  <h2>Instance Attribute Summary</h2>
+  <h3 class="inherited">Attributes included from <span class='object_link'><a href="BaseServer.html" title="SteamCondenser::Servers::BaseServer (module)">BaseServer</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="BaseServer.html#host_names-instance_method" title="SteamCondenser::Servers::BaseServer#host_names (method)">#host_names</a></span>, <span class='object_link'><a href="BaseServer.html#ip_addresses-instance_method" title="SteamCondenser::Servers::BaseServer#ip_addresses (method)">#ip_addresses</a></span></p>
+    <h2>
+      Class Method Summary
+      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+    </h2>
+    <ul class="summary">
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#master-class_method" title="master (class method)">+ (MasterServer) <strong>master</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Returns a master server instance for the default master server for GoldSrc games.</p>
+</div></span>
+</li>
+    </ul>
+    <h2>
+      Instance Method Summary
+      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+    </h2>
+    <ul class="summary">
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#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 GoldSrc server.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#initialize-instance_method" title="#initialize (instance method)">- (GoldSrcServer) <strong>initialize</strong>(address, port = 27015, is_hltv = false) </a>
+  </span>
+    <span class="note title constructor">constructor</span>
+    <span class="summary_desc"><div class='inline'><p>Creates a new instance of a GoldSrc server object.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#rcon_auth-instance_method" title="#rcon_auth (instance method)">- (true) <strong>rcon_auth</strong>(password) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Saves the password for authenticating the RCON communication with the server.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#rcon_exec-instance_method" title="#rcon_exec (instance method)">- (String) <strong>rcon_exec</strong>(command) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Remotely executes a command on the server via RCON.</p>
+</div></span>
+</li>
+    </ul>
+  <h3 class="inherited">Methods included from <span class='object_link'><a href="GameServer.html" title="SteamCondenser::Servers::GameServer (module)">GameServer</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="GameServer.html#handle_response_for_request-instance_method" title="SteamCondenser::Servers::GameServer#handle_response_for_request (method)">#handle_response_for_request</a></span>, <span class='object_link'><a href="GameServer.html#init-instance_method" title="SteamCondenser::Servers::GameServer#init (method)">#init</a></span>, <span class='object_link'><a href="GameServer.html#ping-instance_method" title="SteamCondenser::Servers::GameServer#ping (method)">#ping</a></span>, <span class='object_link'><a href="GameServer.html#player_status_attributes-class_method" title="SteamCondenser::Servers::GameServer.player_status_attributes (method)">player_status_attributes</a></span>, <span class='object_link'><a href="GameServer.html#players-instance_method" title="SteamCondenser::Servers::GameServer#players (method)">#players</a></span>, <span class='object_link'><a href="GameServer.html#rcon_authenticated%3F-instance_method" title="SteamCondenser::Servers::GameServer#rcon_authenticated? (method)">#rcon_authenticated?</a></span>, <span class='object_link'><a href="GameServer.html#reply-instance_method" title="SteamCondenser::Servers::GameServer#reply (method)">#reply</a></span>, <span class='object_link'><a href="GameServer.html#rules-instance_method" title="SteamCondenser::Servers::GameServer#rules (method)">#rules</a></span>, <span class='object_link'><a href="GameServer.html#send_request-instance_method" title="SteamCondenser::Servers::GameServer#send_request (method)">#send_request</a></span>, <span class='object_link'><a href="GameServer.html#server_info-instance_method" title="SteamCondenser::Servers::GameServer#server_info (method)">#server_info</a></span>, <span class='object_link'><a href="GameServer.html#split_player_status-class_method" title="SteamCondenser::Servers::GameServer.split_player_status (method)">split_player_status</a></span>, <span class='object_link'><a href="GameServer.html#to_s-instance_method" title="SteamCondenser::Servers::GameServer#to_s (method)">#to_s</a></span>, <span class='object_link'><a href="GameServer.html#update_challenge_number-instance_method" title="SteamCondenser::Servers::GameServer#update_challenge_number (method)">#update_challenge_number</a></span>, <span class='object_link'><a href="GameServer.html#update_ping-instance_method" title="SteamCondenser::Servers::GameServer#update_ping (method)">#update_ping</a></span>, <span class='object_link'><a href="GameServer.html#update_players-instance_method" title="SteamCondenser::Servers::GameServer#update_players (method)">#update_players</a></span>, <span class='object_link'><a href="GameServer.html#update_rules-instance_method" title="SteamCondenser::Servers::GameServer#update_rules (method)">#update_rules</a></span>, <span class='object_link'><a href="GameServer.html#update_server_info-instance_method" title="SteamCondenser::Servers::GameServer#update_server_info (method)">#update_server_info</a></span></p>
+  <h3 class="inherited">Methods included from <span class='object_link'><a href="BaseServer.html" title="SteamCondenser::Servers::BaseServer (module)">BaseServer</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="BaseServer.html#disconnect-instance_method" title="SteamCondenser::Servers::BaseServer#disconnect (method)">#disconnect</a></span>, <span class='object_link'><a href="BaseServer.html#failsafe-instance_method" title="SteamCondenser::Servers::BaseServer#failsafe (method)">#failsafe</a></span>, <span class='object_link'><a href="BaseServer.html#rotate_ip-instance_method" title="SteamCondenser::Servers::BaseServer#rotate_ip (method)">#rotate_ip</a></span></p>
+<div id="constructor_details" class="method_details_list">
+  <h2>Constructor Details</h2>
+    <div class="method_details first">
+  <h3 class="signature first" id="initialize-instance_method">
+    - (<tt><span class='object_link'><a href="" title="SteamCondenser::Servers::GoldSrcServer (class)">GoldSrcServer</a></span></tt>) <strong>initialize</strong>(address, port = 27015, is_hltv = false)
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Creates a new instance of a GoldSrc 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>
+    <li>
+        <span class='name'>is_hltv</span>
+        <span class='type'>(<tt>Boolean</tt>)</span>
+        <em class="default">(defaults to: <tt>false</tt>)</em>
+        &mdash;
+        <div class='inline'><p>HLTV servers need special treatment, so this
+is used to determine if the server is a HLTV 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="../Error.html" title="SteamCondenser::Error (class)">Error</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'><p>if an host name cannot be resolved</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+44
+45
+46
+47
+48</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/servers/goldsrc_server.rb', line 44</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='rubyid_address identifier id'>address</span><span class='comma token'>,</span> <span class='rubyid_port identifier id'>port</span> <span class='assign token'>=</span> <span class='integer val'>27015</span><span class='comma token'>,</span> <span class='rubyid_is_hltv identifier id'>is_hltv</span> <span class='assign token'>=</span> <span class='rubyid_false false kw'>false</span><span class='rparen token'>)</span>
+  <span class='rubyid_super super kw'>super</span> <span class='rubyid_address identifier id'>address</span><span class='comma token'>,</span> <span class='rubyid_port identifier id'>port</span>
+  <span class='rubyid_@is_hltv ivar id'>@is_hltv</span> <span class='assign token'>=</span> <span class='rubyid_is_hltv identifier id'>is_hltv</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+</div>
+  <div id="class_method_details" class="method_details_list">
+    <h2>Class Method Details</h2>
+      <div class="method_details first">
+  <h3 class="signature first" id="master-class_method">
+    + (<tt><span class='object_link'><a href="MasterServer.html" title="SteamCondenser::Servers::MasterServer (class)">MasterServer</a></span></tt>) <strong>master</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns a master server instance for the default master server for
+GoldSrc games</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt><span class='object_link'><a href="MasterServer.html" title="SteamCondenser::Servers::MasterServer (class)">MasterServer</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'><p>The GoldSrc master server</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+31
+32
+33</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/servers/goldsrc_server.rb', line 31</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_self self kw'>self</span><span class='dot token'>.</span><span class='rubyid_master identifier id'>master</span>
+  <span class='rubyid_MasterServer constant id'>MasterServer</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span> <span class='mult op'>*</span><span class='rubyid_MasterServer constant id'>MasterServer</span><span class='colon2 op'>::</span><span class='rubyid_GOLDSRC_MASTER_SERVER constant id'>GOLDSRC_MASTER_SERVER</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+  <div id="instance_method_details" class="method_details_list">
+    <h2>Instance Method Details</h2>
+      <div class="method_details first">
+  <h3 class="signature first" id="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 GoldSrc server</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+      <li>GoldSrcSocket</li>
+  </ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+53
+54
+55</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/servers/goldsrc_server.rb', line 53</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_Sockets constant id'>Sockets</span><span class='colon2 op'>::</span><span class='rubyid_GoldSrcSocket constant id'>GoldSrcSocket</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='comma token'>,</span> <span class='rubyid_@is_hltv ivar id'>@is_hltv</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="rcon_auth-instance_method">
+    - (<tt>true</tt>) <strong>rcon_auth</strong>(password)
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Saves the password for authenticating the 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>true</tt>)</span>
+        &mdash;
+        <div class='inline'><p>GoldSrc&#39;s RCON does not preauthenticate connections so
+this method always returns <code>true</code></p>
+</div>
+    </li>
+</ul>
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+      <li><span class='object_link'><a href="#rcon_exec-instance_method" title="SteamCondenser::Servers::GoldSrcServer#rcon_exec (method)">#rcon_exec</a></span></li>
+  </ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+64
+65
+66
+67</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/servers/goldsrc_server.rb', line 64</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_rcon_auth identifier id'>rcon_auth</span><span class='lparen token'>(</span><span class='rubyid_password identifier id'>password</span><span class='rparen token'>)</span>
+  <span class='rubyid_@rcon_password ivar id'>@rcon_password</span> <span class='assign token'>=</span> <span class='rubyid_password identifier id'>password</span>
+  <span class='rubyid_true true kw'>true</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="rcon_exec-instance_method">
+    - (<tt>String</tt>) <strong>rcon_exec</strong>(command)
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Remotely executes a command on the server via RCON</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>command</span>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The command to execute on the server via RCON</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The output of the executed command</p>
+</div>
+    </li>
+</ul>
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+      <li><span class='object_link'><a href="#rcon_auth-instance_method" title="SteamCondenser::Servers::GoldSrcServer#rcon_auth (method)">#rcon_auth</a></span></li>
+  </ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+74
+75
+76</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/servers/goldsrc_server.rb', line 74</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_rcon_exec identifier id'>rcon_exec</span><span class='lparen token'>(</span><span class='rubyid_command identifier id'>command</span><span class='rparen token'>)</span>
+  <span class='rubyid_@socket ivar id'>@socket</span><span class='dot token'>.</span><span class='rubyid_rcon_exec identifier id'>rcon_exec</span><span class='lparen token'>(</span><span class='rubyid_@rcon_password ivar id'>@rcon_password</span><span class='comma token'>,</span> <span class='rubyid_command identifier id'>command</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='rubyid_strip identifier id'>strip</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+</div>
+    <div id="footer">
+  Generated on Wed Aug 14 21:47:53 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>