Update version according to OSCI-883
[packages/precise/mcollective.git] / doc / MCollective / Registration / Base.html
diff --git a/doc/MCollective/Registration/Base.html b/doc/MCollective/Registration/Base.html
new file mode 100644 (file)
index 0000000..81d4ff1
--- /dev/null
@@ -0,0 +1,655 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+       "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+       <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
+
+       <title>Class: MCollective::Registration::Base</title>
+
+       <link rel="stylesheet" href="../../rdoc.css" type="text/css" media="screen" />
+
+       <script src="../../js/jquery.js" type="text/javascript"
+               charset="utf-8"></script>
+       <script src="../../js/thickbox-compressed.js" type="text/javascript"
+               charset="utf-8"></script>
+       <script src="../../js/quicksearch.js" type="text/javascript"
+               charset="utf-8"></script>
+       <script src="../../js/darkfish.js" type="text/javascript"
+               charset="utf-8"></script>
+
+</head>
+<body class="class">
+
+       <div id="metadata">
+               <div id="file-metadata">
+                       <div id="file-list-section" class="section">
+                               <h3 class="section-header">In Files</h3>
+                               <div class="section-body">
+                                       <ul>
+                                       
+                                               <li><a href="../../lib/mcollective/registration/base_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
+                                                       class="thickbox" title="lib/mcollective/registration/base.rb">lib/mcollective/registration/base.rb</a></li>
+                                       
+                                       </ul>
+                               </div>
+                       </div>
+
+                       
+               </div>
+
+               <div id="class-metadata">
+
+                       <!-- Parent Class -->
+                       
+                       <div id="parent-class-section" class="section">
+                               <h3 class="section-header">Parent</h3>
+                               
+                               <p class="link"><a href="../../Object.html">Object</a></p>
+                               
+                       </div>
+                       
+
+                       <!-- Namespace Contents -->
+                       
+
+                       <!-- Method Quickref -->
+                       
+                       <div id="method-list-section" class="section">
+                               <h3 class="section-header">Methods</h3>
+                               <ul class="link-list">
+                                       
+                                       <li><a href="#M000151">::inherited</a></li>
+                                       
+                                       <li><a href="#M000153">#config</a></li>
+                                       
+                                       <li><a href="#M000158">#interval</a></li>
+                                       
+                                       <li><a href="#M000154">#msg_filter</a></li>
+                                       
+                                       <li><a href="#M000159">#publish</a></li>
+                                       
+                                       <li><a href="#M000152">#run</a></li>
+                                       
+                                       <li><a href="#M000157">#target_collective</a></li>
+                                       
+                               </ul>
+                       </div>
+                       
+
+                       <!-- Included Modules -->
+                       
+               </div>
+
+               <div id="project-metadata">
+                       
+                       
+                       <div id="fileindex-section" class="section project-section">
+                               <h3 class="section-header">Files</h3>
+                               <ul>
+                               
+                                       <li class="file"><a href="../../COPYING.html">COPYING</a></li>
+                               
+                                       <li class="file"><a href="../../Gemfile.html">Gemfile</a></li>
+                               
+                                       <li class="file"><a href="../../README.html">README</a></li>
+                               
+                                       <li class="file"><a href="../../Rakefile.html">Rakefile</a></li>
+                               
+                                       <li class="file"><a href="../../etc/client_cfg_dist.html">client.cfg.dist</a></li>
+                               
+                                       <li class="file"><a href="../../etc/data-help_erb.html">data-help.erb</a></li>
+                               
+                                       <li class="file"><a href="../../etc/discovery-help_erb.html">discovery-help.erb</a></li>
+                               
+                                       <li class="file"><a href="../../etc/facts_yaml_dist.html">facts.yaml.dist</a></li>
+                               
+                                       <li class="file"><a href="../../etc/metadata-help_erb.html">metadata-help.erb</a></li>
+                               
+                                       <li class="file"><a href="../../etc/msg-help_erb.html">msg-help.erb</a></li>
+                               
+                                       <li class="file"><a href="../../etc/rpc-help_erb.html">rpc-help.erb</a></li>
+                               
+                                       <li class="file"><a href="../../etc/server_cfg_dist.html">server.cfg.dist</a></li>
+                               
+                                       <li class="file"><a href="../../etc/ssl/PLACEHOLDER.html">PLACEHOLDER</a></li>
+                               
+                                       <li class="file"><a href="../../etc/ssl/clients/PLACEHOLDER.html">PLACEHOLDER</a></li>
+                               
+                                       <li class="file"><a href="../../lib/mcollective/generators/templates/action_snippet_erb.html">action_snippet.erb</a></li>
+                               
+                                       <li class="file"><a href="../../lib/mcollective/generators/templates/data_input_snippet_erb.html">data_input_snippet.erb</a></li>
+                               
+                                       <li class="file"><a href="../../lib/mcollective/generators/templates/ddl_erb.html">ddl.erb</a></li>
+                               
+                                       <li class="file"><a href="../../lib/mcollective/generators/templates/plugin_erb.html">plugin.erb</a></li>
+                               
+                                       <li class="file"><a href="../../lib/mcollective/locales/en_yml.html">en.yml</a></li>
+                               
+                                       <li class="file"><a href="../../mcollective_init.html">mcollective.init</a></li>
+                               
+                               </ul>
+                       </div>
+                       
+
+                       <div id="classindex-section" class="section project-section">
+                               <h3 class="section-header">Class Index
+                                       <span class="search-toggle"><img src="../../images/find.png"
+                                               height="16" width="16" alt="[+]"
+                                               title="show/hide quicksearch" /></span></h3>
+                               <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
+                               <fieldset>
+                                       <legend>Quicksearch</legend>
+                                       <input type="text" name="quicksearch" value=""
+                                               class="quicksearch-field" />
+                               </fieldset>
+                               </form>
+
+                               <ul class="link-list">
+                               
+                                       <li><a href="../../MCollective.html">MCollective</a></li>
+                               
+                                       <li><a href="../../MCollective/Agent.html">MCollective::Agent</a></li>
+                               
+                                       <li><a href="../../MCollective/Agents.html">MCollective::Agents</a></li>
+                               
+                                       <li><a href="../../MCollective/Aggregate.html">MCollective::Aggregate</a></li>
+                               
+                                       <li><a href="../../MCollective/Aggregate/Base.html">MCollective::Aggregate::Base</a></li>
+                               
+                                       <li><a href="../../MCollective/Aggregate/Result.html">MCollective::Aggregate::Result</a></li>
+                               
+                                       <li><a href="../../MCollective/Aggregate/Result/Base.html">MCollective::Aggregate::Result::Base</a></li>
+                               
+                                       <li><a href="../../MCollective/Aggregate/Result/CollectionResult.html">MCollective::Aggregate::Result::CollectionResult</a></li>
+                               
+                                       <li><a href="../../MCollective/Aggregate/Result/NumericResult.html">MCollective::Aggregate::Result::NumericResult</a></li>
+                               
+                                       <li><a href="../../MCollective/Application.html">MCollective::Application</a></li>
+                               
+                                       <li><a href="../../MCollective/Applications.html">MCollective::Applications</a></li>
+                               
+                                       <li><a href="../../MCollective/Cache.html">MCollective::Cache</a></li>
+                               
+                                       <li><a href="../../MCollective/Client.html">MCollective::Client</a></li>
+                               
+                                       <li><a href="../../MCollective/CodedError.html">MCollective::CodedError</a></li>
+                               
+                                       <li><a href="../../MCollective/Config.html">MCollective::Config</a></li>
+                               
+                                       <li><a href="../../MCollective/Connector.html">MCollective::Connector</a></li>
+                               
+                                       <li><a href="../../MCollective/Connector/Base.html">MCollective::Connector::Base</a></li>
+                               
+                                       <li><a href="../../MCollective/DDL.html">MCollective::DDL</a></li>
+                               
+                                       <li><a href="../../MCollective/DDL/AgentDDL.html">MCollective::DDL::AgentDDL</a></li>
+                               
+                                       <li><a href="../../MCollective/DDL/Base.html">MCollective::DDL::Base</a></li>
+                               
+                                       <li><a href="../../MCollective/DDL/DataDDL.html">MCollective::DDL::DataDDL</a></li>
+                               
+                                       <li><a href="../../MCollective/DDL/DiscoveryDDL.html">MCollective::DDL::DiscoveryDDL</a></li>
+                               
+                                       <li><a href="../../MCollective/DDL/ValidatorDDL.html">MCollective::DDL::ValidatorDDL</a></li>
+                               
+                                       <li><a href="../../MCollective/DDLValidationError.html">MCollective::DDLValidationError</a></li>
+                               
+                                       <li><a href="../../MCollective/Data.html">MCollective::Data</a></li>
+                               
+                                       <li><a href="../../MCollective/Data/Base.html">MCollective::Data::Base</a></li>
+                               
+                                       <li><a href="../../MCollective/Data/Result.html">MCollective::Data::Result</a></li>
+                               
+                                       <li><a href="../../MCollective/Discovery.html">MCollective::Discovery</a></li>
+                               
+                                       <li><a href="../../MCollective/Facts.html">MCollective::Facts</a></li>
+                               
+                                       <li><a href="../../MCollective/Facts/Base.html">MCollective::Facts::Base</a></li>
+                               
+                                       <li><a href="../../MCollective/Generators.html">MCollective::Generators</a></li>
+                               
+                                       <li><a href="../../MCollective/Generators/AgentGenerator.html">MCollective::Generators::AgentGenerator</a></li>
+                               
+                                       <li><a href="../../MCollective/Generators/Base.html">MCollective::Generators::Base</a></li>
+                               
+                                       <li><a href="../../MCollective/Generators/DataGenerator.html">MCollective::Generators::DataGenerator</a></li>
+                               
+                                       <li><a href="../../MCollective/InvalidRPCData.html">MCollective::InvalidRPCData</a></li>
+                               
+                                       <li><a href="../../MCollective/Log.html">MCollective::Log</a></li>
+                               
+                                       <li><a href="../../MCollective/Logger.html">MCollective::Logger</a></li>
+                               
+                                       <li><a href="../../MCollective/Logger/Base.html">MCollective::Logger::Base</a></li>
+                               
+                                       <li><a href="../../MCollective/Logger/Console_logger.html">MCollective::Logger::Console_logger</a></li>
+                               
+                                       <li><a href="../../MCollective/Logger/File_logger.html">MCollective::Logger::File_logger</a></li>
+                               
+                                       <li><a href="../../MCollective/Logger/Syslog_logger.html">MCollective::Logger::Syslog_logger</a></li>
+                               
+                                       <li><a href="../../MCollective/Matcher.html">MCollective::Matcher</a></li>
+                               
+                                       <li><a href="../../MCollective/Matcher/Parser.html">MCollective::Matcher::Parser</a></li>
+                               
+                                       <li><a href="../../MCollective/Matcher/Scanner.html">MCollective::Matcher::Scanner</a></li>
+                               
+                                       <li><a href="../../MCollective/Message.html">MCollective::Message</a></li>
+                               
+                                       <li><a href="../../MCollective/MissingRPCData.html">MCollective::MissingRPCData</a></li>
+                               
+                                       <li><a href="../../MCollective/MsgDoesNotMatchRequestID.html">MCollective::MsgDoesNotMatchRequestID</a></li>
+                               
+                                       <li><a href="../../MCollective/MsgTTLExpired.html">MCollective::MsgTTLExpired</a></li>
+                               
+                                       <li><a href="../../MCollective/NotTargettedAtUs.html">MCollective::NotTargettedAtUs</a></li>
+                               
+                                       <li><a href="../../MCollective/Optionparser.html">MCollective::Optionparser</a></li>
+                               
+                                       <li><a href="../../MCollective/PluginManager.html">MCollective::PluginManager</a></li>
+                               
+                                       <li><a href="../../MCollective/PluginPackager.html">MCollective::PluginPackager</a></li>
+                               
+                                       <li><a href="../../MCollective/PluginPackager/AgentDefinition.html">MCollective::PluginPackager::AgentDefinition</a></li>
+                               
+                                       <li><a href="../../MCollective/PluginPackager/StandardDefinition.html">MCollective::PluginPackager::StandardDefinition</a></li>
+                               
+                                       <li><a href="../../MCollective/RPC.html">MCollective::RPC</a></li>
+                               
+                                       <li><a href="../../MCollective/RPC/ActionRunner.html">MCollective::RPC::ActionRunner</a></li>
+                               
+                                       <li><a href="../../MCollective/RPC/Agent.html">MCollective::RPC::Agent</a></li>
+                               
+                                       <li><a href="../../MCollective/RPC/Audit.html">MCollective::RPC::Audit</a></li>
+                               
+                                       <li><a href="../../MCollective/RPC/Client.html">MCollective::RPC::Client</a></li>
+                               
+                                       <li><a href="../../MCollective/RPC/Helpers.html">MCollective::RPC::Helpers</a></li>
+                               
+                                       <li><a href="../../MCollective/RPC/Progress.html">MCollective::RPC::Progress</a></li>
+                               
+                                       <li><a href="../../MCollective/RPC/Reply.html">MCollective::RPC::Reply</a></li>
+                               
+                                       <li><a href="../../MCollective/RPC/Request.html">MCollective::RPC::Request</a></li>
+                               
+                                       <li><a href="../../MCollective/RPC/Result.html">MCollective::RPC::Result</a></li>
+                               
+                                       <li><a href="../../MCollective/RPC/Stats.html">MCollective::RPC::Stats</a></li>
+                               
+                                       <li><a href="../../MCollective/RPCAborted.html">MCollective::RPCAborted</a></li>
+                               
+                                       <li><a href="../../MCollective/RPCError.html">MCollective::RPCError</a></li>
+                               
+                                       <li><a href="../../MCollective/Registration.html">MCollective::Registration</a></li>
+                               
+                                       <li><a href="../../MCollective/Registration/Base.html">MCollective::Registration::Base</a></li>
+                               
+                                       <li><a href="../../MCollective/Runner.html">MCollective::Runner</a></li>
+                               
+                                       <li><a href="../../MCollective/RunnerStats.html">MCollective::RunnerStats</a></li>
+                               
+                                       <li><a href="../../MCollective/SSL.html">MCollective::SSL</a></li>
+                               
+                                       <li><a href="../../MCollective/Security.html">MCollective::Security</a></li>
+                               
+                                       <li><a href="../../MCollective/Security/Base.html">MCollective::Security::Base</a></li>
+                               
+                                       <li><a href="../../MCollective/SecurityValidationFailed.html">MCollective::SecurityValidationFailed</a></li>
+                               
+                                       <li><a href="../../MCollective/Shell.html">MCollective::Shell</a></li>
+                               
+                                       <li><a href="../../MCollective/Translatable.html">MCollective::Translatable</a></li>
+                               
+                                       <li><a href="../../MCollective/UnixDaemon.html">MCollective::UnixDaemon</a></li>
+                               
+                                       <li><a href="../../MCollective/UnknownRPCAction.html">MCollective::UnknownRPCAction</a></li>
+                               
+                                       <li><a href="../../MCollective/UnknownRPCError.html">MCollective::UnknownRPCError</a></li>
+                               
+                                       <li><a href="../../MCollective/Util.html">MCollective::Util</a></li>
+                               
+                                       <li><a href="../../MCollective/Validator.html">MCollective::Validator</a></li>
+                               
+                                       <li><a href="../../MCollective/ValidatorError.html">MCollective::ValidatorError</a></li>
+                               
+                                       <li><a href="../../MCollective/WindowsDaemon.html">MCollective::WindowsDaemon</a></li>
+                               
+                                       <li><a href="../../Array.html">Array</a></li>
+                               
+                                       <li><a href="../../Dir.html">Dir</a></li>
+                               
+                                       <li><a href="../../Object.html">Object</a></li>
+                               
+                                       <li><a href="../../String.html">String</a></li>
+                               
+                                       <li><a href="../../Symbol.html">Symbol</a></li>
+                               
+                               </ul>
+                               <div id="no-class-search-results" style="display: none;">No matching classes.</div>
+                       </div>
+
+                       
+               </div>
+       </div>
+
+       <div id="documentation">
+               <h1 class="class">MCollective::Registration::Base</h1>
+
+               <div id="description">
+                       <p>
+This is a base class that other registration plugins can use to handle
+regular announcements to the mcollective
+</p>
+<p>
+The configuration file determines how often registration messages gets sent
+using the <em>registerinterval</em> option, the plugin runs in the
+background in a thread.
+</p>
+
+               </div>
+
+               <!-- Constants -->
+               
+
+               <!-- Attributes -->
+               
+
+               <!-- Methods -->
+               
+               <div id="public-class-method-details" class="method-section section">
+                       <h3 class="section-header">Public Class Methods</h3>
+
+               
+                       <div id="inherited-method" class="method-detail ">
+                               <a name="M000151"></a>
+
+                               <div class="method-heading">
+                               
+                                       <span class="method-name">inherited</span><span
+                                               class="method-args">(klass)</span>
+                                       <span class="method-click-advice">click to toggle source</span>
+                               
+                               </div>
+
+                               <div class="method-description">
+                                       
+                                       <p>
+Register plugins that inherits base
+</p>
+                                       
+
+                                       
+                                       <div class="method-source-code"
+                                               id="inherited-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/mcollective/registration/base.rb, line 11</span>
+11:       <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>)
+12:         <span class="ruby-constant">PluginManager</span> <span class="ruby-operator">&lt;&lt;</span> {<span class="ruby-identifier">:type</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value str">&quot;registration_plugin&quot;</span>, <span class="ruby-identifier">:class</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">to_s</span>}
+13:       <span class="ruby-keyword kw">end</span></pre>
+                                       </div>
+                                       
+                               </div>
+
+                               
+                       </div>
+
+               
+               </div>
+       
+               <div id="public-instance-method-details" class="method-section section">
+                       <h3 class="section-header">Public Instance Methods</h3>
+
+               
+                       <div id="config-method" class="method-detail ">
+                               <a name="M000153"></a>
+
+                               <div class="method-heading">
+                               
+                                       <span class="method-name">config</span><span
+                                               class="method-args">()</span>
+                                       <span class="method-click-advice">click to toggle source</span>
+                               
+                               </div>
+
+                               <div class="method-description">
+                                       
+                                       <p class="missing-docs">(Not documented)</p>
+                                       
+
+                                       
+                                       <div class="method-source-code"
+                                               id="config-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/mcollective/registration/base.rb, line 36</span>
+36:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">config</span>
+37:         <span class="ruby-constant">Config</span>.<span class="ruby-identifier">instance</span>
+38:       <span class="ruby-keyword kw">end</span></pre>
+                                       </div>
+                                       
+                               </div>
+
+                               
+                       </div>
+
+               
+                       <div id="interval-method" class="method-detail ">
+                               <a name="M000158"></a>
+
+                               <div class="method-heading">
+                               
+                                       <span class="method-name">interval</span><span
+                                               class="method-args">()</span>
+                                       <span class="method-click-advice">click to toggle source</span>
+                               
+                               </div>
+
+                               <div class="method-description">
+                                       
+                                       <p class="missing-docs">(Not documented)</p>
+                                       
+
+                                       
+                                       <div class="method-source-code"
+                                               id="interval-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/mcollective/registration/base.rb, line 59</span>
+59:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">interval</span>
+60:         <span class="ruby-identifier">config</span>.<span class="ruby-identifier">registerinterval</span>
+61:       <span class="ruby-keyword kw">end</span></pre>
+                                       </div>
+                                       
+                               </div>
+
+                               
+                       </div>
+
+               
+                       <div id="msg-filter-method" class="method-detail ">
+                               <a name="M000154"></a>
+
+                               <div class="method-heading">
+                               
+                                       <span class="method-name">msg_filter</span><span
+                                               class="method-args">()</span>
+                                       <span class="method-click-advice">click to toggle source</span>
+                               
+                               </div>
+
+                               <div class="method-description">
+                                       
+                                       <p class="missing-docs">(Not documented)</p>
+                                       
+
+                                       
+                                       <div class="method-source-code"
+                                               id="msg-filter-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/mcollective/registration/base.rb, line 40</span>
+40:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">msg_filter</span>
+41:         <span class="ruby-identifier">filter</span> = <span class="ruby-constant">Util</span>.<span class="ruby-identifier">empty_filter</span>
+42:         <span class="ruby-identifier">filter</span>[<span class="ruby-value str">&quot;agent&quot;</span>] <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-value str">&quot;registration&quot;</span>
+43:         <span class="ruby-identifier">filter</span>
+44:       <span class="ruby-keyword kw">end</span></pre>
+                                       </div>
+                                       
+                               </div>
+
+                               
+                       </div>
+
+               
+                       <div id="publish-method" class="method-detail ">
+                               <a name="M000159"></a>
+
+                               <div class="method-heading">
+                               
+                                       <span class="method-name">publish</span><span
+                                               class="method-args">(message)</span>
+                                       <span class="method-click-advice">click to toggle source</span>
+                               
+                               </div>
+
+                               <div class="method-description">
+                                       
+                                       <p class="missing-docs">(Not documented)</p>
+                                       
+
+                                       
+                                       <div class="method-source-code"
+                                               id="publish-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/mcollective/registration/base.rb, line 63</span>
+63:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">publish</span>(<span class="ruby-identifier">message</span>)
+64:         <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">message</span>
+65:           <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-value str">&quot;Skipping registration due to nil body&quot;</span>)
+66:         <span class="ruby-keyword kw">else</span>
+67:           <span class="ruby-identifier">req</span> = <span class="ruby-constant">Message</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">message</span>, <span class="ruby-keyword kw">nil</span>, {<span class="ruby-identifier">:type</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">:request</span>, <span class="ruby-identifier">:agent</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value str">&quot;registration&quot;</span>, <span class="ruby-identifier">:collective</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">target_collective</span>, <span class="ruby-identifier">:filter</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">msg_filter</span>})
+68:           <span class="ruby-identifier">req</span>.<span class="ruby-identifier">encode!</span>
+69: 
+70:           <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-node">&quot;Sending registration #{req.requestid} to collective #{req.collective}&quot;</span>)
+71: 
+72:           <span class="ruby-identifier">req</span>.<span class="ruby-identifier">publish</span>
+73:         <span class="ruby-keyword kw">end</span>
+74:       <span class="ruby-keyword kw">end</span></pre>
+                                       </div>
+                                       
+                               </div>
+
+                               
+                       </div>
+
+               
+                       <div id="run-method" class="method-detail ">
+                               <a name="M000152"></a>
+
+                               <div class="method-heading">
+                               
+                                       <span class="method-name">run</span><span
+                                               class="method-args">(connection)</span>
+                                       <span class="method-click-advice">click to toggle source</span>
+                               
+                               </div>
+
+                               <div class="method-description">
+                                       
+                                       <p>
+Creates a background thread that periodically send a registration notice.
+</p>
+<p>
+The actual registration notices comes from the &#8216;body&#8217; method of
+the registration plugins.
+</p>
+                                       
+
+                                       
+                                       <div class="method-source-code"
+                                               id="run-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/mcollective/registration/base.rb, line 19</span>
+19:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">run</span>(<span class="ruby-identifier">connection</span>)
+20:         <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">interval</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
+21: 
+22:         <span class="ruby-constant">Thread</span>.<span class="ruby-identifier">new</span> <span class="ruby-keyword kw">do</span>
+23:           <span class="ruby-identifier">loop</span> <span class="ruby-keyword kw">do</span>
+24:             <span class="ruby-keyword kw">begin</span>
+25:               <span class="ruby-identifier">publish</span>(<span class="ruby-identifier">body</span>)
+26: 
+27:               <span class="ruby-identifier">sleep</span> <span class="ruby-identifier">interval</span>
+28:             <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">e</span>
+29:               <span class="ruby-constant">Log</span>.<span class="ruby-identifier">error</span>(<span class="ruby-node">&quot;Sending registration message failed: #{e}&quot;</span>)
+30:               <span class="ruby-identifier">sleep</span> <span class="ruby-identifier">interval</span>
+31:             <span class="ruby-keyword kw">end</span>
+32:           <span class="ruby-keyword kw">end</span>
+33:         <span class="ruby-keyword kw">end</span>
+34:       <span class="ruby-keyword kw">end</span></pre>
+                                       </div>
+                                       
+                               </div>
+
+                               
+                       </div>
+
+               
+                       <div id="target-collective-method" class="method-detail ">
+                               <a name="M000157"></a>
+
+                               <div class="method-heading">
+                               
+                                       <span class="method-name">target_collective</span><span
+                                               class="method-args">()</span>
+                                       <span class="method-click-advice">click to toggle source</span>
+                               
+                               </div>
+
+                               <div class="method-description">
+                                       
+                                       <p class="missing-docs">(Not documented)</p>
+                                       
+
+                                       
+                                       <div class="method-source-code"
+                                               id="target-collective-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/mcollective/registration/base.rb, line 46</span>
+46:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">target_collective</span>
+47:         <span class="ruby-identifier">main_collective</span> = <span class="ruby-identifier">config</span>.<span class="ruby-identifier">main_collective</span>
+48: 
+49:         <span class="ruby-identifier">collective</span> = <span class="ruby-identifier">config</span>.<span class="ruby-identifier">registration_collective</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">main_collective</span>
+50: 
+51:         <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">config</span>.<span class="ruby-identifier">collectives</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">collective</span>)
+52:           <span class="ruby-constant">Log</span>.<span class="ruby-identifier">warn</span>(<span class="ruby-node">&quot;Sending registration to #{main_collective}: #{collective} is not a valid collective&quot;</span>)
+53:           <span class="ruby-identifier">collective</span> = <span class="ruby-identifier">main_collective</span>
+54:         <span class="ruby-keyword kw">end</span>
+55: 
+56:         <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">collective</span>
+57:       <span class="ruby-keyword kw">end</span></pre>
+                                       </div>
+                                       
+                               </div>
+
+                               
+                       </div>
+
+               
+               </div>
+       
+
+       </div>
+
+
+       <div id="rdoc-debugging-section-dump" class="debugging-section">
+       
+               <p>Disabled; run with --debug to generate this.</p>
+       
+       </div>
+
+       <div id="validator-badges">
+               <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+               <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
+                       Rdoc Generator</a> 1.1.6</small>.</p>
+       </div>
+
+</body>
+</html>
+