-<?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::RPC::Client</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>
-
-
+ <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::RPC::Client</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../../files/lib/mcollective/rpc/client_rb.html">
- lib/mcollective/rpc/client.rb
- </a>
- <br />
- </td>
- </tr>
+ <title>Class: MCollective::RPC::Client</title>
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- Object
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
+ <link rel="stylesheet" href="../../rdoc.css" type="text/css" media="screen" />
- <div id="bodyContent">
+ <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>
-
-
- <div id="contextContent">
-
- <div id="description">
- <p>
+</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/rpc/client_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/rpc/client.rb">lib/mcollective/rpc/client.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="#M000443">::new</a></li>
+
+ <li><a href="#M000461">#agent_filter</a></li>
+
+ <li><a href="#M000475">#aggregate_reply</a></li>
+
+ <li><a href="#M000471">#batch_size=</a></li>
+
+ <li><a href="#M000472">#batch_sleep_time=</a></li>
+
+ <li><a href="#M000480">#call_agent</a></li>
+
+ <li><a href="#M000479">#call_agent_batched</a></li>
+
+ <li><a href="#M000459">#class_filter</a></li>
+
+ <li><a href="#M000468">#collective=</a></li>
+
+ <li><a href="#M000463">#compound_filter</a></li>
+
+ <li><a href="#M000454">#custom_request</a></li>
+
+ <li><a href="#M000446">#disconnect</a></li>
+
+ <li><a href="#M000466">#discover</a></li>
+
+ <li><a href="#M000457">#discovery_method=</a></li>
+
+ <li><a href="#M000458">#discovery_options=</a></li>
+
+ <li><a href="#M000455">#discovery_timeout</a></li>
+
+ <li><a href="#M000456">#discovery_timeout=</a></li>
+
+ <li><a href="#M000460">#fact_filter</a></li>
+
+ <li><a href="#M000477">#fire_and_forget_request</a></li>
+
+ <li><a href="#M000447">#help</a></li>
+
+ <li><a href="#M000462">#identity_filter</a></li>
+
+ <li><a href="#M000478">#identity_filter_discovery_optimization</a></li>
+
+ <li><a href="#M000470">#limit_method=</a></li>
+
+ <li><a href="#M000469">#limit_targets=</a></li>
+
+ <li><a href="#M000474">#load_aggregate_functions</a></li>
+
+ <li><a href="#M000452">#method_missing</a></li>
+
+ <li><a href="#M000448">#new_request</a></li>
+
+ <li><a href="#M000467">#options</a></li>
+
+ <li><a href="#M000473">#pick_nodes_from_discovered</a></li>
+
+ <li><a href="#M000485">#process_results_with_block</a></li>
+
+ <li><a href="#M000481">#process_results_without_block</a></li>
+
+ <li><a href="#M000464">#reset</a></li>
+
+ <li><a href="#M000465">#reset_filter</a></li>
+
+ <li><a href="#M000476">#rpc_result_from_reply</a></li>
+
+ <li><a href="#M000449">#validate_request</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::RPC::Client</h1>
+
+ <div id="description">
+ <p>
The main component of the Simple <a href="../RPC.html">RPC</a> client
system, this wraps around <a href="../Client.html">MCollective::Client</a>
and just brings in a lot of convention and standard approached.
</p>
- </div>
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000098">agent_filter</a>
- <a href="#M000112">aggregate_reply</a>
- <a href="#M000108">batch_size=</a>
- <a href="#M000109">batch_sleep_time=</a>
- <a href="#M000117">call_agent</a>
- <a href="#M000116">call_agent_batched</a>
- <a href="#M000096">class_filter</a>
- <a href="#M000105">collective=</a>
- <a href="#M000100">compound_filter</a>
- <a href="#M000091">custom_request</a>
- <a href="#M000086">disconnect</a>
- <a href="#M000103">discover</a>
- <a href="#M000094">discovery_method=</a>
- <a href="#M000095">discovery_options=</a>
- <a href="#M000092">discovery_timeout</a>
- <a href="#M000093">discovery_timeout=</a>
- <a href="#M000097">fact_filter</a>
- <a href="#M000114">fire_and_forget_request</a>
- <a href="#M000087">help</a>
- <a href="#M000099">identity_filter</a>
- <a href="#M000115">identity_filter_discovery_optimization</a>
- <a href="#M000107">limit_method=</a>
- <a href="#M000106">limit_targets=</a>
- <a href="#M000111">load_aggregate_functions</a>
- <a href="#M000090">method_missing</a>
- <a href="#M000085">new</a>
- <a href="#M000088">new_request</a>
- <a href="#M000104">options</a>
- <a href="#M000110">pick_nodes_from_discovered</a>
- <a href="#M000119">process_results_with_block</a>
- <a href="#M000118">process_results_without_block</a>
- <a href="#M000101">reset</a>
- <a href="#M000102">reset_filter</a>
- <a href="#M000113">rpc_result_from_reply</a>
- <a href="#M000089">validate_request</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
- <div id="attribute-list">
- <h3 class="section-bar">Attributes</h3>
-
- <div class="name-list">
- <table>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">agent</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">batch_mode</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">batch_size</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">batch_sleep_time</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">client</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">config</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">ddl</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">default_discovery_method</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">discovery_method</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">discovery_options</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">filter</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">limit_method</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">limit_seed</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">limit_targets</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">output_format</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">progress</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">reply_to</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">stats</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">timeout</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">ttl</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">verbose</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- </table>
- </div>
- </div>
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000085" class="method-detail">
- <a name="M000085"></a>
-
- <div class="method-heading">
- <a href="#M000085" class="method-signature">
- <span class="method-name">new</span><span class="method-args">(agent, flags = {}) {|parser, opts| ...}</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Creates a stub for a remote agent, you can pass in an <a
-href="Client.html#M000104">options</a> array in the flags which will then
-be used else it will just create a default <a
-href="Client.html#M000104">options</a> array with filtering enabled based
-on the standard command line use.
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+ <div id="attribute-method-details" class="method-section section">
+ <h3 class="section-header">Attributes</h3>
+
+
+ <div id="timeout-attribute-method" class="method-detail">
+ <a name="timeout"></a>
+
+ <a name="timeout="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">timeout</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="verbose-attribute-method" class="method-detail">
+ <a name="verbose"></a>
+
+ <a name="verbose="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">verbose</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="filter-attribute-method" class="method-detail">
+ <a name="filter"></a>
+
+ <a name="filter="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">filter</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="config-attribute-method" class="method-detail">
+ <a name="config"></a>
+
+ <a name="config="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">config</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="progress-attribute-method" class="method-detail">
+ <a name="progress"></a>
+
+ <a name="progress="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">progress</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="ttl-attribute-method" class="method-detail">
+ <a name="ttl"></a>
+
+ <a name="ttl="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">ttl</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="reply-to-attribute-method" class="method-detail">
+ <a name="reply_to"></a>
+
+ <a name="reply_to="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">reply_to</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="client-attribute-method" class="method-detail">
+ <a name="client"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">client</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="stats-attribute-method" class="method-detail">
+ <a name="stats"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">stats</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="ddl-attribute-method" class="method-detail">
+ <a name="ddl"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">ddl</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="agent-attribute-method" class="method-detail">
+ <a name="agent"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">agent</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="limit-targets-attribute-method" class="method-detail">
+ <a name="limit_targets"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">limit_targets</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="limit-method-attribute-method" class="method-detail">
+ <a name="limit_method"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">limit_method</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="output-format-attribute-method" class="method-detail">
+ <a name="output_format"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">output_format</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="batch-size-attribute-method" class="method-detail">
+ <a name="batch_size"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">batch_size</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="batch-sleep-time-attribute-method" class="method-detail">
+ <a name="batch_sleep_time"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">batch_sleep_time</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="batch-mode-attribute-method" class="method-detail">
+ <a name="batch_mode"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">batch_mode</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="discovery-options-attribute-method" class="method-detail">
+ <a name="discovery_options"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">discovery_options</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="discovery-method-attribute-method" class="method-detail">
+ <a name="discovery_method"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">discovery_method</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="default-discovery-method-attribute-method" class="method-detail">
+ <a name="default_discovery_method"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">default_discovery_method</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="limit-seed-attribute-method" class="method-detail">
+ <a name="limit_seed"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">limit_seed</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ </div>
+
+
+ <!-- Methods -->
+
+ <div id="public-class-method-details" class="method-section section">
+ <h3 class="section-header">Public Class Methods</h3>
+
+
+ <div id="new-method" class="method-detail ">
+ <a name="M000443"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">new</span><span
+ class="method-args">(agent, flags = {})</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Creates a stub for a remote agent, you can pass in an options array in the
+flags which will then be used else it will just create a default options
+array with filtering enabled based on the standard command line use.
</p>
<pre>
rpc = RPC::Client.new("rpctest", :configfile => "client.cfg", :options => options)
</pre>
<p>
-You typically would not call this directly you̵
6;d use <a
-href="../RPC.html#M000037">MCollective::RPC#rpcclient</a> instead which is
+You typically would not call this directly you̵
7;d use <a
+href="../RPC.html#M000314">MCollective::RPC#rpcclient</a> instead which is
a wrapper around this that can be used as a Mixin
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000085-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000085-source">
+
+
+
+ <div class="method-source-code"
+ id="new-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 20</span>
20: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">agent</span>, <span class="ruby-identifier">flags</span> = {})
115: <span class="ruby-ivar">@stdout</span> = <span class="ruby-constant">STDOUT</span>
116: <span class="ruby-ivar">@stdout</span>.<span class="ruby-identifier">sync</span> = <span class="ruby-keyword kw">true</span>
117: <span class="ruby-keyword kw">end</span>
-118: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000098" class="method-detail">
- <a name="M000098"></a>
-
- <div class="method-heading">
- <a href="#M000098" class="method-signature">
- <span class="method-name">agent_filter</span><span class="method-args">(agent)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+118: <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="agent-filter-method" class="method-detail ">
+ <a name="M000461"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">agent_filter</span><span
+ class="method-args">(agent)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Sets the agent filter
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000098-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000098-source">
+
+
+
+ <div class="method-source-code"
+ id="agent-filter-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 422</span>
422: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">agent_filter</span>(<span class="ruby-identifier">agent</span>)
423: <span class="ruby-ivar">@filter</span>[<span class="ruby-value str">"agent"</span>] = <span class="ruby-ivar">@filter</span>[<span class="ruby-value str">"agent"</span>] <span class="ruby-operator">|</span> [<span class="ruby-identifier">agent</span>]
424: <span class="ruby-ivar">@filter</span>[<span class="ruby-value str">"agent"</span>].<span class="ruby-identifier">compact!</span>
425: <span class="ruby-identifier">reset</span>
-426: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000112" class="method-detail">
- <a name="M000112"></a>
-
- <div class="method-heading">
- <a href="#M000112" class="method-signature">
- <span class="method-name">aggregate_reply</span><span class="method-args">(reply, aggregate)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000112-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000112-source">
+426: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="aggregate-reply-method" class="method-detail ">
+ <a name="M000475"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">aggregate_reply</span><span
+ class="method-args">(reply, aggregate)</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="aggregate-reply-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 687</span>
687: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">aggregate_reply</span>(<span class="ruby-identifier">reply</span>, <span class="ruby-identifier">aggregate</span>)
692: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
693: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">error</span>(<span class="ruby-value str">"Failed to calculate aggregate summaries for reply from %s, calculating summaries disabled: %s: %s (%s)"</span> <span class="ruby-operator">%</span> [<span class="ruby-identifier">reply</span>[<span class="ruby-identifier">:senderid</span>], <span class="ruby-identifier">e</span>.<span class="ruby-identifier">backtrace</span>.<span class="ruby-identifier">first</span>, <span class="ruby-identifier">e</span>.<span class="ruby-identifier">to_s</span>, <span class="ruby-identifier">e</span>.<span class="ruby-identifier">class</span>])
694: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">nil</span>
-695: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000108" class="method-detail">
- <a name="M000108"></a>
-
- <div class="method-heading">
- <a href="#M000108" class="method-signature">
- <span class="method-name">batch_size=</span><span class="method-args">(limit)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+695: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="batch-size--method" class="method-detail ">
+ <a name="M000471"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">batch_size=</span><span
+ class="method-args">(limit)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Sets the batch size, if the size is set to 0 that will disable batch mode
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000108-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000108-source">
+
+
+
+ <div class="method-source-code"
+ id="batch-size--source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 608</span>
608: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">batch_size=</span>(<span class="ruby-identifier">limit</span>)
610:
611: <span class="ruby-ivar">@batch_size</span> = <span class="ruby-constant">Integer</span>(<span class="ruby-identifier">limit</span>)
612: <span class="ruby-ivar">@batch_mode</span> = <span class="ruby-ivar">@batch_size</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
-613: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000109" class="method-detail">
- <a name="M000109"></a>
-
- <div class="method-heading">
- <a href="#M000109" class="method-signature">
- <span class="method-name">batch_sleep_time=</span><span class="method-args">(time)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000109-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000109-source">
+613: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="batch-sleep-time--method" class="method-detail ">
+ <a name="M000472"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">batch_sleep_time=</span><span
+ class="method-args">(time)</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="batch-sleep-time--source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 615</span>
615: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">batch_sleep_time=</span>(<span class="ruby-identifier">time</span>)
616: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"Can only set batch sleep time if direct addressing is supported"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-constant">Config</span>.<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">direct_addressing</span>
617:
618: <span class="ruby-ivar">@batch_sleep_time</span> = <span class="ruby-constant">Float</span>(<span class="ruby-identifier">time</span>)
-619: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000117" class="method-detail">
- <a name="M000117"></a>
-
- <div class="method-heading">
- <a href="#M000117" class="method-signature">
- <span class="method-name">call_agent</span><span class="method-args">(action, args, opts, disc=:auto, &block)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+619: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="call-agent-method" class="method-detail ">
+ <a name="M000480"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">call_agent</span><span
+ class="method-args">(action, args, opts, disc=:auto, &block)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Handles traditional calls to the remote agents with full stats blocks, non
blocks and everything else supported.
</p>
<p>
Other methods of calling the nodes can reuse this code by for example
-specifying custom <a href="Client.html#M000104">options</a> and discovery
-data
+specifying custom options and discovery data
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000117-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000117-source">
+
+
+
+ <div class="method-source-code"
+ id="call-agent-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 844</span>
844: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">call_agent</span>(<span class="ruby-identifier">action</span>, <span class="ruby-identifier">args</span>, <span class="ruby-identifier">opts</span>, <span class="ruby-identifier">disc</span>=<span class="ruby-identifier">:auto</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
916: <span class="ruby-keyword kw">else</span>
917: <span class="ruby-keyword kw">return</span> [<span class="ruby-identifier">results</span>].<span class="ruby-identifier">flatten</span>
918: <span class="ruby-keyword kw">end</span>
-919: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000116" class="method-detail">
- <a name="M000116"></a>
-
- <div class="method-heading">
- <a href="#M000116" class="method-signature">
- <span class="method-name">call_agent_batched</span><span class="method-args">(action, args, opts, batch_size, sleep_time, &block)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+919: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="call-agent-batched-method" class="method-detail ">
+ <a name="M000479"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">call_agent_batched</span><span
+ class="method-args">(action, args, opts, batch_size, sleep_time, &block)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Calls an agent in a way very similar to <a
-href="Client.html#M000117">call_agent</a> but it supports batching the
+href="Client.html#M000480">call_agent</a> but it supports batching the
queries to the network.
</p>
<p>
The result sets, stats, block handling etc is all exactly like you would
-expect from normal <a href="Client.html#M000117">call_agent</a>.
+expect from normal call_agent.
</p>
<p>
-This is used by <a href="Client.html#M000090">method_missing</a> and works
+This is used by <a href="Client.html#M000452">method_missing</a> and works
only with direct addressing mode
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000116-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000116-source">
+
+
+
+ <div class="method-source-code"
+ id="call-agent-batched-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 759</span>
759: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">call_agent_batched</span>(<span class="ruby-identifier">action</span>, <span class="ruby-identifier">args</span>, <span class="ruby-identifier">opts</span>, <span class="ruby-identifier">batch_size</span>, <span class="ruby-identifier">sleep_time</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
834: <span class="ruby-keyword kw">else</span>
835: <span class="ruby-keyword kw">return</span> [<span class="ruby-identifier">results</span>].<span class="ruby-identifier">flatten</span>
836: <span class="ruby-keyword kw">end</span>
-837: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000096" class="method-detail">
- <a name="M000096"></a>
-
- <div class="method-heading">
- <a href="#M000096" class="method-signature">
- <span class="method-name">class_filter</span><span class="method-args">(klass)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+837: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="class-filter-method" class="method-detail ">
+ <a name="M000459"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">class_filter</span><span
+ class="method-args">(klass)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Sets the class filter
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000096-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000096-source">
+
+
+
+ <div class="method-source-code"
+ id="class-filter-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 398</span>
398: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">class_filter</span>(<span class="ruby-identifier">klass</span>)
399: <span class="ruby-ivar">@filter</span>[<span class="ruby-value str">"cf_class"</span>] = <span class="ruby-ivar">@filter</span>[<span class="ruby-value str">"cf_class"</span>] <span class="ruby-operator">|</span> [<span class="ruby-identifier">klass</span>]
400: <span class="ruby-ivar">@filter</span>[<span class="ruby-value str">"cf_class"</span>].<span class="ruby-identifier">compact!</span>
401: <span class="ruby-identifier">reset</span>
-402: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000105" class="method-detail">
- <a name="M000105"></a>
-
- <div class="method-heading">
- <a href="#M000105" class="method-signature">
- <span class="method-name">collective=</span><span class="method-args">(c)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+402: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="collective--method" class="method-detail ">
+ <a name="M000468"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">collective=</span><span
+ class="method-args">(c)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Sets the collective we are communicating with
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000105-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000105-source">
+
+
+
+ <div class="method-source-code"
+ id="collective--source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 573</span>
573: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">collective=</span>(<span class="ruby-identifier">c</span>)
576: <span class="ruby-ivar">@collective</span> = <span class="ruby-identifier">c</span>
577: <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">options</span> = <span class="ruby-identifier">options</span>
578: <span class="ruby-identifier">reset</span>
-579: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000100" class="method-detail">
- <a name="M000100"></a>
-
- <div class="method-heading">
- <a href="#M000100" class="method-signature">
- <span class="method-name">compound_filter</span><span class="method-args">(filter)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+579: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="compound-filter-method" class="method-detail ">
+ <a name="M000463"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">compound_filter</span><span
+ class="method-args">(filter)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Set a compound filter
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000100-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000100-source">
+
+
+
+ <div class="method-source-code"
+ id="compound-filter-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 436</span>
436: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">compound_filter</span>(<span class="ruby-identifier">filter</span>)
437: <span class="ruby-ivar">@filter</span>[<span class="ruby-value str">"compound"</span>] = <span class="ruby-ivar">@filter</span>[<span class="ruby-value str">"compound"</span>] <span class="ruby-operator">|</span> [<span class="ruby-constant">Matcher</span>.<span class="ruby-identifier">create_compound_callstack</span>(<span class="ruby-identifier">filter</span>)]
438: <span class="ruby-identifier">reset</span>
-439: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000091" class="method-detail">
- <a name="M000091"></a>
-
- <div class="method-heading">
- <a href="#M000091" class="method-signature">
- <span class="method-name">custom_request</span><span class="method-args">(action, args, expected_agents, filter = {}, &block)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+439: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="custom-request-method" class="method-detail ">
+ <a name="M000454"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">custom_request</span><span
+ class="method-args">(action, args, expected_agents, filter = {}, &block)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Constructs custom requests with custom filters and discovery data the idea
is that this would be used in web applications where you might be using a
cached copy of data provided by a registration agent to figure out on your
own what nodes will be responding and what your filter would be.
</p>
<p>
-This will <a href="Client.html#M000087">help</a> you essentially short
-circuit the traditional cycle of:
+This will help you essentially short circuit the traditional cycle of:
</p>
<p>
-mc <a href="Client.html#M000103">discover</a> / call / wait for discovered
-nodes
+mc discover / call / wait for discovered nodes
</p>
<p>
by doing discovery however you like, contructing a filter and a list of
</p>
<p>
If you just wanted to contact one machine for example with a client that
-already has other filter <a href="Client.html#M000104">options</a> setup
-you can do:
+already has other filter options setup you can do:
</p>
<p>
-puppet.custom_request("runonce", {}, ["your.box.com"],
-{:identity => "your.box.com"})
+puppet.custom_request(“runonce”, {},
+[“your.box.com“], {:identity => “your.box.com“})
</p>
<p>
This will do runonce action on just ‘your.box.com’, no
request which technically does not need filters. If you try to use this
mode with direct addressing disabled an exception will be raise
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000091-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000091-source">
+
+
+
+ <div class="method-source-code"
+ id="custom-request-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 296</span>
296: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">custom_request</span>(<span class="ruby-identifier">action</span>, <span class="ruby-identifier">args</span>, <span class="ruby-identifier">expected_agents</span>, <span class="ruby-identifier">filter</span> = {}, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
339: <span class="ruby-keyword kw">else</span>
340: <span class="ruby-identifier">call_agent</span>(<span class="ruby-identifier">action</span>, <span class="ruby-identifier">args</span>, <span class="ruby-identifier">custom_options</span>, [<span class="ruby-identifier">expected_agents</span>].<span class="ruby-identifier">flatten</span>)
341: <span class="ruby-keyword kw">end</span>
-342: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000086" class="method-detail">
- <a name="M000086"></a>
-
- <div class="method-heading">
- <a href="#M000086" class="method-signature">
- <span class="method-name">disconnect</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+342: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="disconnect-method" class="method-detail ">
+ <a name="M000446"></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>
Disconnects cleanly from the middleware
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000086-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000086-source">
+
+
+
+ <div class="method-source-code"
+ id="disconnect-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 121</span>
121: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">disconnect</span>
122: <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">disconnect</span>
-123: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000103" class="method-detail">
- <a name="M000103"></a>
-
- <div class="method-heading">
- <a href="#M000103" class="method-signature">
- <span class="method-name">discover</span><span class="method-args">(flags={})</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+123: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="discover-method" class="method-detail ">
+ <a name="M000466"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">discover</span><span
+ class="method-args">(flags={})</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Does discovery based on the filters set, if a discovery was previously done
-return that else do a <a href="Client.html#M000085">new</a> discovery.
+return that else do a new discovery.
</p>
<p>
Alternatively if identity filters are given and none of them are regular
the :verbose flag is passed in.
</p>
<p>
-Use <a href="Client.html#M000101">reset</a> to force a <a
-href="Client.html#M000085">new</a> discovery
+Use reset to force a new discovery
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000103-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000103-source">
+
+
+
+ <div class="method-source-code"
+ id="discover-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 468</span>
468: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">discover</span>(<span class="ruby-identifier">flags</span>={})
549: <span class="ruby-constant">RPC</span>.<span class="ruby-identifier">discovered</span>(<span class="ruby-ivar">@discovered_agents</span>)
550:
551: <span class="ruby-ivar">@discovered_agents</span>
-552: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000094" class="method-detail">
- <a name="M000094"></a>
-
- <div class="method-heading">
- <a href="#M000094" class="method-signature">
- <span class="method-name">discovery_method=</span><span class="method-args">(method)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+552: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="discovery-method--method" class="method-detail ">
+ <a name="M000457"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">discovery_method=</span><span
+ class="method-args">(method)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Sets the discovery method. If we change the method there are a number of
steps to take:
</p>
</pre>
<p>
The remaining item is the discovery timeout, we leave that as is since that
-is the user supplied timeout either via initial <a
-href="Client.html#M000104">options</a> or via specifically setting it on
-the client.
+is the user supplied timeout either via initial options or via specifically
+setting it on the client.
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000094-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000094-source">
+
+
+
+ <div class="method-source-code"
+ id="discovery-method--source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 377</span>
377: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">discovery_method=</span>(<span class="ruby-identifier">method</span>)
387: <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">options</span> = <span class="ruby-identifier">options</span>
388:
389: <span class="ruby-identifier">reset</span>
-390: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000095" class="method-detail">
- <a name="M000095"></a>
-
- <div class="method-heading">
- <a href="#M000095" class="method-signature">
- <span class="method-name">discovery_options=</span><span class="method-args">(options)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000095-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000095-source">
+390: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="discovery-options--method" class="method-detail ">
+ <a name="M000458"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">discovery_options=</span><span
+ class="method-args">(options)</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="discovery-options--source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 392</span>
392: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">discovery_options=</span>(<span class="ruby-identifier">options</span>)
393: <span class="ruby-ivar">@discovery_options</span> = [<span class="ruby-identifier">options</span>].<span class="ruby-identifier">flatten</span>
394: <span class="ruby-identifier">reset</span>
-395: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000092" class="method-detail">
- <a name="M000092"></a>
-
- <div class="method-heading">
- <a href="#M000092" class="method-signature">
- <span class="method-name">discovery_timeout</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000092-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000092-source">
+395: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="discovery-timeout-method" class="method-detail ">
+ <a name="M000455"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">discovery_timeout</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="discovery-timeout-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 344</span>
344: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">discovery_timeout</span>
345: <span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@discovery_timeout</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@discovery_timeout</span>
346: <span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">discoverer</span>.<span class="ruby-identifier">ddl</span>.<span class="ruby-identifier">meta</span>[<span class="ruby-identifier">:timeout</span>]
-347: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000093" class="method-detail">
- <a name="M000093"></a>
-
- <div class="method-heading">
- <a href="#M000093" class="method-signature">
- <span class="method-name">discovery_timeout=</span><span class="method-args">(timeout)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000093-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000093-source">
+347: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="discovery-timeout--method" class="method-detail ">
+ <a name="M000456"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">discovery_timeout=</span><span
+ class="method-args">(timeout)</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="discovery-timeout--source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 349</span>
349: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">discovery_timeout=</span>(<span class="ruby-identifier">timeout</span>)
358: <span class="ruby-comment cmt"># calculate a correct timeout based on DDL timeout and the</span>
359: <span class="ruby-comment cmt"># supplied discovery timeout</span>
360: <span class="ruby-ivar">@timeout</span> = <span class="ruby-ivar">@ddl</span>.<span class="ruby-identifier">meta</span>[<span class="ruby-identifier">:timeout</span>] <span class="ruby-operator">+</span> <span class="ruby-identifier">discovery_timeout</span>
-361: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000097" class="method-detail">
- <a name="M000097"></a>
-
- <div class="method-heading">
- <a href="#M000097" class="method-signature">
- <span class="method-name">fact_filter</span><span class="method-args">(fact, value=nil, operator="=")</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+361: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="fact-filter-method" class="method-detail ">
+ <a name="M000460"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">fact_filter</span><span
+ class="method-args">(fact, value=nil, operator="=")</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Sets the fact filter
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000097-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000097-source">
+
+
+
+ <div class="method-source-code"
+ id="fact-filter-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 405</span>
405: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">fact_filter</span>(<span class="ruby-identifier">fact</span>, <span class="ruby-identifier">value</span>=<span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">operator</span>=<span class="ruby-value str">"="</span>)
416:
417: <span class="ruby-ivar">@filter</span>[<span class="ruby-value str">"fact"</span>].<span class="ruby-identifier">compact!</span>
418: <span class="ruby-identifier">reset</span>
-419: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000114" class="method-detail">
- <a name="M000114"></a>
-
- <div class="method-heading">
- <a href="#M000114" class="method-signature">
- <span class="method-name">fire_and_forget_request</span><span class="method-args">(action, args, filter=nil)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+419: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="fire-and-forget-request-method" class="method-detail ">
+ <a name="M000477"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">fire_and_forget_request</span><span
+ class="method-args">(action, args, filter=nil)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
for requests that do not care for results just return the request id and
-don‘t do any of the response processing.
+don’t do any of the response processing.
</p>
<p>
We send the :process_results flag with to the nodes so they can make
decisions based on that.
</p>
<p>
-Should only be called via <a href="Client.html#M000090">method_missing</a>
+Should only be called via <a href="Client.html#M000452">method_missing</a>
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000114-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000114-source">
+
+
+
+ <div class="method-source-code"
+ id="fire-and-forget-request-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 710</span>
710: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">fire_and_forget_request</span>(<span class="ruby-identifier">action</span>, <span class="ruby-identifier">args</span>, <span class="ruby-identifier">filter</span>=<span class="ruby-keyword kw">nil</span>)
725: <span class="ruby-keyword kw">end</span>
726:
727: <span class="ruby-identifier">client</span>.<span class="ruby-identifier">sendreq</span>(<span class="ruby-identifier">message</span>, <span class="ruby-keyword kw">nil</span>)
-728: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000087" class="method-detail">
- <a name="M000087"></a>
-
- <div class="method-heading">
- <a href="#M000087" class="method-signature">
- <span class="method-name">help</span><span class="method-args">(template)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Returns <a href="Client.html#M000087">help</a> for an agent if a <a
-href="../DDL.html">DDL</a> was found
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000087-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000087-source">
+728: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="help-method" class="method-detail ">
+ <a name="M000447"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">help</span><span
+ class="method-args">(template)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Returns help for an agent if a <a href="../DDL.html">DDL</a> was found
+</p>
+
+
+
+ <div class="method-source-code"
+ id="help-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 126</span>
126: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">help</span>(<span class="ruby-identifier">template</span>)
127: <span class="ruby-ivar">@ddl</span>.<span class="ruby-identifier">help</span>(<span class="ruby-identifier">template</span>)
-128: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000099" class="method-detail">
- <a name="M000099"></a>
-
- <div class="method-heading">
- <a href="#M000099" class="method-signature">
- <span class="method-name">identity_filter</span><span class="method-args">(identity)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+128: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="identity-filter-method" class="method-detail ">
+ <a name="M000462"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">identity_filter</span><span
+ class="method-args">(identity)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Sets the identity filter
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000099-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000099-source">
+
+
+
+ <div class="method-source-code"
+ id="identity-filter-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 429</span>
429: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">identity_filter</span>(<span class="ruby-identifier">identity</span>)
430: <span class="ruby-ivar">@filter</span>[<span class="ruby-value str">"identity"</span>] = <span class="ruby-ivar">@filter</span>[<span class="ruby-value str">"identity"</span>] <span class="ruby-operator">|</span> [<span class="ruby-identifier">identity</span>]
431: <span class="ruby-ivar">@filter</span>[<span class="ruby-value str">"identity"</span>].<span class="ruby-identifier">compact!</span>
432: <span class="ruby-identifier">reset</span>
-433: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000115" class="method-detail">
- <a name="M000115"></a>
-
- <div class="method-heading">
- <a href="#M000115" class="method-signature">
- <span class="method-name">identity_filter_discovery_optimization</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+433: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="identity-filter-discovery-optimization-method" class="method-detail ">
+ <a name="M000478"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">identity_filter_discovery_optimization</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
if an identity filter is supplied and it is all strings no regex we can use
that as discovery data, technically the identity filter is then redundant
if we are in direct addressing mode and we could empty it out but this use
-case should only really be for a few -I‘s on the CLI
+case should only really be for a few -I’s on the CLI
</p>
<p>
For safety we leave the filter in place for now, that way we can support
methods might change the concept of identity to mean something else so we
should pass the full identity filter to them
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000115-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000115-source">
+
+
+
+ <div class="method-source-code"
+ id="identity-filter-discovery-optimization-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 741</span>
741: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">identity_filter_discovery_optimization</span>
747: <span class="ruby-ivar">@force_direct_request</span> = <span class="ruby-keyword kw">true</span> <span class="ruby-keyword kw">if</span> <span class="ruby-constant">Config</span>.<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">direct_addressing</span>
748: <span class="ruby-keyword kw">end</span>
749: <span class="ruby-keyword kw">end</span>
-750: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000107" class="method-detail">
- <a name="M000107"></a>
-
- <div class="method-heading">
- <a href="#M000107" class="method-signature">
- <span class="method-name">limit_method=</span><span class="method-args">(method)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Sets and sanity check the limit_method variable used to determine how to
-limit targets if limit_targets is set
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000107-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000107-source">
+750: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="limit-method--method" class="method-detail ">
+ <a name="M000470"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">limit_method=</span><span
+ class="method-args">(method)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Sets and sanity check the <a
+href="Client.html#limit_method">limit_method</a> variable used to determine
+how to limit targets if <a
+href="Client.html#limit_targets">limit_targets</a> is set
+</p>
+
+
+
+ <div class="method-source-code"
+ id="limit-method--source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 599</span>
599: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">limit_method=</span>(<span class="ruby-identifier">method</span>)
602: <span class="ruby-identifier">raise</span> <span class="ruby-node">"Unknown limit method #{method} must be :random or :first"</span> <span class="ruby-keyword kw">unless</span> [<span class="ruby-identifier">:random</span>, <span class="ruby-identifier">:first</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">method</span>)
603:
604: <span class="ruby-ivar">@limit_method</span> = <span class="ruby-identifier">method</span>
-605: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000106" class="method-detail">
- <a name="M000106"></a>
-
- <div class="method-heading">
- <a href="#M000106" class="method-signature">
- <span class="method-name">limit_targets=</span><span class="method-args">(limit)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Sets and sanity checks the limit_targets variable used to restrict how many
-nodes we‘ll target
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000106-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000106-source">
+605: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="limit-targets--method" class="method-detail ">
+ <a name="M000469"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">limit_targets=</span><span
+ class="method-args">(limit)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Sets and sanity checks the <a
+href="Client.html#limit_targets">limit_targets</a> variable used to
+restrict how many nodes we’ll target
+</p>
+
+
+
+ <div class="method-source-code"
+ id="limit-targets--source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 583</span>
583: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">limit_targets=</span>(<span class="ruby-identifier">limit</span>)
592: <span class="ruby-keyword kw">else</span>
593: <span class="ruby-ivar">@limit_targets</span> = <span class="ruby-constant">Integer</span>(<span class="ruby-identifier">limit</span>)
594: <span class="ruby-keyword kw">end</span>
-595: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000111" class="method-detail">
- <a name="M000111"></a>
-
- <div class="method-heading">
- <a href="#M000111" class="method-signature">
- <span class="method-name">load_aggregate_functions</span><span class="method-args">(action, ddl)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000111-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000111-source">
+595: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="load-aggregate-functions-method" class="method-detail ">
+ <a name="M000474"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">load_aggregate_functions</span><span
+ class="method-args">(action, ddl)</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="load-aggregate-functions-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 676</span>
676: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">load_aggregate_functions</span>(<span class="ruby-identifier">action</span>, <span class="ruby-identifier">ddl</span>)
682: <span class="ruby-keyword kw">rescue</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
683: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">error</span>(<span class="ruby-value str">"Failed to load aggregate functions, calculating summaries disabled: %s: %s (%s)"</span> <span class="ruby-operator">%</span> [<span class="ruby-identifier">e</span>.<span class="ruby-identifier">backtrace</span>.<span class="ruby-identifier">first</span>, <span class="ruby-identifier">e</span>.<span class="ruby-identifier">to_s</span>, <span class="ruby-identifier">e</span>.<span class="ruby-identifier">class</span>])
684: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">nil</span>
-685: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000090" class="method-detail">
- <a name="M000090"></a>
-
- <div class="method-heading">
- <a href="#M000090" class="method-signature">
- <span class="method-name">method_missing</span><span class="method-args">(method_name, *args, &block)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+685: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="method-missing-method" class="method-detail ">
+ <a name="M000452"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">method_missing</span><span
+ class="method-args">(method_name, *args, &block)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Magic handler to invoke remote methods
</p>
<p>
Once the stub is created using the constructor or the <a
-href="../RPC.html#M000037">RPC#rpcclient</a> helper you can call remote
+href="../RPC.html#M000314">RPC#rpcclient</a> helper you can call remote
actions easily:
</p>
<pre>
<p>
This will call the ‘echo’ action of the ‘rpctest’
agent and return the result as an array, the array will be a simplified
-result set from the usual full MCollective::Client#req with additional
+result set from the usual full <a
+href="../Client.html#M000503">MCollective::Client#req</a> with additional
error codes and error text:
</p>
<p>
}
</p>
<p>
-If :statuscode is 0 then everything went find, if it‘s 1 then you
+If :statuscode is 0 then everything went find, if it’s 1 then you
supplied the correct arguments etc but the request could not be completed,
-you‘ll find a human parsable reason in :statusmsg then.
+you’ll find a human parsable reason in :statusmsg then.
</p>
<p>
Codes 2 to 5 maps directly to <a
failure.
</p>
<p>
-To get access to the full result of the MCollective::Client#req calls you
-can pass in a block:
+To get access to the full result of the <a
+href="../Client.html#M000503">MCollective::Client#req</a> calls you can
+pass in a block:
</p>
<pre>
rpc.echo(:msg => "hello world") do |resp|
end
</pre>
<p>
-In this case resp will the result from MCollective::Client#req. Instead of
-returning simple text and codes as above you‘ll also need to handle
+In this case resp will the result from <a
+href="../Client.html#M000503">MCollective::Client#req</a>. Instead of
+returning simple text and codes as above you’ll also need to handle
the following exceptions:
</p>
<p>
</p>
<p>
During calls a progress indicator will be shown of how many results
-we‘ve received against how many nodes were discovered, you can
+we’ve received against how many nodes were discovered, you can
disable this by setting progress to false:
</p>
<pre>
</pre>
<p>
This supports a 2nd mode where it will send the SimpleRPC request and never
-handle the responses. It‘s a bit like UDP, it sends the request with
+handle the responses. It’s a bit like UDP, it sends the request with
the filter attached and you only get back the requestid, you have no
indication about results.
</p>
This will do everything exactly as normal but communicate to only 5 agents
at a time
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000090-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000090-source">
+
+
+
+ <div class="method-source-code"
+ id="method-missing-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 231</span>
231: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">method_missing</span>(<span class="ruby-identifier">method_name</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
263: <span class="ruby-keyword kw">else</span>
264: <span class="ruby-identifier">call_agent</span>(<span class="ruby-identifier">action</span>, <span class="ruby-identifier">args</span>, <span class="ruby-identifier">options</span>, <span class="ruby-identifier">:auto</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
265: <span class="ruby-keyword kw">end</span>
-266: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000088" class="method-detail">
- <a name="M000088"></a>
-
- <div class="method-heading">
- <a href="#M000088" class="method-signature">
- <span class="method-name">new_request</span><span class="method-args">(action, data)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+266: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="new-request-method" class="method-detail ">
+ <a name="M000448"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">new_request</span><span
+ class="method-args">(action, data)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Creates a suitable request hash for the SimpleRPC agent.
</p>
<p>
-You‘d use this if you ever wanted to take care of sending requests on
-your own - perhaps via Client#sendreq if you didn‘t care for
+You’d use this if you ever wanted to take care of sending requests on
+your own - perhaps via Client#sendreq if you didn’t care for
responses.
</p>
<p>
Clearly the use of this technique should be limited and done only if your
code requires such a thing
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000088-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000088-source">
+
+
+
+ <div class="method-source-code"
+ id="new-request-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 149</span>
149: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">new_request</span>(<span class="ruby-identifier">action</span>, <span class="ruby-identifier">data</span>)
155: <span class="ruby-identifier">:action</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">action</span>,
156: <span class="ruby-identifier">:caller</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">callerid</span>,
157: <span class="ruby-identifier">:data</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">data</span>}
-158: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000104" class="method-detail">
- <a name="M000104"></a>
-
- <div class="method-heading">
- <a href="#M000104" class="method-signature">
- <span class="method-name">options</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Provides a normal <a href="Client.html#M000104">options</a> hash like you
-would get from <a href="../Optionparser.html">Optionparser</a>
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000104-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000104-source">
+158: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="options-method" class="method-detail ">
+ <a name="M000467"></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>
+Provides a normal options hash like you would get from <a
+href="../Optionparser.html">Optionparser</a>
+</p>
+
+
+
+ <div class="method-source-code"
+ id="options-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 556</span>
556: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">options</span>
567: <span class="ruby-identifier">:config</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@config</span>,
568: <span class="ruby-identifier">:publish_timeout</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@publish_timeout</span>,
569: <span class="ruby-identifier">:threaded</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@threaded</span>}
-570: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000110" class="method-detail">
- <a name="M000110"></a>
-
- <div class="method-heading">
- <a href="#M000110" class="method-signature">
- <span class="method-name">pick_nodes_from_discovered</span><span class="method-args">(count)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+570: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="pick-nodes-from-discovered-method" class="method-detail ">
+ <a name="M000473"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">pick_nodes_from_discovered</span><span
+ class="method-args">(count)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Pick a number of nodes from the discovered nodes
</p>
<p>
- if random chosen, and batch-seed set, then set srand
for the generator, and reset afterwards
</pre>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000110-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000110-source">
+
+
+
+ <div class="method-source-code"
+ id="pick-nodes-from-discovered-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 635</span>
635: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">pick_nodes_from_discovered</span>(<span class="ruby-identifier">count</span>)
671: <span class="ruby-keyword kw">end</span>
672:
673: [<span class="ruby-identifier">result</span>].<span class="ruby-identifier">flatten</span>
-674: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000119" class="method-detail">
- <a name="M000119"></a>
-
- <div class="method-heading">
- <a href="#M000119" class="method-signature">
- <span class="method-name">process_results_with_block</span><span class="method-args">(action, resp, block, aggregate)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+674: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="process-results-with-block-method" class="method-detail ">
+ <a name="M000485"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">process_results_with_block</span><span
+ class="method-args">(action, resp, block, aggregate)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
process client requests by calling a block on each result in this mode we
do not do anything fancy with the result objects and we raise exceptions if
there are problems with the data
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000119-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000119-source">
+
+
+
+ <div class="method-source-code"
+ id="process-results-with-block-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 944</span>
944: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">process_results_with_block</span>(<span class="ruby-identifier">action</span>, <span class="ruby-identifier">resp</span>, <span class="ruby-identifier">block</span>, <span class="ruby-identifier">aggregate</span>)
976: <span class="ruby-keyword kw">end</span>
977:
978: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">aggregate</span>
-979: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000118" class="method-detail">
- <a name="M000118"></a>
-
- <div class="method-heading">
- <a href="#M000118" class="method-signature">
- <span class="method-name">process_results_without_block</span><span class="method-args">(resp, action, aggregate)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+979: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="process-results-without-block-method" class="method-detail ">
+ <a name="M000481"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">process_results_without_block</span><span
+ class="method-args">(resp, action, aggregate)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Handles result sets that has no block associated, sets fails and ok in the
stats object and return a hash of the response to send to the caller
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000118-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000118-source">
+
+
+
+ <div class="method-source-code"
+ id="process-results-without-block-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 924</span>
924: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">process_results_without_block</span>(<span class="ruby-identifier">resp</span>, <span class="ruby-identifier">action</span>, <span class="ruby-identifier">aggregate</span>)
935: <span class="ruby-keyword kw">end</span>
936:
937: [<span class="ruby-identifier">result</span>, <span class="ruby-identifier">aggregate</span>]
-938: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000101" class="method-detail">
- <a name="M000101"></a>
-
- <div class="method-heading">
- <a href="#M000101" class="method-signature">
- <span class="method-name">reset</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+938: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="reset-method" class="method-detail ">
+ <a name="M000464"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">reset</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Resets various internal parts of the class, most importantly it clears out
the cached discovery
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000101-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000101-source">
+
+
+
+ <div class="method-source-code"
+ id="reset-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 443</span>
443: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">reset</span>
444: <span class="ruby-ivar">@discovered_agents</span> = <span class="ruby-keyword kw">nil</span>
-445: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000102" class="method-detail">
- <a name="M000102"></a>
-
- <div class="method-heading">
- <a href="#M000102" class="method-signature">
- <span class="method-name">reset_filter</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+445: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="reset-filter-method" class="method-detail ">
+ <a name="M000465"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">reset_filter</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Reet the filter to an empty one
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000102-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000102-source">
+
+
+
+ <div class="method-source-code"
+ id="reset-filter-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 448</span>
448: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">reset_filter</span>
449: <span class="ruby-ivar">@filter</span> = <span class="ruby-constant">Util</span>.<span class="ruby-identifier">empty_filter</span>
450: <span class="ruby-identifier">agent_filter</span> <span class="ruby-ivar">@agent</span>
-451: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000113" class="method-detail">
- <a name="M000113"></a>
-
- <div class="method-heading">
- <a href="#M000113" class="method-signature">
- <span class="method-name">rpc_result_from_reply</span><span class="method-args">(agent, action, reply)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000113-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000113-source">
+451: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="rpc-result-from-reply-method" class="method-detail ">
+ <a name="M000476"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">rpc_result_from_reply</span><span
+ class="method-args">(agent, action, reply)</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="rpc-result-from-reply-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 697</span>
697: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">rpc_result_from_reply</span>(<span class="ruby-identifier">agent</span>, <span class="ruby-identifier">action</span>, <span class="ruby-identifier">reply</span>)
698: <span class="ruby-constant">Result</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">agent</span>, <span class="ruby-identifier">action</span>, {<span class="ruby-identifier">:sender</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">reply</span>[<span class="ruby-identifier">:senderid</span>], <span class="ruby-identifier">:statuscode</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">reply</span>[<span class="ruby-identifier">:body</span>][<span class="ruby-identifier">:statuscode</span>],
699: <span class="ruby-identifier">:statusmsg</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">reply</span>[<span class="ruby-identifier">:body</span>][<span class="ruby-identifier">:statusmsg</span>], <span class="ruby-identifier">:data</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">reply</span>[<span class="ruby-identifier">:body</span>][<span class="ruby-identifier">:data</span>]})
-700: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000089" class="method-detail">
- <a name="M000089"></a>
-
- <div class="method-heading">
- <a href="#M000089" class="method-signature">
- <span class="method-name">validate_request</span><span class="method-args">(action, args)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+700: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="validate-request-method" class="method-detail ">
+ <a name="M000449"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">validate_request</span><span
+ class="method-args">(action, args)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
For the provided arguments and action the input arguments get modified by
supplying any defaults provided in the <a href="../DDL.html">DDL</a> for
arguments that were not supplied in the request
We then pass the modified arguments to the <a href="../DDL.html">DDL</a>
for validation
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000089-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000089-source">
+
+
+
+ <div class="method-source-code"
+ id="validate-request-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 165</span>
165: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">validate_request</span>(<span class="ruby-identifier">action</span>, <span class="ruby-identifier">args</span>)
167:
168: <span class="ruby-ivar">@ddl</span>.<span class="ruby-identifier">set_default_input_arguments</span>(<span class="ruby-identifier">action</span>, <span class="ruby-identifier">args</span>)
169: <span class="ruby-ivar">@ddl</span>.<span class="ruby-identifier">validate_rpc_request</span>(<span class="ruby-identifier">action</span>, <span class="ruby-identifier">args</span>)
-170: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
+170: <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