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

@@ -0,0 +1,486 @@
+<!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: SteamPacket
+    &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">SteamPacket</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: SteamPacket
+</h1>
+<dl class="box">
+    <dt class="r1">Included in:</dt>
+    <dd class="r1"><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>, <span class='object_link'><a href="A2S_INFO_Packet.html" title="A2S_INFO_Packet (class)">A2S_INFO_Packet</a></span>, <span class='object_link'><a href="A2S_PLAYER_Packet.html" title="A2S_PLAYER_Packet (class)">A2S_PLAYER_Packet</a></span>, <span class='object_link'><a href="A2S_RULES_Packet.html" title="A2S_RULES_Packet (class)">A2S_RULES_Packet</a></span>, <span class='object_link'><a href="A2S_SERVERQUERY_GETCHALLENGE_Packet.html" title="A2S_SERVERQUERY_GETCHALLENGE_Packet (class)">A2S_SERVERQUERY_GETCHALLENGE_Packet</a></span>, <span class='object_link'><a href="C2M_CHECKMD5_Packet.html" title="C2M_CHECKMD5_Packet (class)">C2M_CHECKMD5_Packet</a></span>, <span class='object_link'><a href="M2A_SERVER_BATCH_Packet.html" title="M2A_SERVER_BATCH_Packet (class)">M2A_SERVER_BATCH_Packet</a></span>, <span class='object_link'><a href="M2C_ISVALIDMD5_Packet.html" title="M2C_ISVALIDMD5_Packet (class)">M2C_ISVALIDMD5_Packet</a></span>, <span class='object_link'><a href="M2S_REQUESTRESTART_Packet.html" title="M2S_REQUESTRESTART_Packet (class)">M2S_REQUESTRESTART_Packet</a></span>, <span class='object_link'><a href="RCONGoldSrcRequest.html" title="RCONGoldSrcRequest (class)">RCONGoldSrcRequest</a></span>, <span class='object_link'><a href="RCONGoldSrcResponse.html" title="RCONGoldSrcResponse (class)">RCONGoldSrcResponse</a></span>, <span class='object_link'><a href="RCONPacket.html" title="RCONPacket (module)">RCONPacket</a></span>, <span class='object_link'><a href="S2A_INFO_BasePacket.html" title="S2A_INFO_BasePacket (module)">S2A_INFO_BasePacket</a></span>, <span class='object_link'><a href="S2A_LOGSTRING_Packet.html" title="S2A_LOGSTRING_Packet (class)">S2A_LOGSTRING_Packet</a></span>, <span class='object_link'><a href="S2A_PLAYER_Packet.html" title="S2A_PLAYER_Packet (class)">S2A_PLAYER_Packet</a></span>, <span class='object_link'><a href="S2A_RULES_Packet.html" title="S2A_RULES_Packet (class)">S2A_RULES_Packet</a></span>, <span class='object_link'><a href="S2C_CHALLENGE_Packet.html" title="S2C_CHALLENGE_Packet (class)">S2C_CHALLENGE_Packet</a></span>, <span class='object_link'><a href="S2M_HEARTBEAT2_Packet.html" title="S2M_HEARTBEAT2_Packet (class)">S2M_HEARTBEAT2_Packet</a></span></dd>
+    <dt class="r2 last">Defined in:</dt>
+    <dd class="r2 last">lib/steam/packets/steam_packet.rb</dd>
+</dl>
+<div class="clear"></div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <p>This module implements the basic functionality used by most of the packets
+used in communication with master, Source or GoldSrc servers.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+      <li><span class='object_link'><a href="SteamPacketFactory.html" title="SteamPacketFactory (module)">SteamPacketFactory</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="A2M_GET_SERVERS_BATCH2_HEADER-constant" class="">A2M_GET_SERVERS_BATCH2_HEADER =
+        </dt>
+        <dd><pre class="code"><span class='integer val'>0x31</span>
+</pre></dd>
+        <dt id="A2S_INFO_HEADER-constant" class="">A2S_INFO_HEADER =
+        </dt>
+        <dd><pre class="code"><span class='integer val'>0x54</span>
+</pre></dd>
+        <dt id="A2S_PLAYER_HEADER-constant" class="">A2S_PLAYER_HEADER =
+        </dt>
+        <dd><pre class="code"><span class='integer val'>0x55</span>
+</pre></dd>
+        <dt id="A2S_RULES_HEADER-constant" class="">A2S_RULES_HEADER =
+        </dt>
+        <dd><pre class="code"><span class='integer val'>0x56</span>
+</pre></dd>
+        <dt id="A2S_SERVERQUERY_GETCHALLENGE_HEADER-constant" class="">A2S_SERVERQUERY_GETCHALLENGE_HEADER =
+        </dt>
+        <dd><pre class="code"><span class='integer val'>0x57</span>
+</pre></dd>
+        <dt id="C2M_CHECKMD5_HEADER-constant" class="">C2M_CHECKMD5_HEADER =
+        </dt>
+        <dd><pre class="code"><span class='integer val'>0x4</span><span class='rubyid_D constant id'>D</span>
+</pre></dd>
+        <dt id="M2A_SERVER_BATCH_HEADER-constant" class="">M2A_SERVER_BATCH_HEADER =
+        </dt>
+        <dd><pre class="code"><span class='integer val'>0x66</span>
+</pre></dd>
+        <dt id="M2C_ISVALIDMD5_HEADER-constant" class="">M2C_ISVALIDMD5_HEADER =
+        </dt>
+        <dd><pre class="code"><span class='integer val'>0x4</span><span class='rubyid_E constant id'>E</span>
+</pre></dd>
+        <dt id="M2S_REQUESTRESTART_HEADER-constant" class="">M2S_REQUESTRESTART_HEADER =
+        </dt>
+        <dd><pre class="code"><span class='integer val'>0x4</span><span class='rubyid_F constant id'>F</span>
+</pre></dd>
+        <dt id="RCON_GOLDSRC_CHALLENGE_HEADER-constant" class="">RCON_GOLDSRC_CHALLENGE_HEADER =
+        </dt>
+        <dd><pre class="code"><span class='integer val'>0x63</span>
+</pre></dd>
+        <dt id="RCON_GOLDSRC_NO_CHALLENGE_HEADER-constant" class="">RCON_GOLDSRC_NO_CHALLENGE_HEADER =
+        </dt>
+        <dd><pre class="code"><span class='integer val'>0x39</span>
+</pre></dd>
+        <dt id="RCON_GOLDSRC_RESPONSE_HEADER-constant" class="">RCON_GOLDSRC_RESPONSE_HEADER =
+        </dt>
+        <dd><pre class="code"><span class='integer val'>0x6c</span>
+</pre></dd>
+        <dt id="S2A_INFO_DETAILED_HEADER-constant" class="">S2A_INFO_DETAILED_HEADER =
+        </dt>
+        <dd><pre class="code"><span class='integer val'>0x6</span><span class='rubyid_D constant id'>D</span>
+</pre></dd>
+        <dt id="S2A_INFO2_HEADER-constant" class="">S2A_INFO2_HEADER =
+        </dt>
+        <dd><pre class="code"><span class='integer val'>0x49</span>
+</pre></dd>
+        <dt id="S2A_LOGSTRING_HEADER-constant" class="">S2A_LOGSTRING_HEADER =
+        </dt>
+        <dd><pre class="code"><span class='integer val'>0x52</span>
+</pre></dd>
+        <dt id="S2A_PLAYER_HEADER-constant" class="">S2A_PLAYER_HEADER =
+        </dt>
+        <dd><pre class="code"><span class='integer val'>0x44</span>
+</pre></dd>
+        <dt id="S2A_RULES_HEADER-constant" class="">S2A_RULES_HEADER =
+        </dt>
+        <dd><pre class="code"><span class='integer val'>0x45</span>
+</pre></dd>
+        <dt id="S2C_CONNREJECT_HEADER-constant" class="">S2C_CONNREJECT_HEADER =
+        </dt>
+        <dd><pre class="code"><span class='integer val'>0x39</span>
+</pre></dd>
+        <dt id="S2C_CHALLENGE_HEADER-constant" class="">S2C_CHALLENGE_HEADER =
+        </dt>
+        <dd><pre class="code"><span class='integer val'>0x41</span>
+</pre></dd>
+        <dt id="S2M_HEARTBEAT2_HEADER-constant" class="">S2M_HEARTBEAT2_HEADER =
+        </dt>
+        <dd><pre class="code"><span class='integer val'>0x30</span>
+</pre></dd>
+    </dl>
+    <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)">- (SteamPacket) <strong>initialize</strong>(header_data, content_data = '') </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Creates a new packet object based on the given 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_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="SteamPacket (module)">SteamPacket</a></span></tt>) <strong>initialize</strong>(header_data, content_data = '')
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Creates a new packet object based on the given data</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>header_data</span>
+        <span class='type'>(<tt>Fixnum</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The packet header</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>content_data</span>
+        <span class='type'>(<tt>String</tt>)</span>
+        <em class="default">(defaults to: <tt>''</tt>)</em>
+        &mdash;
+        <div class='inline'><p>The raw data of the packet</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="SteamPacket (module)">SteamPacket</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'><p>a new instance of SteamPacket</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+40
+41
+42
+43</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/packets/steam_packet.rb', line 40</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_header_data identifier id'>header_data</span><span class='comma token'>,</span> <span class='rubyid_content_data identifier id'>content_data</span> <span class='assign token'>=</span> <span class='string val'>''</span><span class='rparen token'>)</span>
+  <span class='rubyid_@content_data ivar id'>@content_data</span> <span class='assign token'>=</span> <span class='rubyid_StringIO constant id'>StringIO</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span> <span class='rubyid_content_data identifier id'>content_data</span><span class='dot token'>.</span><span class='rubyid_to_s identifier id'>to_s</span>
+  <span class='rubyid_@header_data ivar id'>@header_data</span>  <span class='assign token'>=</span> <span class='rubyid_header_data identifier id'>header_data</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 request packet</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+48
+49
+50</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/packets/steam_packet.rb', line 48</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='integer val'>0x</span><span class='rubyid_FF constant id'>FF</span><span class='comma token'>,</span> <span class='integer val'>0x</span><span class='rubyid_FF constant id'>FF</span><span class='comma token'>,</span> <span class='integer val'>0x</span><span class='rubyid_FF constant id'>FF</span><span class='comma token'>,</span> <span class='integer val'>0x</span><span class='rubyid_FF constant id'>FF</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'>'c5a*'</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 Mon Sep  2 07:12:51 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>