-<?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">
-
+<?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>
- <title>Class: MCollective::Application</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::Application</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../files/lib/mcollective/application_rb.html">
- lib/mcollective/application.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="#M000347">[]</a>
- <a href="#M000346">[]=</a>
- <a href="#M000362">application_cli_arguments</a>
- <a href="#M000360">application_description</a>
- <a href="#M000363">application_failure</a>
- <a href="#M000345">application_options</a>
- <a href="#M000359">application_options</a>
- <a href="#M000357">application_parse_options</a>
- <a href="#M000361">application_usage</a>
- <a href="#M000356">clioptions</a>
- <a href="#M000353">configuration</a>
- <a href="#M000348">description</a>
- <a href="#M000366">disconnect</a>
- <a href="#M000350">exclude_argument_sections</a>
- <a href="#M000369">halt</a>
- <a href="#M000368">halt_code</a>
- <a href="#M000364">help</a>
- <a href="#M000352">intialize_application_options</a>
- <a href="#M000367">main</a>
- <a href="#M000351">option</a>
- <a href="#M000354">options</a>
- <a href="#M000370">rpcclient</a>
- <a href="#M000365">run</a>
- <a href="#M000349">usage</a>
- <a href="#M000358">validate_cli_options</a>
- <a href="#M000355">validate_option</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
- <div id="includes">
- <h3 class="section-bar">Included Modules</h3>
+ <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
- <div id="includes-list">
- <span class="include-name"><a href="RPC.html">RPC</a></span>
- </div>
- </div>
+ <title>Class: MCollective::Application</title>
- <div id="section">
+ <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>
-
-
-
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000347" class="method-detail">
- <a name="M000347"></a>
-
- <div class="method-heading">
- <a href="#M000347" class="method-signature">
- <span class="method-name">[]</span><span class="method-args">(option)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-retrieves a specific <a href="Application.html#M000351">option</a>
+</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/application_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/application.rb">lib/mcollective/application.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="#M000003">::[]</a></li>
+
+ <li><a href="#M000002">::[]=</a></li>
+
+ <li><a href="#M000001">::application_options</a></li>
+
+ <li><a href="#M000004">::description</a></li>
+
+ <li><a href="#M000006">::exclude_argument_sections</a></li>
+
+ <li><a href="#M000008">::intialize_application_options</a></li>
+
+ <li><a href="#M000007">::option</a></li>
+
+ <li><a href="#M000005">::usage</a></li>
+
+ <li><a href="#M000018">#application_cli_arguments</a></li>
+
+ <li><a href="#M000016">#application_description</a></li>
+
+ <li><a href="#M000019">#application_failure</a></li>
+
+ <li><a href="#M000015">#application_options</a></li>
+
+ <li><a href="#M000013">#application_parse_options</a></li>
+
+ <li><a href="#M000017">#application_usage</a></li>
+
+ <li><a href="#M000012">#clioptions</a></li>
+
+ <li><a href="#M000009">#configuration</a></li>
+
+ <li><a href="#M000025">#disconnect</a></li>
+
+ <li><a href="#M000029">#halt</a></li>
+
+ <li><a href="#M000027">#halt_code</a></li>
+
+ <li><a href="#M000022">#help</a></li>
+
+ <li><a href="#M000026">#main</a></li>
+
+ <li><a href="#M000010">#options</a></li>
+
+ <li><a href="#M000030">#rpcclient</a></li>
+
+ <li><a href="#M000023">#run</a></li>
+
+ <li><a href="#M000014">#validate_cli_options</a></li>
+
+ <li><a href="#M000011">#validate_option</a></li>
+
+ </ul>
+ </div>
+
+
+ <!-- Included Modules -->
+
+ <div id="includes-section" class="section">
+ <h3 class="section-header">Included Modules</h3>
+ <ul class="link-list">
+
+
+ <li><a class="include" href="Validator.html">MCollective::Validator</a></li>
+
+
+ </ul>
+ </div>
+
+ </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::Application</h1>
+
+ <div id="description">
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+
+ <!-- Methods -->
+
+ <div id="public-class-method-details" class="method-section section">
+ <h3 class="section-header">Public Class Methods</h3>
+
+
+ <div id="--method" class="method-detail ">
+ <a name="M000003"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">[]</span><span
+ class="method-args">(option)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+retrieves a specific option
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000347-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000347-source">
+
+
+
+ <div class="method-source-code"
+ id="--source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/application.rb, line 20</span>
20: <span class="ruby-keyword kw">def</span> <span class="ruby-operator">[]</span>(<span class="ruby-identifier">option</span>)
21: <span class="ruby-identifier">intialize_application_options</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@application_options</span>
22: <span class="ruby-ivar">@application_options</span>[<span class="ruby-identifier">option</span>]
-23: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000346" class="method-detail">
- <a name="M000346"></a>
-
- <div class="method-heading">
- <a href="#M000346" class="method-signature">
- <span class="method-name">[]=</span><span class="method-args">(option, value)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-set an <a href="Application.html#M000351">option</a> in the <a
-href="Application.html#M000354">options</a> hash
+23: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="--method" class="method-detail ">
+ <a name="M000002"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">[]=</span><span
+ class="method-args">(option, value)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+set an option in the options hash
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000346-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000346-source">
+
+
+
+ <div class="method-source-code"
+ id="--source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/application.rb, line 14</span>
14: <span class="ruby-keyword kw">def</span> <span class="ruby-operator">[]=</span>(<span class="ruby-identifier">option</span>, <span class="ruby-identifier">value</span>)
15: <span class="ruby-identifier">intialize_application_options</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@application_options</span>
16: <span class="ruby-ivar">@application_options</span>[<span class="ruby-identifier">option</span>] = <span class="ruby-identifier">value</span>
-17: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000345" class="method-detail">
- <a name="M000345"></a>
-
- <div class="method-heading">
- <a href="#M000345" class="method-signature">
- <span class="method-name">application_options</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Intialize a blank set of <a href="Application.html#M000354">options</a> if
-its the first time used else returns active <a
-href="Application.html#M000354">options</a>
+17: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="application-options-method" class="method-detail ">
+ <a name="M000001"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">application_options</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Intialize a blank set of options if its the first time used else returns
+active options
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000345-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000345-source">
+
+
+
+ <div class="method-source-code"
+ id="application-options-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/application.rb, line 8</span>
8: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">application_options</span>
9: <span class="ruby-identifier">intialize_application_options</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@application_options</span>
10: <span class="ruby-ivar">@application_options</span>
-11: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000348" class="method-detail">
- <a name="M000348"></a>
-
- <div class="method-heading">
- <a href="#M000348" class="method-signature">
- <span class="method-name">description</span><span class="method-args">(descr)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Sets the application <a href="Application.html#M000348">description</a>,
-there can be only one <a href="Application.html#M000348">description</a>
-per application so multiple calls will just change the <a
-href="Application.html#M000348">description</a>
+11: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="description-method" class="method-detail ">
+ <a name="M000004"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">description</span><span
+ class="method-args">(descr)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Sets the application description, there can be only one description per
+application so multiple calls will just change the description
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000348-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000348-source">
+
+
+
+ <div class="method-source-code"
+ id="description-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/application.rb, line 28</span>
28: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">description</span>(<span class="ruby-identifier">descr</span>)
29: <span class="ruby-keyword kw">self</span>[<span class="ruby-identifier">:description</span>] = <span class="ruby-identifier">descr</span>
-30: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000350" class="method-detail">
- <a name="M000350"></a>
-
- <div class="method-heading">
- <a href="#M000350" class="method-signature">
- <span class="method-name">exclude_argument_sections</span><span class="method-args">(*sections)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000350-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000350-source">
+30: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="exclude-argument-sections-method" class="method-detail ">
+ <a name="M000006"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">exclude_argument_sections</span><span
+ class="method-args">(*sections)</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="exclude-argument-sections-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/application.rb, line 38</span>
38: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">exclude_argument_sections</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">sections</span>)
44:
45: <span class="ruby-identifier">intialize_application_options</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@application_options</span>
46: <span class="ruby-keyword kw">self</span>[<span class="ruby-identifier">:exclude_arg_sections</span>] = <span class="ruby-identifier">sections</span>
-47: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000352" class="method-detail">
- <a name="M000352"></a>
-
- <div class="method-heading">
- <a href="#M000352" class="method-signature">
- <span class="method-name">intialize_application_options</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Creates an empty set of <a href="Application.html#M000354">options</a>
+47: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="intialize-application-options-method" class="method-detail ">
+ <a name="M000008"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">intialize_application_options</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Creates an empty set of options
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000352-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000352-source">
+
+
+
+ <div class="method-source-code"
+ id="intialize-application-options-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/application.rb, line 79</span>
79: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">intialize_application_options</span>
81: <span class="ruby-identifier">:usage</span> =<span class="ruby-operator">></span> [],
82: <span class="ruby-identifier">:cli_arguments</span> =<span class="ruby-operator">></span> [],
83: <span class="ruby-identifier">:exclude_arg_sections</span> =<span class="ruby-operator">></span> []}
-84: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000351" class="method-detail">
- <a name="M000351"></a>
-
- <div class="method-heading">
- <a href="#M000351" class="method-signature">
- <span class="method-name">option</span><span class="method-args">(name, arguments)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Wrapper to create command line <a
-href="Application.html#M000354">options</a>
+84: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="option-method" class="method-detail ">
+ <a name="M000007"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">option</span><span
+ class="method-args">(name, arguments)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Wrapper to create command line options
</p>
<pre>
- name: varaible name that will be used to access the option value
:arguments => ["--foo ARG"]
</pre>
<p>
-after this the value supplied will be in <a
-href="Application.html#M000353">configuration</a>[:foo]
+after this the value supplied will be in configuration[:foo]
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000351-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000351-source">
+
+
+
+ <div class="method-source-code"
+ id="option-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/application.rb, line 65</span>
65: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">option</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">arguments</span>)
73: <span class="ruby-identifier">arguments</span>.<span class="ruby-identifier">each_pair</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">k</span>,<span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-identifier">opt</span>[<span class="ruby-identifier">k</span>] = <span class="ruby-identifier">v</span>}
74:
75: <span class="ruby-keyword kw">self</span>[<span class="ruby-identifier">:cli_arguments</span>] <span class="ruby-operator"><<</span> <span class="ruby-identifier">opt</span>
-76: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000349" class="method-detail">
- <a name="M000349"></a>
-
- <div class="method-heading">
- <a href="#M000349" class="method-signature">
- <span class="method-name">usage</span><span class="method-args">(usage)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Supplies <a href="Application.html#M000349">usage</a> information, calling
-multiple times will create multiple <a
-href="Application.html#M000349">usage</a> lines in —<a
-href="Application.html#M000364">help</a> output
+76: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="usage-method" class="method-detail ">
+ <a name="M000005"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">usage</span><span
+ class="method-args">(usage)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Supplies usage information, calling multiple times will create multiple
+usage lines in —help output
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000349-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000349-source">
+
+
+
+ <div class="method-source-code"
+ id="usage-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/application.rb, line 34</span>
34: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">usage</span>(<span class="ruby-identifier">usage</span>)
35: <span class="ruby-keyword kw">self</span>[<span class="ruby-identifier">:usage</span>] <span class="ruby-operator"><<</span> <span class="ruby-identifier">usage</span>
-36: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000362" class="method-detail">
- <a name="M000362"></a>
-
- <div class="method-heading">
- <a href="#M000362" class="method-signature">
- <span class="method-name">application_cli_arguments</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+36: <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="application-cli-arguments-method" class="method-detail ">
+ <a name="M000018"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">application_cli_arguments</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Returns an array of all the arguments built using calls to optin
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000362-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000362-source">
+
+
+
+ <div class="method-source-code"
+ id="application-cli-arguments-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/application.rb, line 247</span>
247: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">application_cli_arguments</span>
248: <span class="ruby-identifier">application_options</span>[<span class="ruby-identifier">:cli_arguments</span>]
-249: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000360" class="method-detail">
- <a name="M000360"></a>
-
- <div class="method-heading">
- <a href="#M000360" class="method-signature">
- <span class="method-name">application_description</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Retrieve the current application <a
-href="Application.html#M000348">description</a>
+249: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="application-description-method" class="method-detail ">
+ <a name="M000016"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">application_description</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Retrieve the current application description
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000360-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000360-source">
+
+
+
+ <div class="method-source-code"
+ id="application-description-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/application.rb, line 234</span>
234: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">application_description</span>
235: <span class="ruby-identifier">application_options</span>[<span class="ruby-identifier">:description</span>]
-236: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000363" class="method-detail">
- <a name="M000363"></a>
-
- <div class="method-heading">
- <a href="#M000363" class="method-signature">
- <span class="method-name">application_failure</span><span class="method-args">(e, err_dest=STDERR)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Handles failure, if we‘re far enough in the initialization phase it
+236: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="application-failure-method" class="method-detail ">
+ <a name="M000019"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">application_failure</span><span
+ class="method-args">(e, err_dest=STDERR)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Handles failure, if we’re far enough in the initialization phase it
will log backtraces if its in verbose mode only
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000363-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000363-source">
+
+
+
+ <div class="method-source-code"
+ id="application-failure-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/application.rb, line 253</span>
253: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">application_failure</span>(<span class="ruby-identifier">e</span>, <span class="ruby-identifier">err_dest</span>=<span class="ruby-constant">STDERR</span>)
283: <span class="ruby-identifier">disconnect</span>
284:
285: <span class="ruby-identifier">exit</span> <span class="ruby-value">1</span>
-286: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000359" class="method-detail">
- <a name="M000359"></a>
-
- <div class="method-heading">
- <a href="#M000359" class="method-signature">
- <span class="method-name">application_options</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Retrieves the full hash of application <a
-href="Application.html#M000354">options</a>
+286: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="application-options-method" class="method-detail ">
+ <a name="M000015"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">application_options</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Retrieves the full hash of application options
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000359-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000359-source">
+
+
+
+ <div class="method-source-code"
+ id="application-options-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/application.rb, line 229</span>
229: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">application_options</span>
230: <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">application_options</span>
-231: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000357" class="method-detail">
- <a name="M000357"></a>
-
- <div class="method-heading">
- <a href="#M000357" class="method-signature">
- <span class="method-name">application_parse_options</span><span class="method-args">(help=false)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Builds an ObjectParser config, parse the CLI <a
-href="Application.html#M000354">options</a> and validates based on the <a
-href="Application.html#M000351">option</a> config
+231: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="application-parse-options-method" class="method-detail ">
+ <a name="M000013"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">application_parse_options</span><span
+ class="method-args">(help=false)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Builds an ObjectParser config, parse the CLI options and validates based on
+the option config
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000357-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000357-source">
+
+
+
+ <div class="method-source-code"
+ id="application-parse-options-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/application.rb, line 135</span>
135: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">application_parse_options</span>(<span class="ruby-identifier">help</span>=<span class="ruby-keyword kw">false</span>)
202: <span class="ruby-keyword kw">end</span>
203: <span class="ruby-keyword kw">end</span>
204: <span class="ruby-keyword kw">end</span>
-205: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000361" class="method-detail">
- <a name="M000361"></a>
-
- <div class="method-heading">
- <a href="#M000361" class="method-signature">
- <span class="method-name">application_usage</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Return the current <a href="Application.html#M000349">usage</a> text false
-if nothing is set
+205: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="application-usage-method" class="method-detail ">
+ <a name="M000017"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">application_usage</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Return the current usage text false if nothing is set
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000361-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000361-source">
+
+
+
+ <div class="method-source-code"
+ id="application-usage-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/application.rb, line 239</span>
239: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">application_usage</span>
240: <span class="ruby-identifier">usage</span> = <span class="ruby-identifier">application_options</span>[<span class="ruby-identifier">:usage</span>]
241:
242: <span class="ruby-identifier">usage</span>.<span class="ruby-identifier">empty?</span> <span class="ruby-value">? </span><span class="ruby-keyword kw">false</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">usage</span>
-243: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000356" class="method-detail">
- <a name="M000356"></a>
-
- <div class="method-heading">
- <a href="#M000356" class="method-signature">
- <span class="method-name">clioptions</span><span class="method-args">(help) {|parser, options| ...}</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Creates a standard <a href="Application.html#M000354">options</a> hash,
-pass in a block to add extra headings etc see <a
-href="Optionparser.html">Optionparser</a>
+243: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="clioptions-method" class="method-detail ">
+ <a name="M000012"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">clioptions</span><span
+ class="method-args">(help)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Creates a standard options hash, pass in a block to add extra headings etc
+see <a href="Optionparser.html">Optionparser</a>
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000356-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000356-source">
+
+
+
+ <div class="method-source-code"
+ id="clioptions-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/application.rb, line 111</span>
111: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">clioptions</span>(<span class="ruby-identifier">help</span>)
128: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">options</span>
129: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
130: <span class="ruby-identifier">application_failure</span>(<span class="ruby-identifier">e</span>)
-131: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000353" class="method-detail">
- <a name="M000353"></a>
-
- <div class="method-heading">
- <a href="#M000353" class="method-signature">
- <span class="method-name">configuration</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-The application <a href="Application.html#M000353">configuration</a> built
-from CLI arguments
+131: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="configuration-method" class="method-detail ">
+ <a name="M000009"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">configuration</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+The application configuration built from CLI arguments
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000353-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000353-source">
+
+
+
+ <div class="method-source-code"
+ id="configuration-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/application.rb, line 88</span>
88: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">configuration</span>
89: <span class="ruby-ivar">@application_configuration</span> <span class="ruby-operator">||=</span> {}
90: <span class="ruby-ivar">@application_configuration</span>
-91: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000366" class="method-detail">
- <a name="M000366"></a>
-
- <div class="method-heading">
- <a href="#M000366" class="method-signature">
- <span class="method-name">disconnect</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000366-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000366-source">
+91: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="disconnect-method" class="method-detail ">
+ <a name="M000025"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">disconnect</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="disconnect-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/application.rb, line 310</span>
310: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">disconnect</span>
311: <span class="ruby-constant">MCollective</span><span class="ruby-operator">::</span><span class="ruby-constant">PluginManager</span>[<span class="ruby-value str">"connector_plugin"</span>].<span class="ruby-identifier">disconnect</span>
312: <span class="ruby-keyword kw">rescue</span>
-313: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000369" class="method-detail">
- <a name="M000369"></a>
-
- <div class="method-heading">
- <a href="#M000369" class="method-signature">
- <span class="method-name">halt</span><span class="method-args">(stats)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+313: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="halt-method" class="method-detail ">
+ <a name="M000029"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">halt</span><span
+ class="method-args">(stats)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
A helper that creates a consistent exit code for applications by looking at
an instance of <a href="RPC/Stats.html">MCollective::RPC::Stats</a>
</p>
<p>
Exit with 0 if nodes were discovered and all passed Exit with 0 if no
-discovery were done and > 0 responses were received, all ok Exit with 1
-if no nodes were discovered Exit with 2 if nodes were discovered but some
-<a href="RPC.html">RPC</a> requests failed Exit with 3 if nodes were
+discovery were done and > 0 responses were received, all ok Exit with 1 if
+no nodes were discovered Exit with 2 if nodes were discovered but some <a
+href="RPC.html">RPC</a> requests failed Exit with 3 if nodes were
discovered, but no responses received Exit with 4 if no discovery were done
and no responses were received
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000369-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000369-source">
+
+
+
+ <div class="method-source-code"
+ id="halt-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/application.rb, line 345</span>
345: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">halt</span>(<span class="ruby-identifier">stats</span>)
346: <span class="ruby-identifier">exit</span>(<span class="ruby-identifier">halt_code</span>(<span class="ruby-identifier">stats</span>))
-347: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000368" class="method-detail">
- <a name="M000368"></a>
-
- <div class="method-heading">
- <a href="#M000368" class="method-signature">
- <span class="method-name">halt_code</span><span class="method-args">(stats)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000368-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000368-source">
+347: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="halt-code-method" class="method-detail ">
+ <a name="M000027"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">halt_code</span><span
+ class="method-args">(stats)</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="halt-code-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/application.rb, line 322</span>
322: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">halt_code</span>(<span class="ruby-identifier">stats</span>)
331: <span class="ruby-keyword kw">return</span> <span class="ruby-value">1</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">request_stats</span>[<span class="ruby-identifier">:discovered</span>] <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
332: <span class="ruby-keyword kw">return</span> <span class="ruby-value">0</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">request_stats</span>[<span class="ruby-identifier">:discoverytime</span>] <span class="ruby-operator">==</span> <span class="ruby-value">0</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">request_stats</span>[<span class="ruby-identifier">:discovered</span>] <span class="ruby-operator">==</span> <span class="ruby-identifier">request_stats</span>[<span class="ruby-identifier">:okcount</span>]
333: <span class="ruby-keyword kw">return</span> <span class="ruby-value">0</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">request_stats</span>[<span class="ruby-identifier">:discovered</span>] <span class="ruby-operator">==</span> <span class="ruby-identifier">request_stats</span>[<span class="ruby-identifier">:okcount</span>]
-334: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000364" class="method-detail">
- <a name="M000364"></a>
-
- <div class="method-heading">
- <a href="#M000364" class="method-signature">
- <span class="method-name">help</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000364-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000364-source">
+334: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="help-method" class="method-detail ">
+ <a name="M000022"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">help</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="help-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/application.rb, line 288</span>
288: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">help</span>
289: <span class="ruby-identifier">application_parse_options</span>(<span class="ruby-keyword kw">true</span>)
-290: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000367" class="method-detail">
- <a name="M000367"></a>
-
- <div class="method-heading">
- <a href="#M000367" class="method-signature">
- <span class="method-name">main</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+290: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="main-method" class="method-detail ">
+ <a name="M000026"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">main</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Fake abstract class that logs if the user tries to use an application
-without supplying a <a href="Application.html#M000367">main</a> override
-method.
+without supplying a main override method.
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000367-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000367-source">
+
+
+
+ <div class="method-source-code"
+ id="main-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/application.rb, line 317</span>
317: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">main</span>
318: <span class="ruby-constant">STDERR</span>.<span class="ruby-identifier">puts</span> <span class="ruby-value str">"Applications need to supply a 'main' method"</span>
319: <span class="ruby-identifier">exit</span> <span class="ruby-value">1</span>
-320: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000354" class="method-detail">
- <a name="M000354"></a>
-
- <div class="method-heading">
- <a href="#M000354" class="method-signature">
- <span class="method-name">options</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-The active <a href="Application.html#M000354">options</a> hash used for
-MC::Client and other <a href="Application.html#M000353">configuration</a>
+320: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="options-method" class="method-detail ">
+ <a name="M000010"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">options</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+The active options hash used for MC::Client and other configuration
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000354-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000354-source">
+
+
+
+ <div class="method-source-code"
+ id="options-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/application.rb, line 94</span>
94: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">options</span>
95: <span class="ruby-ivar">@options</span>
-96: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000370" class="method-detail">
- <a name="M000370"></a>
-
- <div class="method-heading">
- <a href="#M000370" class="method-signature">
- <span class="method-name">rpcclient</span><span class="method-args">(agent, flags = {})</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Wrapper around <a href="RPC.html#M000037">MC::RPC#rpcclient</a> that
-forcably supplies our <a href="Application.html#M000354">options</a> hash
-if someone forgets to pass in <a
-href="Application.html#M000354">options</a> in an application the filters
-and other cli <a href="Application.html#M000354">options</a> wouldnt take
-effect which could have a disasterous outcome
+96: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="rpcclient-method" class="method-detail ">
+ <a name="M000030"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">rpcclient</span><span
+ class="method-args">(agent, flags = {})</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Wrapper around MC::RPC#rpcclient that forcably supplies our options hash if
+someone forgets to pass in options in an application the filters and other
+cli options wouldnt take effect which could have a disasterous outcome
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000370-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000370-source">
+
+
+
+ <div class="method-source-code"
+ id="rpcclient-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/application.rb, line 352</span>
352: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">rpcclient</span>(<span class="ruby-identifier">agent</span>, <span class="ruby-identifier">flags</span> = {})
354: <span class="ruby-identifier">flags</span>[<span class="ruby-identifier">:exit_on_failure</span>] = <span class="ruby-keyword kw">false</span>
355:
356: <span class="ruby-keyword kw">super</span>
-357: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000365" class="method-detail">
- <a name="M000365"></a>
-
- <div class="method-heading">
- <a href="#M000365" class="method-signature">
- <span class="method-name">run</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-The <a href="Application.html#M000367">main</a> logic loop, builds up the
-<a href="Application.html#M000354">options</a>, validate <a
-href="Application.html#M000353">configuration</a> and calls the <a
-href="Application.html#M000367">main</a> as supplied by the user.
-Disconnects when done and pass any exception onto the <a
-href="Application.html#M000363">application_failure</a> helper
+357: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="run-method" class="method-detail ">
+ <a name="M000023"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">run</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+The main logic loop, builds up the options, validate configuration and
+calls the main as supplied by the user. Disconnects when done and pass any
+exception onto the <a
+href="Application.html#M000019">application_failure</a> helper
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000365-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000365-source">
+
+
+
+ <div class="method-source-code"
+ id="run-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/application.rb, line 295</span>
295: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">run</span>
305:
306: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
307: <span class="ruby-identifier">application_failure</span>(<span class="ruby-identifier">e</span>)
-308: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000358" class="method-detail">
- <a name="M000358"></a>
-
- <div class="method-heading">
- <a href="#M000358" class="method-signature">
- <span class="method-name">validate_cli_options</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000358-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000358-source">
+308: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="validate-cli-options-method" class="method-detail ">
+ <a name="M000014"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">validate_cli_options</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="validate-cli-options-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/application.rb, line 207</span>
207: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">validate_cli_options</span>
223: <span class="ruby-keyword kw">end</span>
224:
225:
-226: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000355" class="method-detail">
- <a name="M000355"></a>
-
- <div class="method-heading">
- <a href="#M000355" class="method-signature">
- <span class="method-name">validate_option</span><span class="method-args">(blk, name, value)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Calls the supplied block in an <a
-href="Application.html#M000351">option</a> for validation, an error raised
-will log to STDERR and exit the application
+226: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="validate-option-method" class="method-detail ">
+ <a name="M000011"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">validate_option</span><span
+ class="method-args">(blk, name, value)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Calls the supplied block in an option for validation, an error raised will
+log to STDERR and exit the application
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000355-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000355-source">
+
+
+
+ <div class="method-source-code"
+ id="validate-option-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/application.rb, line 100</span>
100: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">validate_option</span>(<span class="ruby-identifier">blk</span>, <span class="ruby-identifier">name</span>, <span class="ruby-identifier">value</span>)
104: <span class="ruby-constant">STDERR</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">"Validation of #{name} failed: #{validation_result}"</span>
105: <span class="ruby-identifier">exit</span> <span class="ruby-value">1</span>
106: <span class="ruby-keyword kw">end</span>
-107: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
+107: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+ </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>
-</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>
\ No newline at end of file
+</html>
+
Code Review / packages / precise / mcollective.git / blobdiff