-<?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::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::Client</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../files/lib/mcollective/client_rb.html">
- lib/mcollective/client.rb
- </a>
- <br />
- </td>
- </tr>
+ <title>Class: MCollective::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/client_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/client.rb">lib/mcollective/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="#M000494">::new</a></li>
+
+ <li><a href="#M000495">#collective</a></li>
+
+ <li><a href="#M000498">#createreq</a></li>
+
+ <li><a href="#M000496">#disconnect</a></li>
+
+ <li><a href="#M000502">#discover</a></li>
+
+ <li><a href="#M000512">#discovered_req</a></li>
+
+ <li><a href="#M000513">#display_stats</a></li>
+
+ <li><a href="#M000501">#receive</a></li>
+
+ <li><a href="#M000503">#req</a></li>
+
+ <li><a href="#M000497">#sendreq</a></li>
+
+ <li><a href="#M000509">#start_publisher</a></li>
+
+ <li><a href="#M000510">#start_receiver</a></li>
+
+ <li><a href="#M000499">#subscribe</a></li>
+
+ <li><a href="#M000505">#threaded_req</a></li>
+
+ <li><a href="#M000500">#unsubscribe</a></li>
+
+ <li><a href="#M000504">#unthreaded_req</a></li>
+
+ <li><a href="#M000511">#update_stat</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::Client</h1>
+
+ <div id="description">
+ <p>
Helpers for writing clients that can talk to agents, do discovery and so
forth
</p>
- </div>
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000457">collective</a>
- <a href="#M000460">createreq</a>
- <a href="#M000458">disconnect</a>
- <a href="#M000464">discover</a>
- <a href="#M000471">discovered_req</a>
- <a href="#M000472">display_stats</a>
- <a href="#M000456">new</a>
- <a href="#M000463">receive</a>
- <a href="#M000465">req</a>
- <a href="#M000459">sendreq</a>
- <a href="#M000468">start_publisher</a>
- <a href="#M000469">start_receiver</a>
- <a href="#M000461">subscribe</a>
- <a href="#M000467">threaded_req</a>
- <a href="#M000462">unsubscribe</a>
- <a href="#M000466">unthreaded_req</a>
- <a href="#M000470">update_stat</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">discoverer</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">options</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"> [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-M000456" class="method-detail">
- <a name="M000456"></a>
-
- <div class="method-heading">
- <a href="#M000456" class="method-signature">
- <span class="method-name">new</span><span class="method-args">(configfile)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000456-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000456-source">
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+ <div id="attribute-method-details" class="method-section section">
+ <h3 class="section-header">Attributes</h3>
+
+
+ <div id="options-attribute-method" class="method-detail">
+ <a name="options"></a>
+
+ <a name="options="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">options</span><span
+ class="attribute-access-type">[RW]</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>
+
+ <a name="stats="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">stats</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="discoverer-attribute-method" class="method-detail">
+ <a name="discoverer"></a>
+
+ <a name="discoverer="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">discoverer</span><span
+ class="attribute-access-type">[RW]</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="M000494"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">new</span><span
+ class="method-args">(configfile)</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="new-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/client.rb, line 6</span>
6: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">configfile</span>)
16:
17: <span class="ruby-ivar">@discoverer</span> = <span class="ruby-constant">Discovery</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword kw">self</span>)
18: <span class="ruby-ivar">@connection</span>.<span class="ruby-identifier">connect</span>
-19: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000457" class="method-detail">
- <a name="M000457"></a>
-
- <div class="method-heading">
- <a href="#M000457" class="method-signature">
- <span class="method-name">collective</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Returns the configured main <a href="Client.html#M000457">collective</a> if
-no specific <a href="Client.html#M000457">collective</a> is specified as
-options
+19: <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="collective-method" class="method-detail ">
+ <a name="M000495"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">collective</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Returns the configured main collective if no specific collective is
+specified as options
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000457-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000457-source">
+
+
+
+ <div class="method-source-code"
+ id="collective-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/client.rb, line 23</span>
23: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">collective</span>
26: <span class="ruby-keyword kw">else</span>
27: <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:collective</span>]
28: <span class="ruby-keyword kw">end</span>
-29: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000460" class="method-detail">
- <a name="M000460"></a>
-
- <div class="method-heading">
- <a href="#M000460" class="method-signature">
- <span class="method-name">createreq</span><span class="method-args">(msg, agent, filter ={})</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000460-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000460-source">
+29: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="createreq-method" class="method-detail ">
+ <a name="M000498"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">createreq</span><span
+ class="method-args">(msg, agent, filter ={})</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="createreq-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/client.rb, line 48</span>
48: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">createreq</span>(<span class="ruby-identifier">msg</span>, <span class="ruby-identifier">agent</span>, <span class="ruby-identifier">filter</span> ={})
58: <span class="ruby-identifier">request</span>.<span class="ruby-identifier">encode!</span>
59: <span class="ruby-identifier">subscribe</span>(<span class="ruby-identifier">agent</span>, <span class="ruby-identifier">:reply</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">request</span>.<span class="ruby-identifier">reply_to</span>
60: <span class="ruby-identifier">request</span>
-61: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000458" class="method-detail">
- <a name="M000458"></a>
-
- <div class="method-heading">
- <a href="#M000458" class="method-signature">
- <span class="method-name">disconnect</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+61: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="disconnect-method" class="method-detail ">
+ <a name="M000496"></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('M000458-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000458-source">
+
+
+
+ <div class="method-source-code"
+ id="disconnect-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/client.rb, line 32</span>
32: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">disconnect</span>
33: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-value str">"Disconnecting from the middleware"</span>)
34: <span class="ruby-ivar">@connection</span>.<span class="ruby-identifier">disconnect</span>
-35: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000464" class="method-detail">
- <a name="M000464"></a>
-
- <div class="method-heading">
- <a href="#M000464" class="method-signature">
- <span class="method-name">discover</span><span class="method-args">(filter, timeout, limit=0)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+35: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="discover-method" class="method-detail ">
+ <a name="M000502"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">discover</span><span
+ class="method-args">(filter, timeout, limit=0)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Performs a discovery of nodes matching the filter passed returns an array
of nodes
</p>
An integer limit can be supplied this will have the effect of the discovery
being cancelled soon as it reached the requested limit of hosts
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000464-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000464-source">
+
+
+
+ <div class="method-source-code"
+ id="discover-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/client.rb, line 117</span>
117: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">discover</span>(<span class="ruby-identifier">filter</span>, <span class="ruby-identifier">timeout</span>, <span class="ruby-identifier">limit</span>=<span class="ruby-value">0</span>)
118: <span class="ruby-identifier">discovered</span> = <span class="ruby-ivar">@discoverer</span>.<span class="ruby-identifier">discover</span>(<span class="ruby-identifier">filter</span>, <span class="ruby-identifier">timeout</span>, <span class="ruby-identifier">limit</span>)
-119: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000471" class="method-detail">
- <a name="M000471"></a>
-
- <div class="method-heading">
- <a href="#M000471" class="method-signature">
- <span class="method-name">discovered_req</span><span class="method-args">(body, agent, options=false)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000471-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000471-source">
+119: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="discovered-req-method" class="method-detail ">
+ <a name="M000512"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">discovered_req</span><span
+ class="method-args">(body, agent, options=false)</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="discovered-req-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/client.rb, line 233</span>
233: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">discovered_req</span>(<span class="ruby-identifier">body</span>, <span class="ruby-identifier">agent</span>, <span class="ruby-identifier">options</span>=<span class="ruby-keyword kw">false</span>)
234: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"Client#discovered_req has been removed, please port your agent and client to the SimpleRPC framework"</span>
-235: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000472" class="method-detail">
- <a name="M000472"></a>
-
- <div class="method-heading">
- <a href="#M000472" class="method-signature">
- <span class="method-name">display_stats</span><span class="method-args">(stats, options=false, caption="stomp call summary")</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Prints out the stats returns from <a href="Client.html#M000465">req</a> and
-<a href="Client.html#M000471">discovered_req</a> in a nice way
+235: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="display-stats-method" class="method-detail ">
+ <a name="M000513"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">display_stats</span><span
+ class="method-args">(stats, options=false, caption="stomp call summary")</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Prints out the stats returns from req and <a
+href="Client.html#M000512">discovered_req</a> in a nice way
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000472-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000472-source">
+
+
+
+ <div class="method-source-code"
+ id="display-stats-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/client.rb, line 238</span>
238: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">display_stats</span>(<span class="ruby-identifier">stats</span>, <span class="ruby-identifier">options</span>=<span class="ruby-keyword kw">false</span>, <span class="ruby-identifier">caption</span>=<span class="ruby-value str">"stomp call summary"</span>)
270:
271: <span class="ruby-identifier">puts</span>
272: <span class="ruby-keyword kw">end</span>
-273: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000463" class="method-detail">
- <a name="M000463"></a>
-
- <div class="method-heading">
- <a href="#M000463" class="method-signature">
- <span class="method-name">receive</span><span class="method-args">(requestid = nil)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+273: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="receive-method" class="method-detail ">
+ <a name="M000501"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">receive</span><span
+ class="method-args">(requestid = nil)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Blocking call that waits for ever for a message to arrive.
</p>
<p>
-If you give it a requestid this means you‘ve previously send a
+If you give it a requestid this means you’ve previously send a
request with that ID and now you just want replies that matches that id, in
that case the current connection will just ignore all messages not directed
at it and keep waiting for more till it finds a matching message.
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000463-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000463-source">
+
+
+
+ <div class="method-source-code"
+ id="receive-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/client.rb, line 88</span>
88: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">receive</span>(<span class="ruby-identifier">requestid</span> = <span class="ruby-keyword kw">nil</span>)
106: <span class="ruby-keyword kw">end</span>
107:
108: <span class="ruby-identifier">reply</span>
-109: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000465" class="method-detail">
- <a name="M000465"></a>
-
- <div class="method-heading">
- <a href="#M000465" class="method-signature">
- <span class="method-name">req</span><span class="method-args">(body, agent=nil, options=false, waitfor=0, &block)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+109: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="req-method" class="method-detail ">
+ <a name="M000503"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">req</span><span
+ class="method-args">(body, agent=nil, options=false, waitfor=0, &block)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Send a request, performs the passed block for each response
</p>
<p>
-times = <a href="Client.html#M000465">req</a>("status",
-"mcollectived", options, client) {|resp|
+times = req(“status”, “mcollectived”, options,
+client) {|resp|
</p>
<pre>
pp resp
taken from the options hash which in turn is generally built using <a
href="Optionparser.html">MCollective::Optionparser</a>
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000465-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000465-source">
+
+
+
+ <div class="method-source-code"
+ id="req-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/client.rb, line 129</span>
129: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">req</span>(<span class="ruby-identifier">body</span>, <span class="ruby-identifier">agent</span>=<span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">options</span>=<span class="ruby-keyword kw">false</span>, <span class="ruby-identifier">waitfor</span>=<span class="ruby-value">0</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
155: <span class="ruby-keyword kw">end</span>
156:
157: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">update_stat</span>(<span class="ruby-identifier">stat</span>, <span class="ruby-identifier">hosts_responded</span>, <span class="ruby-identifier">request</span>.<span class="ruby-identifier">requestid</span>)
-158: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000459" class="method-detail">
- <a name="M000459"></a>
-
- <div class="method-heading">
- <a href="#M000459" class="method-signature">
- <span class="method-name">sendreq</span><span class="method-args">(msg, agent, filter = {})</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Sends a request and returns the generated request id, doesn‘t wait
-for responses and doesn‘t execute any passed in code blocks for
+158: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="sendreq-method" class="method-detail ">
+ <a name="M000497"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">sendreq</span><span
+ class="method-args">(msg, agent, filter = {})</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Sends a request and returns the generated request id, doesn’t wait
+for responses and doesn’t execute any passed in code blocks for
responses
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000459-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000459-source">
+
+
+
+ <div class="method-source-code"
+ id="sendreq-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/client.rb, line 39</span>
39: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">sendreq</span>(<span class="ruby-identifier">msg</span>, <span class="ruby-identifier">agent</span>, <span class="ruby-identifier">filter</span> = {})
43:
44: <span class="ruby-identifier">request</span>.<span class="ruby-identifier">publish</span>
45: <span class="ruby-identifier">request</span>.<span class="ruby-identifier">requestid</span>
-46: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000468" class="method-detail">
- <a name="M000468"></a>
-
- <div class="method-heading">
- <a href="#M000468" class="method-signature">
- <span class="method-name">start_publisher</span><span class="method-args">(request, publish_timeout)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+46: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="start-publisher-method" class="method-detail ">
+ <a name="M000509"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">start_publisher</span><span
+ class="method-args">(request, publish_timeout)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Starts the request publishing routine
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000468-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000468-source">
+
+
+
+ <div class="method-source-code"
+ id="start-publisher-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/client.rb, line 191</span>
191: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">start_publisher</span>(<span class="ruby-identifier">request</span>, <span class="ruby-identifier">publish_timeout</span>)
198: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Timeout</span><span class="ruby-operator">::</span><span class="ruby-constant">Error</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
199: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">warn</span>(<span class="ruby-value str">"Could not publish all messages. Publishing timed out."</span>)
200: <span class="ruby-keyword kw">end</span>
-201: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000469" class="method-detail">
- <a name="M000469"></a>
-
- <div class="method-heading">
- <a href="#M000469" class="method-signature">
- <span class="method-name">start_receiver</span><span class="method-args">(requestid, waitfor, timeout) {|resp.payload| ...}</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+201: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="start-receiver-method" class="method-detail ">
+ <a name="M000510"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">start_receiver</span><span
+ class="method-args">(requestid, waitfor, timeout, &block)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Starts the response receiver routine Expected to return the amount of
received responses.
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000469-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000469-source">
+
+
+
+ <div class="method-source-code"
+ id="start-receiver-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/client.rb, line 205</span>
205: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">start_receiver</span>(<span class="ruby-identifier">requestid</span>, <span class="ruby-identifier">waitfor</span>, <span class="ruby-identifier">timeout</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
218: <span class="ruby-keyword kw">end</span>
219:
220: <span class="ruby-identifier">hosts_responded</span>
-221: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000461" class="method-detail">
- <a name="M000461"></a>
-
- <div class="method-heading">
- <a href="#M000461" class="method-signature">
- <span class="method-name">subscribe</span><span class="method-args">(agent, type)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000461-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000461-source">
+221: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="subscribe-method" class="method-detail ">
+ <a name="M000499"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">subscribe</span><span
+ class="method-args">(agent, type)</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="subscribe-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/client.rb, line 63</span>
63: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">subscribe</span>(<span class="ruby-identifier">agent</span>, <span class="ruby-identifier">type</span>)
68: <span class="ruby-constant">Util</span>.<span class="ruby-identifier">subscribe</span>(<span class="ruby-identifier">subscription</span>)
69: <span class="ruby-ivar">@subscriptions</span>[<span class="ruby-identifier">agent</span>] = <span class="ruby-value">1</span>
70: <span class="ruby-keyword kw">end</span>
-71: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000467" class="method-detail">
- <a name="M000467"></a>
-
- <div class="method-heading">
- <a href="#M000467" class="method-signature">
- <span class="method-name">threaded_req</span><span class="method-args">(request, publish_timeout, timeout, waitfor, &block)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+71: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="threaded-req-method" class="method-detail ">
+ <a name="M000505"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">threaded_req</span><span
+ class="method-args">(request, publish_timeout, timeout, waitfor, &block)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Starts the client receiver and publisher in threads. This is activated when
the ‘threader_client’ configuration option is set.
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000467-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000467-source">
+
+
+
+ <div class="method-source-code"
+ id="threaded-req-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/client.rb, line 170</span>
170: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">threaded_req</span>(<span class="ruby-identifier">request</span>, <span class="ruby-identifier">publish_timeout</span>, <span class="ruby-identifier">timeout</span>, <span class="ruby-identifier">waitfor</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
185:
186: <span class="ruby-identifier">receiver</span>.<span class="ruby-identifier">join</span>
187: <span class="ruby-identifier">hosts_responded</span>
-188: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000462" class="method-detail">
- <a name="M000462"></a>
-
- <div class="method-heading">
- <a href="#M000462" class="method-signature">
- <span class="method-name">unsubscribe</span><span class="method-args">(agent, type)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000462-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000462-source">
+188: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="unsubscribe-method" class="method-detail ">
+ <a name="M000500"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">unsubscribe</span><span
+ class="method-args">(agent, type)</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="unsubscribe-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/client.rb, line 73</span>
73: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">unsubscribe</span>(<span class="ruby-identifier">agent</span>, <span class="ruby-identifier">type</span>)
78: <span class="ruby-constant">Util</span>.<span class="ruby-identifier">unsubscribe</span>(<span class="ruby-identifier">subscription</span>)
79: <span class="ruby-ivar">@subscriptions</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">agent</span>)
80: <span class="ruby-keyword kw">end</span>
-81: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000466" class="method-detail">
- <a name="M000466"></a>
-
- <div class="method-heading">
- <a href="#M000466" class="method-signature">
- <span class="method-name">unthreaded_req</span><span class="method-args">(request, publish_timeout, timeout, waitfor, &block)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+81: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="unthreaded-req-method" class="method-detail ">
+ <a name="M000504"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">unthreaded_req</span><span
+ class="method-args">(request, publish_timeout, timeout, waitfor, &block)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Starts the client receiver and publisher unthreaded. This is the default
client behaviour.
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000466-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000466-source">
+
+
+
+ <div class="method-source-code"
+ id="unthreaded-req-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/client.rb, line 162</span>
162: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">unthreaded_req</span>(<span class="ruby-identifier">request</span>, <span class="ruby-identifier">publish_timeout</span>, <span class="ruby-identifier">timeout</span>, <span class="ruby-identifier">waitfor</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
163: <span class="ruby-identifier">start_publisher</span>(<span class="ruby-identifier">request</span>, <span class="ruby-identifier">publish_timeout</span>)
164: <span class="ruby-identifier">start_receiver</span>(<span class="ruby-identifier">request</span>.<span class="ruby-identifier">requestid</span>, <span class="ruby-identifier">waitfor</span>, <span class="ruby-identifier">timeout</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
-165: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000470" class="method-detail">
- <a name="M000470"></a>
-
- <div class="method-heading">
- <a href="#M000470" class="method-signature">
- <span class="method-name">update_stat</span><span class="method-args">(stat, hosts_responded, requestid)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000470-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000470-source">
+165: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="update-stat-method" class="method-detail ">
+ <a name="M000511"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">update_stat</span><span
+ class="method-args">(stat, hosts_responded, requestid)</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="update-stat-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/client.rb, line 223</span>
223: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">update_stat</span>(<span class="ruby-identifier">stat</span>, <span class="ruby-identifier">hosts_responded</span>, <span class="ruby-identifier">requestid</span>)
228: <span class="ruby-identifier">stat</span>[<span class="ruby-identifier">:requestid</span>] = <span class="ruby-identifier">requestid</span>
229:
230: <span class="ruby-ivar">@stats</span> = <span class="ruby-identifier">stat</span>
-231: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
+231: <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