+++ /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::Data::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::Data::Base</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../../files/lib/mcollective/data/base_rb.html">
- lib/mcollective/data/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>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000243">activate?</a>
- <a href="#M000242">activate_when</a>
- <a href="#M000241">ddl_validate</a>
- <a href="#M000237">inherited</a>
- <a href="#M000239">lookup</a>
- <a href="#M000238">new</a>
- <a href="#M000240">query</a>
- <a href="#M000244">startup_hook</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">ddl</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">name</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">result</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">timeout</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-M000243" class="method-detail">
- <a name="M000243"></a>
-
- <div class="method-heading">
- <a href="#M000243" class="method-signature">
- <span class="method-name">activate?</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Always be active unless a specific block is given with <a
-href="Base.html#M000242">activate_when</a>
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000243-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000243-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/data/base.rb, line 60</span>
-60: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">activate?</span>
-61: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span>
-62: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000242" class="method-detail">
- <a name="M000242"></a>
-
- <div class="method-heading">
- <a href="#M000242" class="method-signature">
- <span class="method-name">activate_when</span><span class="method-args">(&block)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-<a href="Base.html#M000242">activate_when</a> do
-</p>
-<pre>
- file.exist?("/usr/bin/puppet")
-</pre>
-<p>
-end
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000242-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000242-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/data/base.rb, line 53</span>
-53: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">activate_when</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
-54: (<span class="ruby-keyword kw">class</span> <span class="ruby-operator"><<</span> <span class="ruby-keyword kw">self</span>; <span class="ruby-keyword kw">self</span>; <span class="ruby-keyword kw">end</span>).<span class="ruby-identifier">instance_eval</span> <span class="ruby-keyword kw">do</span>
-55: <span class="ruby-identifier">define_method</span>(<span class="ruby-value str">"activate?"</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
-56: <span class="ruby-keyword kw">end</span>
-57: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000237" class="method-detail">
- <a name="M000237"></a>
-
- <div class="method-heading">
- <a href="#M000237" class="method-signature">
- <span class="method-name">inherited</span><span class="method-args">(klass)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Register plugins that inherits base
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000237-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000237-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/data/base.rb, line 7</span>
- 7: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">inherited</span>(<span class="ruby-identifier">klass</span>)
- 8: <span class="ruby-identifier">type</span> = <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">split</span>(<span class="ruby-value str">"::"</span>).<span class="ruby-identifier">last</span>.<span class="ruby-identifier">downcase</span>
- 9:
-10: <span class="ruby-constant">PluginManager</span> <span class="ruby-operator"><<</span> {<span class="ruby-identifier">:type</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">type</span>, <span class="ruby-identifier">:class</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">to_s</span>, <span class="ruby-identifier">:single_instance</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">false</span>}
-11: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000238" class="method-detail">
- <a name="M000238"></a>
-
- <div class="method-heading">
- <a href="#M000238" 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('M000238-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000238-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/data/base.rb, line 13</span>
-13: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>
-14: <span class="ruby-ivar">@name</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">split</span>(<span class="ruby-value str">"::"</span>).<span class="ruby-identifier">last</span>.<span class="ruby-identifier">downcase</span>
-15: <span class="ruby-ivar">@ddl</span> = <span class="ruby-constant">DDL</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@name</span>, <span class="ruby-identifier">:data</span>)
-16: <span class="ruby-ivar">@result</span> = <span class="ruby-constant">Result</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@ddl</span>.<span class="ruby-identifier">dataquery_interface</span>[<span class="ruby-identifier">:output</span>])
-17: <span class="ruby-ivar">@timeout</span> = <span class="ruby-ivar">@ddl</span>.<span class="ruby-identifier">meta</span>[<span class="ruby-identifier">:timeout</span>] <span class="ruby-operator">||</span> <span class="ruby-value">1</span>
-18:
-19: <span class="ruby-identifier">startup_hook</span>
-20: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000240" class="method-detail">
- <a name="M000240"></a>
-
- <div class="method-heading">
- <a href="#M000240" class="method-signature">
- <span class="method-name">query</span><span class="method-args">(&block)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000240-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000240-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/data/base.rb, line 42</span>
-42: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">query</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
-43: <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">module_eval</span> { <span class="ruby-identifier">define_method</span>(<span class="ruby-value str">"query_data"</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>) }
-44: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000241" class="method-detail">
- <a name="M000241"></a>
-
- <div class="method-heading">
- <a href="#M000241" class="method-signature">
- <span class="method-name">ddl_validate</span><span class="method-args">(what)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000241-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000241-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/data/base.rb, line 46</span>
-46: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">ddl_validate</span>(<span class="ruby-identifier">what</span>)
-47: <span class="ruby-constant">Data</span>.<span class="ruby-identifier">ddl_validate</span>(<span class="ruby-ivar">@ddl</span>, <span class="ruby-identifier">what</span>)
-48: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000239" class="method-detail">
- <a name="M000239"></a>
-
- <div class="method-heading">
- <a href="#M000239" class="method-signature">
- <span class="method-name">lookup</span><span class="method-args">(what)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000239-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000239-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/data/base.rb, line 22</span>
-22: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">lookup</span>(<span class="ruby-identifier">what</span>)
-23: <span class="ruby-identifier">ddl_validate</span>(<span class="ruby-identifier">what</span>)
-24:
-25: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-value str">"Doing data query %s for '%s'"</span> <span class="ruby-operator">%</span> [ <span class="ruby-ivar">@name</span>, <span class="ruby-identifier">what</span> ])
-26:
-27: <span class="ruby-constant">Timeout</span><span class="ruby-operator">::</span><span class="ruby-identifier">timeout</span>(<span class="ruby-ivar">@timeout</span>) <span class="ruby-keyword kw">do</span>
-28: <span class="ruby-identifier">query_data</span>(<span class="ruby-identifier">what</span>)
-29: <span class="ruby-keyword kw">end</span>
-30:
-31: <span class="ruby-ivar">@result</span>
-32: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Timeout</span><span class="ruby-operator">::</span><span class="ruby-constant">Error</span>
-33: <span class="ruby-comment cmt"># Timeout::Error is a inherited from Interrupt which seems a really</span>
-34: <span class="ruby-comment cmt"># strange choice, making it an equivelant of ^C and such. Catch it</span>
-35: <span class="ruby-comment cmt"># and raise something less critical that will not the runner to just</span>
-36: <span class="ruby-comment cmt"># give up the ghost</span>
-37: <span class="ruby-identifier">msg</span> = <span class="ruby-value str">"Data plugin %s timed out on query '%s'"</span> <span class="ruby-operator">%</span> [<span class="ruby-ivar">@name</span>, <span class="ruby-identifier">what</span>]
-38: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">error</span>(<span class="ruby-identifier">msg</span>)
-39: <span class="ruby-identifier">raise</span> <span class="ruby-constant">MsgTTLExpired</span>, <span class="ruby-identifier">msg</span>
-40: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000244" class="method-detail">
- <a name="M000244"></a>
-
- <div class="method-heading">
- <a href="#M000244" class="method-signature">
- <span class="method-name">startup_hook</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000244-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000244-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/data/base.rb, line 64</span>
-64: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">startup_hook</span>;<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