--- /dev/null
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!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>
+ <title>Class: MCollective::Logger::Base</title>
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+ <meta http-equiv="Content-Script-Type" content="text/javascript" />
+ <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+ <script type="text/javascript">
+ // <![CDATA[
+
+ function popupCode( url ) {
+ window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+ }
+
+ function toggleCode( id ) {
+ if ( document.getElementById )
+ elem = document.getElementById( id );
+ else if ( document.all )
+ elem = eval( "document.all." + id );
+ else
+ return false;
+
+ elemStyle = elem.style;
+
+ if ( elemStyle.display != "block" ) {
+ elemStyle.display = "block"
+ } else {
+ elemStyle.display = "none"
+ }
+
+ return true;
+ }
+
+ // Make codeblocks hidden by default
+ document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+
+ // ]]>
+ </script>
+
+</head>
+<body>
+
+
+
+ <div id="classHeader">
+ <table class="header-table">
+ <tr class="top-aligned-row">
+ <td><strong>Class</strong></td>
+ <td class="class-name-in-header">MCollective::Logger::Base</td>
+ </tr>
+ <tr class="top-aligned-row">
+ <td><strong>In:</strong></td>
+ <td>
+ <a href="../../../files/lib/mcollective/logger/base_rb.html">
+ lib/mcollective/logger/base.rb
+ </a>
+ <br />
+ </td>
+ </tr>
+
+ <tr class="top-aligned-row">
+ <td><strong>Parent:</strong></td>
+ <td>
+ Object
+ </td>
+ </tr>
+ </table>
+ </div>
+ <!-- banner header -->
+
+ <div id="bodyContent">
+
+
+
+ <div id="contextContent">
+
+ <div id="description">
+ <p>
+A base class for logging providers.
+</p>
+<p>
+Logging providers should provide the following:
+</p>
+<pre>
+ * start - all you need to do to setup your logging
+ * set_logging_level - set your logging to :info, :warn, etc
+ * valid_levels - a hash of maps from :info to your internal level name
+ * log - what needs to be done to log a specific message
+</pre>
+
+ </div>
+
+
+ </div>
+
+ <div id="method-list">
+ <h3 class="section-bar">Methods</h3>
+
+ <div class="name-list">
+ <a href="#M000204">cycle_level</a>
+ <a href="#M000202">new</a>
+ <a href="#M000205">set_level</a>
+ <a href="#M000203">should_log?</a>
+ </div>
+ </div>
+
+ </div>
+
+
+ <!-- if includes -->
+
+ <div id="section">
+
+
+
+
+
+ <div id="attribute-list">
+ <h3 class="section-bar">Attributes</h3>
+
+ <div class="name-list">
+ <table>
+ <tr class="top-aligned-row context-row">
+ <td class="context-item-name">active_level</td>
+ <td class="context-item-value"> [R] </td>
+ <td class="context-item-desc"></td>
+ </tr>
+ </table>
+ </div>
+ </div>
+
+
+
+ <!-- if method_list -->
+ <div id="methods">
+ <h3 class="section-bar">Public Class methods</h3>
+
+ <div id="method-M000202" class="method-detail">
+ <a name="M000202"></a>
+
+ <div class="method-heading">
+ <a href="#M000202" class="method-signature">
+ <span class="method-name">new</span><span class="method-args">()</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p><a class="source-toggle" href="#"
+ onclick="toggleCode('M000202-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000202-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/logger/base.rb, line 14</span>
+14: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>
+15: <span class="ruby-ivar">@known_levels</span> = [<span class="ruby-identifier">:debug</span>, <span class="ruby-identifier">:info</span>, <span class="ruby-identifier">:warn</span>, <span class="ruby-identifier">:error</span>, <span class="ruby-identifier">:fatal</span>]
+16:
+17: <span class="ruby-comment cmt"># Sanity check the class that impliments the logging</span>
+18: <span class="ruby-ivar">@known_levels</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">lvl</span><span class="ruby-operator">|</span>
+19: <span class="ruby-identifier">raise</span> <span class="ruby-node">"Logger class did not specify a map for #{lvl}"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">valid_levels</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">lvl</span>)
+20: <span class="ruby-keyword kw">end</span>
+21: <span class="ruby-keyword kw">end</span>
+</pre>
+ </div>
+ </div>
+ </div>
+
+ <h3 class="section-bar">Public Instance methods</h3>
+
+ <div id="method-M000204" class="method-detail">
+ <a name="M000204"></a>
+
+ <div class="method-heading">
+ <a href="#M000204" class="method-signature">
+ <span class="method-name">cycle_level</span><span class="method-args">()</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p>
+Figures out the next level and sets it
+</p>
+ <p><a class="source-toggle" href="#"
+ onclick="toggleCode('M000204-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000204-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/logger/base.rb, line 28</span>
+28: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">cycle_level</span>
+29: <span class="ruby-identifier">lvl</span> = <span class="ruby-identifier">get_next_level</span>
+30: <span class="ruby-identifier">set_level</span>(<span class="ruby-identifier">lvl</span>)
+31:
+32: <span class="ruby-identifier">log</span>(<span class="ruby-identifier">lvl</span>, <span class="ruby-value str">""</span>, <span class="ruby-node">"Logging level is now #{lvl.to_s.upcase}"</span>)
+33: <span class="ruby-keyword kw">end</span>
+</pre>
+ </div>
+ </div>
+ </div>
+
+ <div id="method-M000205" class="method-detail">
+ <a name="M000205"></a>
+
+ <div class="method-heading">
+ <a href="#M000205" class="method-signature">
+ <span class="method-name">set_level</span><span class="method-args">(level)</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p>
+Sets a <a href="Base.html#M000202">new</a> level and record it in
+@active_level
+</p>
+ <p><a class="source-toggle" href="#"
+ onclick="toggleCode('M000205-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000205-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/logger/base.rb, line 36</span>
+36: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">set_level</span>(<span class="ruby-identifier">level</span>)
+37: <span class="ruby-identifier">set_logging_level</span>(<span class="ruby-identifier">level</span>)
+38: <span class="ruby-ivar">@active_level</span> = <span class="ruby-identifier">level</span>.<span class="ruby-identifier">to_sym</span>
+39: <span class="ruby-keyword kw">end</span>
+</pre>
+ </div>
+ </div>
+ </div>
+
+ <div id="method-M000203" class="method-detail">
+ <a name="M000203"></a>
+
+ <div class="method-heading">
+ <a href="#M000203" class="method-signature">
+ <span class="method-name">should_log?</span><span class="method-args">(level)</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p><a class="source-toggle" href="#"
+ onclick="toggleCode('M000203-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000203-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/logger/base.rb, line 23</span>
+23: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">should_log?</span>(<span class="ruby-identifier">level</span>)
+24: <span class="ruby-ivar">@known_levels</span>.<span class="ruby-identifier">index</span>(<span class="ruby-identifier">level</span>) <span class="ruby-operator">>=</span> <span class="ruby-ivar">@known_levels</span>.<span class="ruby-identifier">index</span>(<span class="ruby-ivar">@active_level</span>)
+25: <span class="ruby-keyword kw">end</span>
+</pre>
+ </div>
+ </div>
+ </div>
+
+
+ </div>
+
+
+ </div>
+
+
+<div id="validator-badges">
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>
\ No newline at end of file
Code Review / packages / precise / mcollective.git / blobdiff