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

steam-condenser 1.3.8 → 1.3.8.1

Files changed (1273) hide show

data/pkg/steam-condenser-1.3.7/doc/SteamSocket.html DELETED

@@ -1,702 +0,0 @@
-<!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: SteamSocket
-    &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">SteamSocket</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: SteamSocket
-</h1>
-<dl class="box">
-    <dt class="r1">Included in:</dt>
-    <dd class="r1"><span class='object_link'><a href="GoldSrcSocket.html" title="GoldSrcSocket (class)">GoldSrcSocket</a></span>, <span class='object_link'><a href="MasterServerSocket.html" title="MasterServerSocket (class)">MasterServerSocket</a></span>, <span class='object_link'><a href="RCONSocket.html" title="RCONSocket (class)">RCONSocket</a></span>, <span class='object_link'><a href="SourceSocket.html" title="SourceSocket (class)">SourceSocket</a></span></dd>
-    <dt class="r2 last">Defined in:</dt>
-    <dd class="r2 last">lib/steam/sockets/steam_socket.rb</dd>
-</dl>
-<div class="clear"></div>
-<h2>Overview</h2><div class="docstring">
-  <div class="discussion">
-    <p>This module implements common functionality for sockets used to connect to
-game and master servers</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>Constant Summary</h2>
-    <dl class="constants">
-        <dt id="timeout-classvariable" class="">@@timeout =
-          <div class="docstring">
-  <div class="discussion">
-    <p>The default socket timeout</p>
-  </div>
-</div>
-<div class="tags">
-</div>
-        </dt>
-        <dd><pre class="code"><span class='int'>1000</span></pre></dd>
-    </dl>
-    <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="#timeout%3D-class_method" title="timeout= (class method)">+ (Object) <strong>timeout=</strong>(timeout) </a>
-  </span>
-    <span class="summary_desc"><div class='inline'><p>Sets the timeout for socket operations.</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="#close-instance_method" title="#close (instance method)">- (Object) <strong>close</strong> </a>
-  </span>
-    <span class="summary_desc"><div class='inline'><p>Closes the underlying socket.</p>
-</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#initialize-instance_method" title="#initialize (instance method)">- (Object) <strong>initialize</strong>(ip_address, port = 27015) </a>
-  </span>
-    <span class="summary_desc"><div class='inline'><p>Creates a new UDP socket to communicate with the server on the given IP address and port.</p>
-</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#receive_packet-instance_method" title="#receive_packet (instance method)">- (Fixnum) <strong>receive_packet</strong>(buffer_length = 0) </a>
-  </span>
-    <span class="summary_desc"><div class='inline'><p>Reads the given amount of data from the socket and wraps it into the buffer.</p>
-</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#send-instance_method" title="#send (instance method)">- (Object) <strong>send</strong>(data_packet) </a>
-  </span>
-    <span class="summary_desc"><div class='inline'><p>Sends the given packet to the server.</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="timeout=-class_method">
-    + (<tt>Object</tt>) <strong>timeout=</strong>(timeout)
-</h3><div class="docstring">
-  <div class="discussion">
-    <p>Sets the timeout for socket operations</p>
-<p>Any request that takes longer than this time will cause a
-<span class='object_link'><a href="SteamCondenser/TimeoutError.html" title="SteamCondenser::TimeoutError (class)">SteamCondenser::TimeoutError</a></span>.</p>
-  </div>
-</div>
-<div class="tags">
-  <p class="tag_title">Parameters:</p>
-<ul class="param">
-    <li>
-        <span class='name'>timeout</span>
-        <span class='type'>(<tt>Fixnum</tt>)</span>
-        &mdash;
-        <div class='inline'><p>The amount of milliseconds before a request times
-out</p>
-</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-28
-29
-30</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/steam/sockets/steam_socket.rb', line 28</span>
-<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_timeout='>timeout=</span><span class='lparen'>(</span><span class='id identifier rubyid_timeout'>timeout</span><span class='rparen'>)</span>
-  <span class='cvar'>@@timeout</span> <span class='op'>=</span> <span class='id identifier rubyid_timeout'>timeout</span>
-<span class='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="close-instance_method">
-    - (<tt>Object</tt>) <strong>close</strong>
-</h3><div class="docstring">
-  <div class="discussion">
-    <p>Closes the underlying socket</p>
-  </div>
-</div>
-<div class="tags">
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-44
-45
-46</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/steam/sockets/steam_socket.rb', line 44</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_close'>close</span>
-  <span class='ivar'>@socket</span><span class='period'>.</span><span class='id identifier rubyid_close'>close</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <h3 class="signature " id="initialize-instance_method">
-    - (<tt>Object</tt>) <strong>initialize</strong>(ip_address, port = 27015)
-</h3><div class="docstring">
-  <div class="discussion">
-    <p>Creates a new UDP socket to communicate with the server on the given IP
-address and port</p>
-  </div>
-</div>
-<div class="tags">
-  <p class="tag_title">Parameters:</p>
-<ul class="param">
-    <li>
-        <span class='name'>ip_address</span>
-        <span class='type'>(<tt>String</tt>)</span>
-        &mdash;
-        <div class='inline'><p>Either the IP address or the DNS name of the
-server</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>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-38
-39
-40
-41</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/steam/sockets/steam_socket.rb', line 38</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_ip_address'>ip_address</span><span class='comma'>,</span> <span class='id identifier rubyid_port'>port</span> <span class='op'>=</span> <span class='int'>27015</span><span class='rparen'>)</span>
-  <span class='ivar'>@socket</span> <span class='op'>=</span> <span class='const'>UDPSocket</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
-  <span class='ivar'>@socket</span><span class='period'>.</span><span class='id identifier rubyid_connect'>connect</span> <span class='id identifier rubyid_ip_address'>ip_address</span><span class='comma'>,</span> <span class='id identifier rubyid_port'>port</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <h3 class="signature " id="receive_packet-instance_method">
-    - (<tt>Fixnum</tt>) <strong>receive_packet</strong>(buffer_length = 0)
-</h3><div class="docstring">
-  <div class="discussion">
-    <p>Reads the given amount of data from the socket and wraps it into the buffer</p>
-  </div>
-</div>
-<div class="tags">
-  <p class="tag_title">Parameters:</p>
-<ul class="param">
-    <li>
-        <span class='name'>buffer_length</span>
-        <span class='type'>(<tt>Fixnum</tt>)</span>
-        <em class="default">(defaults to: <tt>0</tt>)</em>
-        &mdash;
-        <div class='inline'><p>The data length to read from the socket</p>
-</div>
-    </li>
-</ul>
-<p class="tag_title">Returns:</p>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>Fixnum</tt>)</span>
-        &mdash;
-        <div class='inline'><p>The number of bytes that have been read from the socket</p>
-</div>
-    </li>
-</ul>
-<p class="tag_title">Raises:</p>
-<ul class="raise">
-    <li>
-        <span class='type'>(<tt><span class='object_link'><a href="SteamCondenser/TimeoutError.html" title="SteamCondenser::TimeoutError (class)">SteamCondenser::TimeoutError</a></span></tt>)</span>
-        &mdash;
-        <div class='inline'><p>if no packet is received on time</p>
-</div>
-    </li>
-</ul>
-  <p class="tag_title">See Also:</p>
-  <ul class="see">
-      <li><span class='object_link'><a href="StringIO.html" title="StringIO (class)">StringIO</a></span></li>
-  </ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-54
-55
-56
-57
-58
-59
-60
-61
-62
-63
-64
-65
-66
-67
-68
-69
-70
-71
-72
-73
-74
-75
-76</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/steam/sockets/steam_socket.rb', line 54</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_receive_packet'>receive_packet</span><span class='lparen'>(</span><span class='id identifier rubyid_buffer_length'>buffer_length</span> <span class='op'>=</span> <span class='int'>0</span><span class='rparen'>)</span>
-  <span class='kw'>if</span> <span class='id identifier rubyid_select'>select</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='ivar'>@socket</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='cvar'>@@timeout</span> <span class='op'>/</span> <span class='float'>1000.0</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
-    <span class='id identifier rubyid_raise'>raise</span> <span class='const'>SteamCondenser</span><span class='op'>::</span><span class='const'>TimeoutError</span>
-  <span class='kw'>end</span>
-  <span class='kw'>if</span> <span class='id identifier rubyid_buffer_length'>buffer_length</span> <span class='op'>==</span> <span class='int'>0</span>
-    <span class='ivar'>@buffer</span><span class='period'>.</span><span class='id identifier rubyid_rewind'>rewind</span>
-  <span class='kw'>else</span>
-    <span class='ivar'>@buffer</span> <span class='op'>=</span> <span class='const'>StringIO</span><span class='period'>.</span><span class='id identifier rubyid_alloc'>alloc</span> <span class='id identifier rubyid_buffer_length'>buffer_length</span>
-  <span class='kw'>end</span>
-  <span class='kw'>begin</span>
-    <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='ivar'>@socket</span><span class='period'>.</span><span class='id identifier rubyid_recv'>recv</span> <span class='ivar'>@buffer</span><span class='period'>.</span><span class='id identifier rubyid_remaining'>remaining</span>
-  <span class='kw'>rescue</span> <span class='const'>Errno</span><span class='op'>::</span><span class='const'>ECONNRESET</span>
-    <span class='ivar'>@socket</span><span class='period'>.</span><span class='id identifier rubyid_close'>close</span>
-    <span class='id identifier rubyid_raise'>raise</span> <span class='gvar'>$!</span>
-  <span class='kw'>end</span>
-  <span class='id identifier rubyid_bytes_read'>bytes_read</span> <span class='op'>=</span> <span class='ivar'>@buffer</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span> <span class='id identifier rubyid_data'>data</span>
-  <span class='ivar'>@buffer</span><span class='period'>.</span><span class='id identifier rubyid_truncate'>truncate</span> <span class='id identifier rubyid_bytes_read'>bytes_read</span>
-  <span class='ivar'>@buffer</span><span class='period'>.</span><span class='id identifier rubyid_rewind'>rewind</span>
-  <span class='id identifier rubyid_bytes_read'>bytes_read</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <h3 class="signature " id="send-instance_method">
-    - (<tt>Object</tt>) <strong>send</strong>(data_packet)
-</h3><div class="docstring">
-  <div class="discussion">
-    <p>Sends the given packet to the server</p>
-<p>This converts the packet into a byte stream first before writing it to the
-socket.</p>
-  </div>
-</div>
-<div class="tags">
-  <p class="tag_title">Parameters:</p>
-<ul class="param">
-    <li>
-        <span class='name'>data_packet</span>
-        <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 to send to the server</p>
-</div>
-    </li>
-</ul>
-  <p class="tag_title">See Also:</p>
-  <ul class="see">
-      <li><span class='object_link'><a href="SteamPacket.html#to_s-instance_method" title="SteamPacket#to_s (method)">SteamPacket#to_s</a></span></li>
-  </ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-85
-86
-87
-88
-89</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/steam/sockets/steam_socket.rb', line 85</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='id identifier rubyid_data_packet'>data_packet</span><span class='rparen'>)</span>
-  <span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Sending data packet of type \&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_data_packet'>data_packet</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='embexpr_end'>}</span><span class='tstring_content'>\&quot;.</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span> <span class='gvar'>$DEBUG</span>
-  <span class='ivar'>@socket</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span> <span class='id identifier rubyid_data_packet'>data_packet</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='comma'>,</span> <span class='int'>0</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-  </div>
-</div>
-    <div id="footer">
-  Generated on Sun Oct 27 11:01:18 2013 by
-  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.8.7.1 (ruby-2.0.0).
-</div>
-  </body>
-</html>