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

@@ -0,0 +1,616 @@
+<!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::Logging
+    &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 (L)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../SteamCondenser.html" title="SteamCondenser (module)">SteamCondenser</a></span></span>
+     &raquo;
+    <span class="title">Logging</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::Logging
+</h1>
+<dl class="box">
+    <dt class="r1">Included in:</dt>
+    <dd class="r1"><span class='object_link'><a href="Community/WebApi.html" title="SteamCondenser::Community::WebApi (module)">Community::WebApi</a></span>, <span class='object_link'><a href="Servers/MasterServer.html" title="SteamCondenser::Servers::MasterServer (class)">Servers::MasterServer</a></span>, <span class='object_link'><a href="Servers/Sockets/GoldSrcSocket.html" title="SteamCondenser::Servers::Sockets::GoldSrcSocket (class)">Servers::Sockets::GoldSrcSocket</a></span>, <span class='object_link'><a href="Servers/Sockets/MasterServerSocket.html" title="SteamCondenser::Servers::Sockets::MasterServerSocket (class)">Servers::Sockets::MasterServerSocket</a></span>, <span class='object_link'><a href="Servers/Sockets/RCONSocket.html" title="SteamCondenser::Servers::Sockets::RCONSocket (class)">Servers::Sockets::RCONSocket</a></span>, <span class='object_link'><a href="Servers/Sockets/SourceSocket.html" title="SteamCondenser::Servers::Sockets::SourceSocket (class)">Servers::Sockets::SourceSocket</a></span>, <span class='object_link'><a href="Servers/SourceServer.html" title="SteamCondenser::Servers::SourceServer (class)">Servers::SourceServer</a></span></dd>
+    <dt class="r2 last">Defined in:</dt>
+    <dd class="r2 last">lib/steam-condenser/logging.rb</dd>
+</dl>
+<div class="clear"></div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <p>This module is included by all classes of Steam Condenser that log events</p>
+<p>It is a lightweight wrapper around Ruby&#39;s <code>Logger</code> class from the standard
+library.</p>
+  </div>
+</div>
+<div class="tags">
+</div>
+  <h2>Constant Summary</h2>
+    <dl class="constants">
+        <dt id="formatter-classvariable" class="">@@formatter =
+        </dt>
+        <dd><pre class="code"><span class='rubyid_Logger constant id'>Logger</span><span class='colon2 op'>::</span><span class='rubyid_Formatter constant id'>Formatter</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span>
+</pre></dd>
+        <dt id="level-classvariable" class="">@@level =
+        </dt>
+        <dd><pre class="code"><span class='rubyid_Logger constant id'>Logger</span><span class='colon2 op'>::</span><span class='rubyid_Severity constant id'>Severity</span><span class='colon2 op'>::</span><span class='rubyid_WARN constant id'>WARN</span>
+</pre></dd>
+        <dt id="logdev-classvariable" class="">@@logdev =
+        </dt>
+        <dd><pre class="code"><span class='rubyid_STDOUT constant id'>STDOUT</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="#formatter%3D-class_method" title="formatter= (class method)">+ (Object) <strong>formatter=</strong>(formatter) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Sets the default formatter to use for all logging events in Steam Condenser.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#included-class_method" title="included (class method)">+ (Object) <strong>included</strong>(klass) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Creates a logger for the class that includes this module.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#level%3D-class_method" title="level= (class method)">+ (Object) <strong>level=</strong>(level) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Sets the default log level to use for filtering all logging events in Steam Condenser.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#logdev%3D-class_method" title="logdev= (class method)">+ (Object) <strong>logdev=</strong>(logdev) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Sets the default logging device to use for all logging events in Steam Condenser.</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="#log-instance_method" title="#log (instance method)">- (Logger) <strong>log</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Returns the logger for the current class.</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="formatter=-class_method">
+    + (<tt>Object</tt>) <strong>formatter=</strong>(formatter)
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Sets the default formatter to use for all logging events in Steam
+Condenser</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>formatter</span>
+        <span class='type'>(<tt>#call</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The formatter to use when logging</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+45
+46
+47</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/logging.rb', line 45</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_formatter identifier id'>formatter</span><span class='assign token'>=</span><span class='lparen token'>(</span><span class='rubyid_formatter identifier id'>formatter</span><span class='rparen token'>)</span>
+  <span class='rubyid_@@formatter ivar id'>@@formatter</span> <span class='assign token'>=</span> <span class='rubyid_formatter identifier id'>formatter</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="included-class_method">
+    + (<tt>Object</tt>) <strong>included</strong>(klass)
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Creates a logger for the class that includes this module</p>
+<p>Additionally it defines a <code>.log</code> singleton method for the class that
+includes this module</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>klass</span>
+        <span class='type'>(<tt>Class</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The class that includes this module</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+28
+29
+30
+31
+32
+33
+34
+35
+36
+37
+38
+39</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/logging.rb', line 28</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_included identifier id'>included</span><span class='lparen token'>(</span><span class='rubyid_klass identifier id'>klass</span><span class='rparen token'>)</span>
+  <span class='rubyid_klass identifier id'>klass</span><span class='dot token'>.</span><span class='rubyid_define_singleton_method identifier id'>define_singleton_method</span> <span class='symbol val'>:log</span> <span class='rubyid_do do kw'>do</span>
+    <span class='rubyid_class_variable_get identifier id'>class_variable_get</span> <span class='symbol val'>:@@logger</span>
+  <span class='rubyid_end end kw'>end</span>
+  <span class='rubyid_logger identifier id'>logger</span> <span class='assign token'>=</span> <span class='rubyid_Logger constant id'>Logger</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span> <span class='rubyid_@@logdev ivar id'>@@logdev</span>
+  <span class='rubyid_logger identifier id'>logger</span><span class='dot token'>.</span><span class='rubyid_formatter identifier id'>formatter</span> <span class='assign token'>=</span> <span class='rubyid_@@formatter ivar id'>@@formatter</span>
+  <span class='rubyid_logger identifier id'>logger</span><span class='dot token'>.</span><span class='rubyid_level identifier id'>level</span> <span class='assign token'>=</span> <span class='rubyid_@@level ivar id'>@@level</span>
+  <span class='rubyid_logger identifier id'>logger</span><span class='dot token'>.</span><span class='rubyid_progname identifier id'>progname</span> <span class='assign token'>=</span> <span class='rubyid_klass identifier id'>klass</span><span class='dot token'>.</span><span class='rubyid_name identifier id'>name</span>
+  <span class='rubyid_klass identifier id'>klass</span><span class='dot token'>.</span><span class='rubyid_send identifier id'>send</span> <span class='symbol val'>:class_variable_set</span><span class='comma token'>,</span> <span class='symbol val'>:@@logger</span><span class='comma token'>,</span> <span class='rubyid_logger identifier id'>logger</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="level=-class_method">
+    + (<tt>Object</tt>) <strong>level=</strong>(level)
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Sets the default log level to use for filtering all logging events in
+Steam Condenser</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>level</span>
+        <span class='type'>(<tt>Fixum</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The log level to use when logging</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+61
+62
+63</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/logging.rb', line 61</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_level identifier id'>level</span><span class='assign token'>=</span><span class='lparen token'>(</span><span class='rubyid_level identifier id'>level</span><span class='rparen token'>)</span>
+  <span class='rubyid_@@level ivar id'>@@level</span> <span class='assign token'>=</span> <span class='rubyid_level identifier id'>level</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="logdev=-class_method">
+    + (<tt>Object</tt>) <strong>logdev=</strong>(logdev)
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Sets the default logging device to use for all logging events in Steam
+Condenser</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>logdev</span>
+        <span class='type'>(<tt>IO</tt>)</span>
+        &mdash;
+        <div class='inline'><p>For example an output stream or file to log to</p>
+</div>
+    </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/logging.rb', line 53</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_logdev identifier id'>logdev</span><span class='assign token'>=</span><span class='lparen token'>(</span><span class='rubyid_logdev identifier id'>logdev</span><span class='rparen token'>)</span>
+  <span class='rubyid_@@logdev ivar id'>@@logdev</span> <span class='assign token'>=</span> <span class='rubyid_logdev identifier id'>logdev</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="log-instance_method">
+    - (<tt>Logger</tt>) <strong>log</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the logger for the current class</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Logger</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The logger for the current class</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+68
+69
+70</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/logging.rb', line 68</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_log identifier id'>log</span>
+  <span class='rubyid_self self kw'>self</span><span class='dot token'>.</span><span class='rubyid_class identifier id'>class</span><span class='dot token'>.</span><span class='rubyid_log identifier id'>log</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:39 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>