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

steam-condenser 1.3.8.1 → 1.3.9

Files changed (476) hide show

data/pkg/steam-condenser-1.3.8.1/doc/SteamPacketFactory.html ADDED Viewed

@@ -0,0 +1,574 @@
+<!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: SteamPacketFactory
+    &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">SteamPacketFactory</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: SteamPacketFactory
+</h1>
+<dl class="box">
+    <dt class="r1 last">Defined in:</dt>
+    <dd class="r1 last">lib/steam/packets/steam_packet_factory.rb</dd>
+</dl>
+<div class="clear"></div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+<p>This module provides functionality to handle raw packet data,
+including
+data split into several UDP / TCP packets and BZIP2 compressed
+data. It&#39;s the
+main utility to transform data bytes into packet
+objects.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+      <li><span class='object_link'><a href="SteamPacket.html" title="SteamPacket (module)">SteamPacket</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>
+      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="#packet_from_data-class_method" title="packet_from_data (class method)">+ (SteamPacket) <strong>packet_from_data</strong>(raw_data) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Creates a new packet object based on the header byte of the given raw data.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#reassemble_packet-class_method" title="reassemble_packet (class method)">+ (SteamPacket) <strong>reassemble_packet</strong>(split_packets, is_compressed = false, packet_checksum = 0) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Reassembles the data of a split and/or compressed packet into a single
+packet object.</p>
+</div></span>
+</li>
+    </ul>
+  <div id="class_method_details" class="method_details_list">
+    <h2>Class Method Details</h2>
+      <div class="method_details first">
+  <h3 class="signature first" id="packet_from_data-class_method">
+    + (<tt><span class='object_link'><a href="SteamPacket.html" title="SteamPacket (module)">SteamPacket</a></span></tt>) <strong>packet_from_data</strong>(raw_data)
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Creates a new packet object based on the header byte of the given raw data</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>raw_data</span>
+        <span class='type'>(<tt>String</tt>)</span>
+        &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="SteamPacket.html" title="SteamPacket (module)">SteamPacket</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>The packet object generated from the packet data</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 the packet header is not recognized</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+38
+39
+40
+41
+42
+43
+44
+45
+46
+47
+48
+49
+50
+51
+52
+53
+54
+55
+56
+57
+58
+59
+60
+61
+62
+63
+64
+65
+66
+67
+68
+69
+70
+71
+72
+73
+74
+75
+76
+77
+78</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/packets/steam_packet_factory.rb', line 38</span>
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_packet_from_data'>packet_from_data</span><span class='lparen'>(</span><span class='id identifier rubyid_raw_data'>raw_data</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_header'>header</span> <span class='op'>=</span> <span class='id identifier rubyid_raw_data'>raw_data</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_ord'>ord</span>
+  <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='id identifier rubyid_raw_data'>raw_data</span><span class='lbracket'>[</span><span class='int'>1</span><span class='op'>..</span><span class='op'>-</span><span class='int'>1</span><span class='rbracket'>]</span>
+  <span class='kw'>case</span> <span class='id identifier rubyid_header'>header</span>
+    <span class='kw'>when</span> <span class='const'>SteamPacket</span><span class='op'>::</span><span class='const'>S2A_INFO_DETAILED_HEADER</span>
+      <span class='kw'>return</span> <span class='const'>S2A_INFO_DETAILED_Packet</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
+    <span class='kw'>when</span> <span class='const'>SteamPacket</span><span class='op'>::</span><span class='const'>A2S_INFO_HEADER</span>
+      <span class='kw'>return</span> <span class='const'>A2S_INFO_Packet</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
+    <span class='kw'>when</span> <span class='const'>SteamPacket</span><span class='op'>::</span><span class='const'>S2A_INFO2_HEADER</span>
+      <span class='kw'>return</span> <span class='const'>S2A_INFO2_Packet</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
+    <span class='kw'>when</span> <span class='const'>SteamPacket</span><span class='op'>::</span><span class='const'>A2S_PLAYER_HEADER</span>
+      <span class='kw'>return</span> <span class='const'>A2S_PLAYER_Packet</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
+    <span class='kw'>when</span> <span class='const'>SteamPacket</span><span class='op'>::</span><span class='const'>S2A_PLAYER_HEADER</span>
+      <span class='kw'>return</span> <span class='const'>S2A_PLAYER_Packet</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
+    <span class='kw'>when</span> <span class='const'>SteamPacket</span><span class='op'>::</span><span class='const'>A2S_RULES_HEADER</span>
+      <span class='kw'>return</span> <span class='const'>A2S_RULES_Packet</span>
+    <span class='kw'>when</span> <span class='const'>SteamPacket</span><span class='op'>::</span><span class='const'>S2A_RULES_HEADER</span>
+      <span class='kw'>return</span> <span class='const'>S2A_RULES_Packet</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
+    <span class='kw'>when</span> <span class='const'>SteamPacket</span><span class='op'>::</span><span class='const'>A2S_SERVERQUERY_GETCHALLENGE_HEADER</span>
+      <span class='kw'>return</span> <span class='const'>A2S_SERVERQUERY_GETCHALLENGE_Packet</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
+    <span class='kw'>when</span> <span class='const'>SteamPacket</span><span class='op'>::</span><span class='const'>S2C_CHALLENGE_HEADER</span>
+      <span class='kw'>return</span> <span class='const'>S2C_CHALLENGE_Packet</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
+    <span class='kw'>when</span> <span class='const'>SteamPacket</span><span class='op'>::</span><span class='const'>A2M_GET_SERVERS_BATCH2_HEADER</span>
+      <span class='kw'>return</span> <span class='const'>A2M_GET_SERVERS_BATCH2_Packet</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
+    <span class='kw'>when</span> <span class='const'>SteamPacket</span><span class='op'>::</span><span class='const'>M2A_SERVER_BATCH_HEADER</span>
+      <span class='kw'>return</span> <span class='const'>M2A_SERVER_BATCH_Packet</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
+    <span class='kw'>when</span> <span class='const'>SteamPacket</span><span class='op'>::</span><span class='const'>M2C_ISVALIDMD5_HEADER</span>
+      <span class='kw'>return</span> <span class='const'>M2C_ISVALIDMD5_Packet</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
+    <span class='kw'>when</span> <span class='const'>SteamPacket</span><span class='op'>::</span><span class='const'>M2S_REQUESTRESTART_HEADER</span>
+      <span class='kw'>return</span> <span class='const'>M2S_REQUESTRESTART_Packet</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
+    <span class='kw'>when</span> <span class='const'>SteamPacket</span><span class='op'>::</span><span class='const'>RCON_GOLDSRC_CHALLENGE_HEADER</span><span class='comma'>,</span>
+         <span class='const'>SteamPacket</span><span class='op'>::</span><span class='const'>RCON_GOLDSRC_NO_CHALLENGE_HEADER</span><span class='comma'>,</span>
+         <span class='const'>SteamPacket</span><span class='op'>::</span><span class='const'>RCON_GOLDSRC_RESPONSE_HEADER</span>
+      <span class='kw'>return</span> <span class='const'>RCONGoldSrcResponse</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
+    <span class='kw'>when</span> <span class='const'>SteamPacket</span><span class='op'>::</span><span class='const'>S2A_LOGSTRING_HEADER</span>
+      <span class='kw'>return</span> <span class='const'>S2A_LOGSTRING_Packet</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
+    <span class='kw'>else</span>
+      <span class='id identifier rubyid_raise'>raise</span> <span class='const'>PacketFormatError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Unknown packet with header 0x</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_header'>header</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='lparen'>(</span><span class='int'>16</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_content'> received.</span><span class='tstring_end'>&quot;</span></span>
+  <span class='kw'>end</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="reassemble_packet-class_method">
+    + (<tt><span class='object_link'><a href="SteamPacket.html" title="SteamPacket (module)">SteamPacket</a></span></tt>) <strong>reassemble_packet</strong>(split_packets, is_compressed = false, packet_checksum = 0)
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Reassembles the data of a split and/or compressed packet into a
+single
+packet object</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>split_packets</span>
+        <span class='type'>(<tt>Array&lt;String&gt;</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>An array of packet data</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>is_compressed</span>
+        <span class='type'>(<tt>Boolean</tt>)</span>
+        <em class="default">(defaults to: <tt>false</tt>)</em>
+        &mdash;
+        <div class='inline'>
+<p>whether the data of this packet is
+compressed</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>packet_checksum</span>
+        <span class='type'>(<tt>Fixnum</tt>)</span>
+        <em class="default">(defaults to: <tt>0</tt>)</em>
+        &mdash;
+        <div class='inline'>
+<p>The CRC32 checksum of the decompressed
+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="SteamPacket.html" title="SteamPacket (module)">SteamPacket</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>The reassembled packet</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 the bz2 gem is not installed</p>
+</div>
+    </li>
+    <li>
+        <span class='type'>(<tt><span class='object_link'><a href="PacketFormatError.html" title="PacketFormatError (class)">PacketFormatError</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>if the calculated CRC32 checksum does not match
+the expected value</p>
+</div>
+    </li>
+</ul>
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+      <li><span class='object_link'><a href="#packet_from_data-class_method" title="SteamPacketFactory.packet_from_data (method)">packet_from_data</a></span></li>
+  </ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+93
+94
+95
+96
+97
+98
+99
+100
+101
+102
+103
+104
+105
+106
+107
+108
+109
+110
+111</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/packets/steam_packet_factory.rb', line 93</span>
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_reassemble_packet'>reassemble_packet</span><span class='lparen'>(</span><span class='id identifier rubyid_split_packets'>split_packets</span><span class='comma'>,</span> <span class='id identifier rubyid_is_compressed'>is_compressed</span> <span class='op'>=</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='id identifier rubyid_packet_checksum'>packet_checksum</span> <span class='op'>=</span> <span class='int'>0</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_packet_data'>packet_data</span> <span class='op'>=</span> <span class='id identifier rubyid_split_packets'>split_packets</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span>
+  <span class='kw'>if</span> <span class='id identifier rubyid_is_compressed'>is_compressed</span>
+    <span class='kw'>begin</span>
+      <span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>bzip2-ruby</span><span class='tstring_end'>&#39;</span></span>
+    <span class='kw'>rescue</span> <span class='const'>LoadError</span>
+      <span class='id identifier rubyid_raise'>raise</span> <span class='const'>SteamCondenserError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>The &quot;bzip2-ruby&quot; gem is not installed. Please install it, if you want to query Source servers sending compressed packets.</span><span class='tstring_end'>&#39;</span></span>
+    <span class='kw'>end</span>
+    <span class='id identifier rubyid_packet_data'>packet_data</span> <span class='op'>=</span> <span class='const'>Bzip2</span><span class='period'>.</span><span class='id identifier rubyid_decompress'>decompress</span> <span class='id identifier rubyid_packet_data'>packet_data</span>
+    <span class='kw'>unless</span> <span class='const'>Zlib</span><span class='period'>.</span><span class='id identifier rubyid_crc32'>crc32</span><span class='lparen'>(</span><span class='id identifier rubyid_packet_data'>packet_data</span><span class='rparen'>)</span> <span class='op'>==</span> <span class='id identifier rubyid_packet_checksum'>packet_checksum</span>
+      <span class='id identifier rubyid_raise'>raise</span> <span class='const'>PacketFormatError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>CRC32 checksum mismatch of uncompressed packet data.</span><span class='tstring_end'>&#39;</span></span>
+    <span class='kw'>end</span>
+  <span class='kw'>end</span>
+  <span class='id identifier rubyid_packet_from_data'>packet_from_data</span> <span class='id identifier rubyid_packet_data'>packet_data</span><span class='lbracket'>[</span><span class='int'>4</span><span class='op'>..</span><span class='op'>-</span><span class='int'>1</span><span class='rbracket'>]</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+</div>
+    <div id="footer">
+  Generated on Tue Jul 22 07:10:17 2014 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.7.3 (ruby-2.0.0).
+</div>
+  </body>
+</html>