+++ /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::Registration::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::Registration::Base</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../../files/lib/mcollective/registration/base_rb.html">
- lib/mcollective/registration/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>
-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>
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000192">config</a>
- <a href="#M000190">inherited</a>
- <a href="#M000195">interval</a>
- <a href="#M000193">msg_filter</a>
- <a href="#M000196">publish</a>
- <a href="#M000191">run</a>
- <a href="#M000194">target_collective</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000190" class="method-detail">
- <a name="M000190"></a>
-
- <div class="method-heading">
- <a href="#M000190" 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('M000190-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000190-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"><<</span> {<span class="ruby-identifier">:type</span> =<span class="ruby-operator">></span> <span class="ruby-value str">"registration_plugin"</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>}
-13: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000192" class="method-detail">
- <a name="M000192"></a>
-
- <div class="method-heading">
- <a href="#M000192" class="method-signature">
- <span class="method-name">config</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000192-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000192-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="method-M000195" class="method-detail">
- <a name="M000195"></a>
-
- <div class="method-heading">
- <a href="#M000195" class="method-signature">
- <span class="method-name">interval</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000195-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000195-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="method-M000193" class="method-detail">
- <a name="M000193"></a>
-
- <div class="method-heading">
- <a href="#M000193" class="method-signature">
- <span class="method-name">msg_filter</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000193-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000193-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">"agent"</span>] <span class="ruby-operator"><<</span> <span class="ruby-value str">"registration"</span>
-43: <span class="ruby-identifier">filter</span>
-44: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000196" class="method-detail">
- <a name="M000196"></a>
-
- <div class="method-heading">
- <a href="#M000196" class="method-signature">
- <span class="method-name">publish</span><span class="method-args">(message)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000196-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000196-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">"Skipping registration due to nil body"</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">></span> <span class="ruby-identifier">:request</span>, <span class="ruby-identifier">:agent</span> =<span class="ruby-operator">></span> <span class="ruby-value str">"registration"</span>, <span class="ruby-identifier">:collective</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">target_collective</span>, <span class="ruby-identifier">:filter</span> =<span class="ruby-operator">></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">"Sending registration #{req.requestid} to collective #{req.collective}"</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="method-M000191" class="method-detail">
- <a name="M000191"></a>
-
- <div class="method-heading">
- <a href="#M000191" class="method-signature">
- <span class="method-name">run</span><span class="method-args">(connection)</span>
- </a>
- </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 ‘body’ method of
-the registration plugins.
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000191-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000191-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">></span> <span class="ruby-identifier">e</span>
-29: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">error</span>(<span class="ruby-node">"Sending registration message failed: #{e}"</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="method-M000194" class="method-detail">
- <a name="M000194"></a>
-
- <div class="method-heading">
- <a href="#M000194" class="method-signature">
- <span class="method-name">target_collective</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000194-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000194-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">"Sending registration to #{main_collective}: #{collective} is not a valid collective"</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="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