--- /dev/null
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+ <title>Module: MCollective::RPC</title>
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+ <meta http-equiv="Content-Script-Type" content="text/javascript" />
+ <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+ <script type="text/javascript">
+ // <![CDATA[
+
+ function popupCode( url ) {
+ window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+ }
+
+ function toggleCode( id ) {
+ if ( document.getElementById )
+ elem = document.getElementById( id );
+ else if ( document.all )
+ elem = eval( "document.all." + id );
+ else
+ return false;
+
+ elemStyle = elem.style;
+
+ if ( elemStyle.display != "block" ) {
+ elemStyle.display = "block"
+ } else {
+ elemStyle.display = "none"
+ }
+
+ return true;
+ }
+
+ // Make codeblocks hidden by default
+ document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+
+ // ]]>
+ </script>
+
+</head>
+<body>
+
+
+
+ <div id="classHeader">
+ <table class="header-table">
+ <tr class="top-aligned-row">
+ <td><strong>Module</strong></td>
+ <td class="class-name-in-header">MCollective::RPC</td>
+ </tr>
+ <tr class="top-aligned-row">
+ <td><strong>In:</strong></td>
+ <td>
+ <a href="../../files/lib/mcollective/rpc_rb.html">
+ lib/mcollective/rpc.rb
+ </a>
+ <br />
+ <a href="../../files/lib/mcollective/rpc/actionrunner_rb.html">
+ lib/mcollective/rpc/actionrunner.rb
+ </a>
+ <br />
+ <a href="../../files/lib/mcollective/rpc/reply_rb.html">
+ lib/mcollective/rpc/reply.rb
+ </a>
+ <br />
+ <a href="../../files/lib/mcollective/rpc/progress_rb.html">
+ lib/mcollective/rpc/progress.rb
+ </a>
+ <br />
+ <a href="../../files/lib/mcollective/rpc/agent_rb.html">
+ lib/mcollective/rpc/agent.rb
+ </a>
+ <br />
+ <a href="../../files/lib/mcollective/rpc/request_rb.html">
+ lib/mcollective/rpc/request.rb
+ </a>
+ <br />
+ <a href="../../files/lib/mcollective/rpc/audit_rb.html">
+ lib/mcollective/rpc/audit.rb
+ </a>
+ <br />
+ <a href="../../files/lib/mcollective/rpc/stats_rb.html">
+ lib/mcollective/rpc/stats.rb
+ </a>
+ <br />
+ <a href="../../files/lib/mcollective/rpc/result_rb.html">
+ lib/mcollective/rpc/result.rb
+ </a>
+ <br />
+ <a href="../../files/lib/mcollective/rpc/client_rb.html">
+ lib/mcollective/rpc/client.rb
+ </a>
+ <br />
+ <a href="../../files/lib/mcollective/rpc/helpers_rb.html">
+ lib/mcollective/rpc/helpers.rb
+ </a>
+ <br />
+ </td>
+ </tr>
+
+ </table>
+ </div>
+ <!-- banner header -->
+
+ <div id="bodyContent">
+
+
+
+ <div id="contextContent">
+
+ <div id="description">
+ <p>
+Toolset to create a standard interface of client and agent using an <a
+href="RPC.html">RPC</a> metaphor, standard compliant agents will make it
+easier to create generic clients like web interfaces etc
+</p>
+
+ </div>
+
+
+ </div>
+
+ <div id="method-list">
+ <h3 class="section-bar">Methods</h3>
+
+ <div class="name-list">
+ <a href="#M000043">const_missing</a>
+ <a href="#M000039">discovered</a>
+ <a href="#M000042">empty_filter?</a>
+ <a href="#M000041">printrpc</a>
+ <a href="#M000040">printrpcstats</a>
+ <a href="#M000037">rpcclient</a>
+ <a href="#M000036">rpcoptions</a>
+ <a href="#M000038">stats</a>
+ </div>
+ </div>
+
+ </div>
+
+
+ <!-- if includes -->
+
+ <div id="section">
+
+ <div id="class-list">
+ <h3 class="section-bar">Classes and Modules</h3>
+
+ Class <a href="RPC/ActionRunner.html" class="link">MCollective::RPC::ActionRunner</a><br />
+Class <a href="RPC/Agent.html" class="link">MCollective::RPC::Agent</a><br />
+Class <a href="RPC/Audit.html" class="link">MCollective::RPC::Audit</a><br />
+Class <a href="RPC/Client.html" class="link">MCollective::RPC::Client</a><br />
+Class <a href="RPC/Helpers.html" class="link">MCollective::RPC::Helpers</a><br />
+Class <a href="RPC/Progress.html" class="link">MCollective::RPC::Progress</a><br />
+Class <a href="RPC/Reply.html" class="link">MCollective::RPC::Reply</a><br />
+Class <a href="RPC/Request.html" class="link">MCollective::RPC::Request</a><br />
+Class <a href="RPC/Result.html" class="link">MCollective::RPC::Result</a><br />
+Class <a href="RPC/Stats.html" class="link">MCollective::RPC::Stats</a><br />
+
+ </div>
+
+
+
+
+
+
+
+ <!-- if method_list -->
+ <div id="methods">
+ <h3 class="section-bar">Public Class methods</h3>
+
+ <div id="method-M000043" class="method-detail">
+ <a name="M000043"></a>
+
+ <div class="method-heading">
+ <a href="#M000043" class="method-signature">
+ <span class="method-name">const_missing</span><span class="method-args">(const_name)</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p><a class="source-toggle" href="#"
+ onclick="toggleCode('M000043-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000043-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc.rb, line 175</span>
+175: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">const_missing</span>(<span class="ruby-identifier">const_name</span>)
+176: <span class="ruby-keyword kw">super</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">const_name</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">:DDL</span>
+177:
+178: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">warn</span>(<span class="ruby-value str">"MCollective::RPC::DDL is deprecatd, please use MCollective::DDL instead"</span>)
+179: <span class="ruby-constant">MCollective</span><span class="ruby-operator">::</span><span class="ruby-constant">DDL</span>
+180: <span class="ruby-keyword kw">end</span>
+</pre>
+ </div>
+ </div>
+ </div>
+
+ <div id="method-M000039" class="method-detail">
+ <a name="M000039"></a>
+
+ <div class="method-heading">
+ <a href="#M000039" class="method-signature">
+ <span class="method-name">discovered</span><span class="method-args">(discovered)</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p>
+means for other classes to drop <a href="RPC.html#M000039">discovered</a>
+hosts into this module its a bit hacky but needed so that the mixin methods
+like <a href="RPC.html#M000040">printrpcstats</a> can easily get access to
+it without users having to pass it around in params.
+</p>
+ <p><a class="source-toggle" href="#"
+ onclick="toggleCode('M000039-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000039-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc.rb, line 107</span>
+107: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">discovered</span>(<span class="ruby-identifier">discovered</span>)
+108: <span class="ruby-ivar">@@discovered</span> = <span class="ruby-identifier">discovered</span>
+109: <span class="ruby-keyword kw">end</span>
+</pre>
+ </div>
+ </div>
+ </div>
+
+ <div id="method-M000038" class="method-detail">
+ <a name="M000038"></a>
+
+ <div class="method-heading">
+ <a href="#M000038" class="method-signature">
+ <span class="method-name">stats</span><span class="method-args">(stats)</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p>
+means for other classes to drop <a href="RPC.html#M000038">stats</a> into
+this module its a bit hacky but needed so that the mixin methods like <a
+href="RPC.html#M000040">printrpcstats</a> can easily get access to it
+without users having to pass it around in params.
+</p>
+ <p><a class="source-toggle" href="#"
+ onclick="toggleCode('M000038-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000038-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc.rb, line 99</span>
+ 99: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">stats</span>(<span class="ruby-identifier">stats</span>)
+100: <span class="ruby-ivar">@@stats</span> = <span class="ruby-identifier">stats</span>
+101: <span class="ruby-keyword kw">end</span>
+</pre>
+ </div>
+ </div>
+ </div>
+
+ <h3 class="section-bar">Public Instance methods</h3>
+
+ <div id="method-M000042" class="method-detail">
+ <a name="M000042"></a>
+
+ <div class="method-heading">
+ <a href="#M000042" class="method-signature">
+ <span class="method-name">empty_filter?</span><span class="method-args">(options)</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p>
+Wrapper for <a href="Util.html#M000288">MCollective::Util.empty_filter</a>?
+to make clients less fugly to write - ticket 18
+</p>
+ <p><a class="source-toggle" href="#"
+ onclick="toggleCode('M000042-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000042-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc.rb, line 167</span>
+167: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">empty_filter?</span>(<span class="ruby-identifier">options</span>)
+168: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">options</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">:filter</span>)
+169: <span class="ruby-constant">Util</span>.<span class="ruby-identifier">empty_filter?</span>(<span class="ruby-identifier">options</span>[<span class="ruby-identifier">:filter</span>])
+170: <span class="ruby-keyword kw">else</span>
+171: <span class="ruby-constant">Util</span>.<span class="ruby-identifier">empty_filter?</span>(<span class="ruby-identifier">options</span>)
+172: <span class="ruby-keyword kw">end</span>
+173: <span class="ruby-keyword kw">end</span>
+</pre>
+ </div>
+ </div>
+ </div>
+
+ <div id="method-M000041" class="method-detail">
+ <a name="M000041"></a>
+
+ <div class="method-heading">
+ <a href="#M000041" class="method-signature">
+ <span class="method-name">printrpc</span><span class="method-args">(result, flags = {})</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p>
+Prints the result of an <a href="RPC.html">RPC</a> call.
+</p>
+<p>
+In the default quiet mode - no flattening or verbose - only results that
+produce an error will be printed
+</p>
+<p>
+To get details of each result run with the -v command line option.
+</p>
+ <p><a class="source-toggle" href="#"
+ onclick="toggleCode('M000041-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000041-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc.rb, line 146</span>
+146: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">printrpc</span>(<span class="ruby-identifier">result</span>, <span class="ruby-identifier">flags</span> = {})
+147: <span class="ruby-identifier">verbose</span> = <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:verbose</span>] <span class="ruby-keyword kw">rescue</span> <span class="ruby-identifier">verbose</span> = <span class="ruby-keyword kw">false</span>
+148: <span class="ruby-identifier">verbose</span> = <span class="ruby-identifier">flags</span>[<span class="ruby-identifier">:verbose</span>] <span class="ruby-operator">||</span> <span class="ruby-identifier">verbose</span>
+149: <span class="ruby-identifier">flatten</span> = <span class="ruby-identifier">flags</span>[<span class="ruby-identifier">:flatten</span>] <span class="ruby-operator">||</span> <span class="ruby-keyword kw">false</span>
+150: <span class="ruby-identifier">format</span> = <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:output_format</span>]
+151: <span class="ruby-identifier">forced_mode</span> = <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:force_display_mode</span>] <span class="ruby-operator">||</span> <span class="ruby-keyword kw">false</span>
+152:
+153: <span class="ruby-identifier">result_text</span> = <span class="ruby-constant">Helpers</span>.<span class="ruby-identifier">rpcresults</span>(<span class="ruby-identifier">result</span>, {<span class="ruby-identifier">:verbose</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">verbose</span>, <span class="ruby-identifier">:flatten</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">flatten</span>, <span class="ruby-identifier">:format</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">format</span>, <span class="ruby-identifier">:force_display_mode</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">forced_mode</span>})
+154:
+155: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">result</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Array</span>) <span class="ruby-operator">&&</span> <span class="ruby-identifier">format</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">:console</span>
+156: <span class="ruby-identifier">puts</span> <span class="ruby-value str">"\n%s\n"</span> <span class="ruby-operator">%</span> [ <span class="ruby-identifier">result_text</span> ]
+157: <span class="ruby-keyword kw">else</span>
+158: <span class="ruby-comment cmt"># when we get just one result to print dont pad them all with</span>
+159: <span class="ruby-comment cmt"># blank spaces etc, just print the individual result with no</span>
+160: <span class="ruby-comment cmt"># padding</span>
+161: <span class="ruby-identifier">puts</span> <span class="ruby-identifier">result_text</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">result_text</span> <span class="ruby-operator">==</span> <span class="ruby-value str">""</span>
+162: <span class="ruby-keyword kw">end</span>
+163: <span class="ruby-keyword kw">end</span>
+</pre>
+ </div>
+ </div>
+ </div>
+
+ <div id="method-M000040" class="method-detail">
+ <a name="M000040"></a>
+
+ <div class="method-heading">
+ <a href="#M000040" class="method-signature">
+ <span class="method-name">printrpcstats</span><span class="method-args">(flags={})</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p>
+Prints <a href="RPC.html#M000038">stats</a>, requires <a
+href="RPC.html#M000038">stats</a> to be saved from elsewhere using the <a
+href="RPC.html#M000038">MCollective::RPC.stats</a> method.
+</p>
+<p>
+If you‘ve passed -v on the command line a detailed stat block will be
+printed, else just a one liner.
+</p>
+<p>
+You can pass flags into it:
+</p>
+<pre>
+ printrpcstats :caption => "Foo", :summarize => true
+</pre>
+<p>
+This will use "Foo" as the caption to the <a
+href="RPC.html#M000038">stats</a> in verbose mode and print out any
+aggregate summary information if present
+</p>
+ <p><a class="source-toggle" href="#"
+ onclick="toggleCode('M000040-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000040-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc.rb, line 123</span>
+123: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">printrpcstats</span>(<span class="ruby-identifier">flags</span>={})
+124: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:output_format</span>] <span class="ruby-operator">==</span> <span class="ruby-identifier">:console</span>
+125:
+126: <span class="ruby-identifier">flags</span> = {<span class="ruby-identifier">:summarize</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">false</span>, <span class="ruby-identifier">:caption</span> =<span class="ruby-operator">></span> <span class="ruby-value str">"rpc stats"</span>}.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">flags</span>)
+127:
+128: <span class="ruby-identifier">verbose</span> = <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:verbose</span>] <span class="ruby-keyword kw">rescue</span> <span class="ruby-identifier">verbose</span> = <span class="ruby-keyword kw">false</span>
+129:
+130: <span class="ruby-keyword kw">begin</span>
+131: <span class="ruby-identifier">stats</span> = <span class="ruby-ivar">@@stats</span>
+132: <span class="ruby-keyword kw">rescue</span>
+133: <span class="ruby-identifier">puts</span>(<span class="ruby-value str">"no stats to display"</span>)
+134: <span class="ruby-keyword kw">return</span>
+135: <span class="ruby-keyword kw">end</span>
+136:
+137: <span class="ruby-identifier">puts</span> <span class="ruby-identifier">stats</span>.<span class="ruby-identifier">report</span>(<span class="ruby-identifier">flags</span>[<span class="ruby-identifier">:caption</span>], <span class="ruby-identifier">flags</span>[<span class="ruby-identifier">:summarize</span>], <span class="ruby-identifier">verbose</span>)
+138: <span class="ruby-keyword kw">end</span>
+</pre>
+ </div>
+ </div>
+ </div>
+
+ <div id="method-M000037" class="method-detail">
+ <a name="M000037"></a>
+
+ <div class="method-heading">
+ <a href="#M000037" class="method-signature">
+ <span class="method-name">rpcclient</span><span class="method-args">(agent, flags = {}) {|rpc| ...}</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p>
+Wrapper to create clients, supposed to be used as a mixin:
+</p>
+<p>
+include <a href="RPC.html">MCollective::RPC</a>
+</p>
+<p>
+exim = <a href="RPC.html#M000037">rpcclient</a>("exim") <a
+href="RPC.html#M000041">printrpc</a> exim.mailq
+</p>
+<p>
+or
+</p>
+<p>
+<a href="RPC.html#M000037">rpcclient</a>("exim") do |exim|
+</p>
+<pre>
+ printrpc exim.mailq
+</pre>
+<p>
+end
+</p>
+<p>
+It will take a few flags:
+</p>
+<pre>
+ :configfile => "etc/client.cfg"
+ :options => options
+ :exit_on_failure => true
+</pre>
+<p>
+Options would be a build up options hash from the <a
+href="Optionparser.html">Optionparser</a> you can use the <a
+href="RPC.html#M000036">rpcoptions</a> helper to create this
+</p>
+<p>
+:exit_on_failure is true by default, and causes the application to exit if
+there is a failure constructing the <a href="RPC.html">RPC</a> client. Set
+this flag to false to cause an Exception to be raised instead.
+</p>
+ <p><a class="source-toggle" href="#"
+ onclick="toggleCode('M000037-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000037-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc.rb, line 60</span>
+60: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">rpcclient</span>(<span class="ruby-identifier">agent</span>, <span class="ruby-identifier">flags</span> = {})
+61: <span class="ruby-identifier">configfile</span> = <span class="ruby-identifier">flags</span>[<span class="ruby-identifier">:configfile</span>] <span class="ruby-operator">||</span> <span class="ruby-value str">"/etc/mcollective/client.cfg"</span>
+62: <span class="ruby-identifier">options</span> = <span class="ruby-identifier">flags</span>[<span class="ruby-identifier">:options</span>] <span class="ruby-operator">||</span> <span class="ruby-keyword kw">nil</span>
+63:
+64: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">flags</span>.<span class="ruby-identifier">key?</span>(<span class="ruby-identifier">:exit_on_failure</span>)
+65: <span class="ruby-identifier">exit_on_failure</span> = <span class="ruby-identifier">flags</span>[<span class="ruby-identifier">:exit_on_failure</span>]
+66: <span class="ruby-keyword kw">else</span>
+67: <span class="ruby-comment cmt"># We exit on failure by default for CLI-friendliness</span>
+68: <span class="ruby-identifier">exit_on_failure</span> = <span class="ruby-keyword kw">true</span>
+69: <span class="ruby-keyword kw">end</span>
+70:
+71: <span class="ruby-keyword kw">begin</span>
+72: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">options</span>
+73: <span class="ruby-identifier">rpc</span> = <span class="ruby-constant">Client</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">agent</span>, <span class="ruby-identifier">:configfile</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:config</span>], <span class="ruby-identifier">:options</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">options</span>)
+74: <span class="ruby-ivar">@options</span> = <span class="ruby-identifier">rpc</span>.<span class="ruby-identifier">options</span>
+75: <span class="ruby-keyword kw">else</span>
+76: <span class="ruby-identifier">rpc</span> = <span class="ruby-constant">Client</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">agent</span>, <span class="ruby-identifier">:configfile</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">configfile</span>)
+77: <span class="ruby-ivar">@options</span> = <span class="ruby-identifier">rpc</span>.<span class="ruby-identifier">options</span>
+78: <span class="ruby-keyword kw">end</span>
+79: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
+80: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">exit_on_failure</span>
+81: <span class="ruby-identifier">puts</span>(<span class="ruby-node">"Could not create RPC client: #{e}"</span>)
+82: <span class="ruby-identifier">exit!</span>
+83: <span class="ruby-keyword kw">else</span>
+84: <span class="ruby-identifier">raise</span> <span class="ruby-identifier">e</span>
+85: <span class="ruby-keyword kw">end</span>
+86: <span class="ruby-keyword kw">end</span>
+87:
+88: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">block_given?</span>
+89: <span class="ruby-keyword kw">yield</span>(<span class="ruby-identifier">rpc</span>)
+90: <span class="ruby-keyword kw">else</span>
+91: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">rpc</span>
+92: <span class="ruby-keyword kw">end</span>
+93: <span class="ruby-keyword kw">end</span>
+</pre>
+ </div>
+ </div>
+ </div>
+
+ <div id="method-M000036" class="method-detail">
+ <a name="M000036"></a>
+
+ <div class="method-heading">
+ <a href="#M000036" class="method-signature">
+ <span class="method-name">rpcoptions</span><span class="method-args">() {|parser, options| ...}</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p>
+Creates a standard options hash, pass in a block to add extra headings etc
+see <a href="Optionparser.html">Optionparser</a>
+</p>
+ <p><a class="source-toggle" href="#"
+ onclick="toggleCode('M000036-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000036-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc.rb, line 21</span>
+21: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">rpcoptions</span>
+22: <span class="ruby-identifier">oparser</span> = <span class="ruby-constant">MCollective</span><span class="ruby-operator">::</span><span class="ruby-constant">Optionparser</span>.<span class="ruby-identifier">new</span>({<span class="ruby-identifier">:verbose</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">false</span>, <span class="ruby-identifier">:progress_bar</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">true</span>}, <span class="ruby-value str">"filter"</span>)
+23:
+24: <span class="ruby-identifier">options</span> = <span class="ruby-identifier">oparser</span>.<span class="ruby-identifier">parse</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">parser</span>, <span class="ruby-identifier">options</span><span class="ruby-operator">|</span>
+25: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">block_given?</span>
+26: <span class="ruby-keyword kw">yield</span>(<span class="ruby-identifier">parser</span>, <span class="ruby-identifier">options</span>)
+27: <span class="ruby-keyword kw">end</span>
+28:
+29: <span class="ruby-constant">Helpers</span>.<span class="ruby-identifier">add_simplerpc_options</span>(<span class="ruby-identifier">parser</span>, <span class="ruby-identifier">options</span>)
+30: <span class="ruby-keyword kw">end</span>
+31:
+32: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">options</span>
+33: <span class="ruby-keyword kw">end</span>
+</pre>
+ </div>
+ </div>
+ </div>
+
+
+ </div>
+
+
+ </div>
+
+
+<div id="validator-badges">
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>
\ No newline at end of file