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

steam-condenser 1.3.9 → 1.3.10

Files changed (958) hide show

data/pkg/steam-condenser-1.3.9/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Packets/RCON/BasePacket.html ADDED

@@ -0,0 +1,564 @@
+<!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: SteamCondenser::Servers::Packets::RCON::BasePacket
+    &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 (B)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../../../../SteamCondenser.html" title="SteamCondenser (module)">SteamCondenser</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../../Servers.html" title="SteamCondenser::Servers (module)">Servers</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Packets.html" title="SteamCondenser::Servers::Packets (module)">Packets</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../RCON.html" title="SteamCondenser::Servers::Packets::RCON (module)">RCON</a></span></span>
+     &raquo;
+    <span class="title">BasePacket</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: SteamCondenser::Servers::Packets::RCON::BasePacket
+</h1>
+<dl class="box">
+      <dt class="r1">Includes:</dt>
+      <dd class="r1"><span class='object_link'><a href="../BasePacket.html" title="SteamCondenser::Servers::Packets::BasePacket (module)">BasePacket</a></span></dd>
+    <dt class="r2">Included in:</dt>
+    <dd class="r2"><span class='object_link'><a href="RCONAuthRequest.html" title="SteamCondenser::Servers::Packets::RCON::RCONAuthRequest (class)">RCONAuthRequest</a></span>, <span class='object_link'><a href="RCONAuthResponse.html" title="SteamCondenser::Servers::Packets::RCON::RCONAuthResponse (class)">RCONAuthResponse</a></span>, <span class='object_link'><a href="RCONExecRequest.html" title="SteamCondenser::Servers::Packets::RCON::RCONExecRequest (class)">RCONExecRequest</a></span>, <span class='object_link'><a href="RCONExecResponse.html" title="SteamCondenser::Servers::Packets::RCON::RCONExecResponse (class)">RCONExecResponse</a></span>, <span class='object_link'><a href="RCONTerminator.html" title="SteamCondenser::Servers::Packets::RCON::RCONTerminator (class)">RCONTerminator</a></span></dd>
+    <dt class="r1 last">Defined in:</dt>
+    <dd class="r1 last">lib/steam-condenser/servers/packets/rcon/base_packet.rb</dd>
+</dl>
+<div class="clear"></div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <p>This module is included by all classes representing a packet used by
+Source&#39;s RCON protocol</p>
+<p>It provides a basic implementation for initializing and serializing such a
+packet.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+      <li><span class='object_link'><a href="RCONPacketFactory.html" title="SteamCondenser::Servers::Packets::RCON::RCONPacketFactory (module)">RCONPacketFactory</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>Constant Summary</h2>
+    <dl class="constants">
+        <dt id="SERVERDATA_AUTH-constant" class="">SERVERDATA_AUTH =
+          <div class="docstring">
+  <div class="discussion">
+    <p>Header for authentication requests</p>
+  </div>
+</div>
+<div class="tags">
+</div>
+        </dt>
+        <dd><pre class="code"><span class='integer val'>3</span>
+</pre></dd>
+        <dt id="SERVERDATA_AUTH_RESPONSE-constant" class="">SERVERDATA_AUTH_RESPONSE =
+          <div class="docstring">
+  <div class="discussion">
+    <p>Header for replies to authentication attempts</p>
+  </div>
+</div>
+<div class="tags">
+</div>
+        </dt>
+        <dd><pre class="code"><span class='integer val'>2</span>
+</pre></dd>
+        <dt id="SERVERDATA_EXECCOMMAND-constant" class="">SERVERDATA_EXECCOMMAND =
+          <div class="docstring">
+  <div class="discussion">
+    <p>Header for command execution requests</p>
+  </div>
+</div>
+<div class="tags">
+</div>
+        </dt>
+        <dd><pre class="code"><span class='integer val'>2</span>
+</pre></dd>
+        <dt id="SERVERDATA_RESPONSE_VALUE-constant" class="">SERVERDATA_RESPONSE_VALUE =
+          <div class="docstring">
+  <div class="discussion">
+    <p>Header for packets with the output of a command execution</p>
+  </div>
+</div>
+<div class="tags">
+</div>
+        </dt>
+        <dd><pre class="code"><span class='integer val'>0</span>
+</pre></dd>
+    </dl>
+  <h3 class="inherited">Constants included
+     from <span class='object_link'><a href="../BasePacket.html" title="SteamCondenser::Servers::Packets::BasePacket (module)">BasePacket</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="../BasePacket.html#A2M_GET_SERVERS_BATCH2_HEADER-constant" title="SteamCondenser::Servers::Packets::BasePacket::A2M_GET_SERVERS_BATCH2_HEADER (constant)">BasePacket::A2M_GET_SERVERS_BATCH2_HEADER</a></span>, <span class='object_link'><a href="../BasePacket.html#A2S_INFO_HEADER-constant" title="SteamCondenser::Servers::Packets::BasePacket::A2S_INFO_HEADER (constant)">BasePacket::A2S_INFO_HEADER</a></span>, <span class='object_link'><a href="../BasePacket.html#A2S_PLAYER_HEADER-constant" title="SteamCondenser::Servers::Packets::BasePacket::A2S_PLAYER_HEADER (constant)">BasePacket::A2S_PLAYER_HEADER</a></span>, <span class='object_link'><a href="../BasePacket.html#A2S_RULES_HEADER-constant" title="SteamCondenser::Servers::Packets::BasePacket::A2S_RULES_HEADER (constant)">BasePacket::A2S_RULES_HEADER</a></span>, <span class='object_link'><a href="../BasePacket.html#A2S_SERVERQUERY_GETCHALLENGE_HEADER-constant" title="SteamCondenser::Servers::Packets::BasePacket::A2S_SERVERQUERY_GETCHALLENGE_HEADER (constant)">BasePacket::A2S_SERVERQUERY_GETCHALLENGE_HEADER</a></span>, <span class='object_link'><a href="../BasePacket.html#C2M_CHECKMD5_HEADER-constant" title="SteamCondenser::Servers::Packets::BasePacket::C2M_CHECKMD5_HEADER (constant)">BasePacket::C2M_CHECKMD5_HEADER</a></span>, <span class='object_link'><a href="../BasePacket.html#M2A_SERVER_BATCH_HEADER-constant" title="SteamCondenser::Servers::Packets::BasePacket::M2A_SERVER_BATCH_HEADER (constant)">BasePacket::M2A_SERVER_BATCH_HEADER</a></span>, <span class='object_link'><a href="../BasePacket.html#RCON_GOLDSRC_CHALLENGE_HEADER-constant" title="SteamCondenser::Servers::Packets::BasePacket::RCON_GOLDSRC_CHALLENGE_HEADER (constant)">BasePacket::RCON_GOLDSRC_CHALLENGE_HEADER</a></span>, <span class='object_link'><a href="../BasePacket.html#RCON_GOLDSRC_NO_CHALLENGE_HEADER-constant" title="SteamCondenser::Servers::Packets::BasePacket::RCON_GOLDSRC_NO_CHALLENGE_HEADER (constant)">BasePacket::RCON_GOLDSRC_NO_CHALLENGE_HEADER</a></span>, <span class='object_link'><a href="../BasePacket.html#RCON_GOLDSRC_RESPONSE_HEADER-constant" title="SteamCondenser::Servers::Packets::BasePacket::RCON_GOLDSRC_RESPONSE_HEADER (constant)">BasePacket::RCON_GOLDSRC_RESPONSE_HEADER</a></span>, <span class='object_link'><a href="../BasePacket.html#S2A_INFO2_HEADER-constant" title="SteamCondenser::Servers::Packets::BasePacket::S2A_INFO2_HEADER (constant)">BasePacket::S2A_INFO2_HEADER</a></span>, <span class='object_link'><a href="../BasePacket.html#S2A_INFO_DETAILED_HEADER-constant" title="SteamCondenser::Servers::Packets::BasePacket::S2A_INFO_DETAILED_HEADER (constant)">BasePacket::S2A_INFO_DETAILED_HEADER</a></span>, <span class='object_link'><a href="../BasePacket.html#S2A_PLAYER_HEADER-constant" title="SteamCondenser::Servers::Packets::BasePacket::S2A_PLAYER_HEADER (constant)">BasePacket::S2A_PLAYER_HEADER</a></span>, <span class='object_link'><a href="../BasePacket.html#S2A_RULES_HEADER-constant" title="SteamCondenser::Servers::Packets::BasePacket::S2A_RULES_HEADER (constant)">BasePacket::S2A_RULES_HEADER</a></span>, <span class='object_link'><a href="../BasePacket.html#S2C_CHALLENGE_HEADER-constant" title="SteamCondenser::Servers::Packets::BasePacket::S2C_CHALLENGE_HEADER (constant)">BasePacket::S2C_CHALLENGE_HEADER</a></span>, <span class='object_link'><a href="../BasePacket.html#S2C_CONNREJECT_HEADER-constant" title="SteamCondenser::Servers::Packets::BasePacket::S2C_CONNREJECT_HEADER (constant)">BasePacket::S2C_CONNREJECT_HEADER</a></span></p>
+  <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="#request_id-instance_method" title="#request_id (instance method)">- (Fixnum) <strong>request_id</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Returns the request ID used to identify the RCON communication.</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="#initialize-instance_method" title="#initialize (instance method)">- (BasePacket) <strong>initialize</strong>(request_id, rcon_header, rcon_data) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Creates a new RCON packet object with the given request ID, type and content data.</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 the raw data representing this packet.</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="request_id-instance_method">
+    - (<tt>Fixnum</tt>) <strong>request_id</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the request ID used to identify the RCON communication</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 request ID used to identify the RCON communication</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+39
+40
+41</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/servers/packets/rcon/base_packet.rb', line 39</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_request_id identifier id'>request_id</span>
+  <span class='rubyid_@request_id ivar id'>@request_id</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="initialize-instance_method">
+    - (<tt><span class='object_link'><a href="" title="SteamCondenser::Servers::Packets::RCON::BasePacket (module)">BasePacket</a></span></tt>) <strong>initialize</strong>(request_id, rcon_header, rcon_data)
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Creates a new RCON packet object with the given request ID, type and
+content data</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>request_id</span>
+        <span class='type'>(<tt>Fixnum</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The request ID for the current RCON
+communication</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>rcon_header</span>
+        <span class='type'>(<tt>Fixnum</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The header for the packet type</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>rcon_data</span>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The raw packet data</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="SteamCondenser::Servers::Packets::RCON::BasePacket (module)">BasePacket</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'><p>a new instance of BasePacket</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+48
+49
+50
+51
+52</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/servers/packets/rcon/base_packet.rb', line 48</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_request_id identifier id'>request_id</span><span class='comma token'>,</span> <span class='rubyid_rcon_header identifier id'>rcon_header</span><span class='comma token'>,</span> <span class='rubyid_rcon_data identifier id'>rcon_data</span><span class='rparen token'>)</span>
+  <span class='rubyid_super super kw'>super</span> <span class='rubyid_rcon_header identifier id'>rcon_header</span><span class='comma token'>,</span> <span class='dstring node'>&quot;#{rcon_data}\0\0&quot;</span>
+  <span class='rubyid_@request_id ivar id'>@request_id</span> <span class='assign token'>=</span> <span class='rubyid_request_id identifier id'>request_id</span>
+<span class='rubyid_end end 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 the raw data representing this packet</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>A string containing the raw data of this RCON packet</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+57
+58
+59</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/servers/packets/rcon/base_packet.rb', line 57</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_to_s identifier id'>to_s</span>
+  <span class='lbrack token'>[</span><span class='rubyid_@content_data ivar id'>@content_data</span><span class='dot token'>.</span><span class='rubyid_length identifier id'>length</span> <span class='plus op'>+</span> <span class='integer val'>8</span><span class='comma token'>,</span> <span class='rubyid_@request_id ivar id'>@request_id</span><span class='comma token'>,</span> <span class='rubyid_@header_data ivar id'>@header_data</span><span class='comma token'>,</span> <span class='rubyid_@content_data ivar id'>@content_data</span><span class='dot token'>.</span><span class='rubyid_string identifier id'>string</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_pack identifier id'>pack</span><span class='lparen token'>(</span><span class='string val'>'V3a*'</span><span class='rparen token'>)</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:44 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>