+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Class: MCollective::RPC::Result</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::RPC::Result</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../../files/lib/mcollective/rpc/result_rb.html">
- lib/mcollective/rpc/result.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- Object
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
- <div id="description">
- <p>
-Simple class to manage compliant results from <a
-href="../RPC.html">MCollective::RPC</a> agents
-</p>
-<p>
-Currently it just fakes Hash behaviour to the result to remain backward
-compatible but it also knows which agent and action produced it so you can
-associate results to a <a href="../DDL.html">DDL</a>
-</p>
-
- </div>
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000054">[]</a>
- <a href="#M000055">[]=</a>
- <a href="#M000057">each</a>
- <a href="#M000056">fetch</a>
- <a href="#M000053">new</a>
- <a href="#M000058">to_json</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
- <div id="includes">
- <h3 class="section-bar">Included Modules</h3>
-
- <div id="includes-list">
- <span class="include-name">Enumerable</span>
- </div>
- </div>
-
- <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">action</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">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">results</td>
- <td class="context-item-value"> [R] </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-M000053" class="method-detail">
- <a name="M000053"></a>
-
- <div class="method-heading">
- <a href="#M000053" class="method-signature">
- <span class="method-name">new</span><span class="method-args">(agent, action, result={})</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000053-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000053-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/rpc/result.rb, line 13</span>
-13: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">agent</span>, <span class="ruby-identifier">action</span>, <span class="ruby-identifier">result</span>={})
-14: <span class="ruby-ivar">@agent</span> = <span class="ruby-identifier">agent</span>
-15: <span class="ruby-ivar">@action</span> = <span class="ruby-identifier">action</span>
-16: <span class="ruby-ivar">@results</span> = <span class="ruby-identifier">result</span>
-17: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000054" class="method-detail">
- <a name="M000054"></a>
-
- <div class="method-heading">
- <a href="#M000054" class="method-signature">
- <span class="method-name">[]</span><span class="method-args">(idx)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000054-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000054-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/rpc/result.rb, line 19</span>
-19: <span class="ruby-keyword kw">def</span> <span class="ruby-operator">[]</span>(<span class="ruby-identifier">idx</span>)
-20: <span class="ruby-ivar">@results</span>[<span class="ruby-identifier">idx</span>]
-21: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000055" class="method-detail">
- <a name="M000055"></a>
-
- <div class="method-heading">
- <a href="#M000055" class="method-signature">
- <span class="method-name">[]=</span><span class="method-args">(idx, item)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000055-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000055-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/rpc/result.rb, line 23</span>
-23: <span class="ruby-keyword kw">def</span> <span class="ruby-operator">[]=</span>(<span class="ruby-identifier">idx</span>, <span class="ruby-identifier">item</span>)
-24: <span class="ruby-ivar">@results</span>[<span class="ruby-identifier">idx</span>] = <span class="ruby-identifier">item</span>
-25: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000057" class="method-detail">
- <a name="M000057"></a>
-
- <div class="method-heading">
- <a href="#M000057" class="method-signature">
- <span class="method-name">each</span><span class="method-args">() {|k,v| ...}</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000057-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000057-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/rpc/result.rb, line 31</span>
-31: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">each</span>
-32: <span class="ruby-ivar">@results</span>.<span class="ruby-identifier">each_pair</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">k</span>,<span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-keyword kw">yield</span>(<span class="ruby-identifier">k</span>,<span class="ruby-identifier">v</span>) }
-33: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000056" class="method-detail">
- <a name="M000056"></a>
-
- <div class="method-heading">
- <a href="#M000056" class="method-signature">
- <span class="method-name">fetch</span><span class="method-args">(key, default)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000056-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000056-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/rpc/result.rb, line 27</span>
-27: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">default</span>)
-28: <span class="ruby-ivar">@results</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">default</span>)
-29: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000058" class="method-detail">
- <a name="M000058"></a>
-
- <div class="method-heading">
- <a href="#M000058" class="method-signature">
- <span class="method-name">to_json</span><span class="method-args">(*a)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000058-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000058-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/rpc/result.rb, line 35</span>
-35: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_json</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">a</span>)
-36: {<span class="ruby-identifier">:agent</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@agent</span>,
-37: <span class="ruby-identifier">:action</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@action</span>,
-38: <span class="ruby-identifier">:sender</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@results</span>[<span class="ruby-identifier">:sender</span>],
-39: <span class="ruby-identifier">:statuscode</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@results</span>[<span class="ruby-identifier">:statuscode</span>],
-40: <span class="ruby-identifier">:statusmsg</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@results</span>[<span class="ruby-identifier">:statusmsg</span>],
-41: <span class="ruby-identifier">:data</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@results</span>[<span class="ruby-identifier">:data</span>]}.<span class="ruby-identifier">to_json</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">a</span>)
-42: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
-
- </div>
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
Code Review / packages / precise / mcollective.git / blobdiff