Code Review / packages / precise / mcollective.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | review | tree
raw | inline | side by side
Update version according to OSCI-883
[packages/precise/mcollective.git] / doc / classes / MCollective / RPC / Reply.html
diff --git a/doc/classes/MCollective/RPC/Reply.html b/doc/classes/MCollective/RPC/Reply.html
deleted file mode 100644 (file)
index 6361f7e..0000000
--- a/doc/classes/MCollective/RPC/Reply.html
+++ /dev/null
@@ -1,404 +0,0 @@
-<?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::Reply</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::Reply</td>
-        </tr>
-        <tr class="top-aligned-row">
-            <td><strong>In:</strong></td>
-            <td>
-                <a href="../../../files/lib/mcollective/rpc/reply_rb.html">
-                lib/mcollective/rpc/reply.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 replies to <a
-href="../RPC.html">MCollective::RPC</a>
-</p>
-
-    </div>
-
-
-   </div>
-
-    <div id="method-list">
-      <h3 class="section-bar">Methods</h3>
-
-      <div class="name-list">
-      <a href="#M000077">[]</a>&nbsp;&nbsp;
-      <a href="#M000076">[]=</a>&nbsp;&nbsp;
-      <a href="#M000074">fail</a>&nbsp;&nbsp;
-      <a href="#M000075">fail!</a>&nbsp;&nbsp;
-      <a href="#M000078">fetch</a>&nbsp;&nbsp;
-      <a href="#M000073">initialize_data</a>&nbsp;&nbsp;
-      <a href="#M000072">new</a>&nbsp;&nbsp;
-      <a href="#M000079">to_hash</a>&nbsp;&nbsp;
-      </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">data</td>
-          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
-          <td class="context-item-desc"></td>
-        </tr>
-        <tr class="top-aligned-row context-row">
-          <td class="context-item-name">statuscode</td>
-          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
-          <td class="context-item-desc"></td>
-        </tr>
-        <tr class="top-aligned-row context-row">
-          <td class="context-item-name">statusmsg</td>
-          <td class="context-item-value">&nbsp;[RW]&nbsp;</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-M000072" class="method-detail">
-        <a name="M000072"></a>
-
-        <div class="method-heading">
-          <a href="#M000072" class="method-signature">
-          <span class="method-name">new</span><span class="method-args">(action, ddl)</span>
-          </a>
-        </div>
-      
-        <div class="method-description">
-          <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000072-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000072-source">
-<pre>
-    <span class="ruby-comment cmt"># File lib/mcollective/rpc/reply.rb, line 7</span>
- 7:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">action</span>, <span class="ruby-identifier">ddl</span>)
- 8:         <span class="ruby-ivar">@data</span> = {}
- 9:         <span class="ruby-ivar">@statuscode</span> = <span class="ruby-value">0</span>
-10:         <span class="ruby-ivar">@statusmsg</span> = <span class="ruby-value str">&quot;OK&quot;</span>
-11:         <span class="ruby-ivar">@ddl</span> = <span class="ruby-identifier">ddl</span>
-12:         <span class="ruby-ivar">@action</span> = <span class="ruby-identifier">action</span>
-13: 
-14:         <span class="ruby-keyword kw">begin</span>
-15:           <span class="ruby-identifier">initialize_data</span>
-16:         <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">e</span>
-17:           <span class="ruby-constant">Log</span>.<span class="ruby-identifier">warn</span>(<span class="ruby-value str">&quot;Could not pre-populate reply data from the DDL: %s: %s&quot;</span> <span class="ruby-operator">%</span> [<span class="ruby-identifier">e</span>.<span class="ruby-identifier">class</span>, <span class="ruby-identifier">e</span>.<span class="ruby-identifier">to_s</span> ])
-18:         <span class="ruby-keyword kw">end</span>
-19:       <span class="ruby-keyword kw">end</span>
-</pre>
-          </div>
-        </div>
-      </div>
-
-      <h3 class="section-bar">Public Instance methods</h3>
-
-      <div id="method-M000077" class="method-detail">
-        <a name="M000077"></a>
-
-        <div class="method-heading">
-          <a href="#M000077" class="method-signature">
-          <span class="method-name">[]</span><span class="method-args">(key)</span>
-          </a>
-        </div>
-      
-        <div class="method-description">
-          <p>
-Read from the data hash
-</p>
-          <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000077-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000077-source">
-<pre>
-    <span class="ruby-comment cmt"># File lib/mcollective/rpc/reply.rb, line 70</span>
-70:       <span class="ruby-keyword kw">def</span> <span class="ruby-operator">[]</span>(<span class="ruby-identifier">key</span>)
-71:         <span class="ruby-ivar">@data</span>[<span class="ruby-identifier">key</span>]
-72:       <span class="ruby-keyword kw">end</span>
-</pre>
-          </div>
-        </div>
-      </div>
-
-      <div id="method-M000076" class="method-detail">
-        <a name="M000076"></a>
-
-        <div class="method-heading">
-          <a href="#M000076" class="method-signature">
-          <span class="method-name">[]=</span><span class="method-args">(key, val)</span>
-          </a>
-        </div>
-      
-        <div class="method-description">
-          <p>
-Write to the data hash
-</p>
-          <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000076-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000076-source">
-<pre>
-    <span class="ruby-comment cmt"># File lib/mcollective/rpc/reply.rb, line 65</span>
-65:       <span class="ruby-keyword kw">def</span> <span class="ruby-operator">[]=</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">val</span>)
-66:         <span class="ruby-ivar">@data</span>[<span class="ruby-identifier">key</span>] = <span class="ruby-identifier">val</span>
-67:       <span class="ruby-keyword kw">end</span>
-</pre>
-          </div>
-        </div>
-      </div>
-
-      <div id="method-M000074" class="method-detail">
-        <a name="M000074"></a>
-
-        <div class="method-heading">
-          <a href="#M000074" class="method-signature">
-          <span class="method-name">fail</span><span class="method-args">(msg, code=1)</span>
-          </a>
-        </div>
-      
-        <div class="method-description">
-          <p>
-Helper to fill in statusmsg and code on failure
-</p>
-          <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000074-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000074-source">
-<pre>
-    <span class="ruby-comment cmt"># File lib/mcollective/rpc/reply.rb, line 36</span>
-36:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">fail</span>(<span class="ruby-identifier">msg</span>, <span class="ruby-identifier">code</span>=<span class="ruby-value">1</span>)
-37:         <span class="ruby-ivar">@statusmsg</span> = <span class="ruby-identifier">msg</span>
-38:         <span class="ruby-ivar">@statuscode</span> = <span class="ruby-identifier">code</span>
-39:       <span class="ruby-keyword kw">end</span>
-</pre>
-          </div>
-        </div>
-      </div>
-
-      <div id="method-M000075" class="method-detail">
-        <a name="M000075"></a>
-
-        <div class="method-heading">
-          <a href="#M000075" class="method-signature">
-          <span class="method-name">fail!</span><span class="method-args">(msg, code=1)</span>
-          </a>
-        </div>
-      
-        <div class="method-description">
-          <p>
-Helper that fills in statusmsg and code but also raises an appropriate
-error
-</p>
-          <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000075-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000075-source">
-<pre>
-    <span class="ruby-comment cmt"># File lib/mcollective/rpc/reply.rb, line 42</span>
-42:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">fail!</span>(<span class="ruby-identifier">msg</span>, <span class="ruby-identifier">code</span>=<span class="ruby-value">1</span>)
-43:         <span class="ruby-ivar">@statusmsg</span> = <span class="ruby-identifier">msg</span>
-44:         <span class="ruby-ivar">@statuscode</span> = <span class="ruby-identifier">code</span>
-45: 
-46:         <span class="ruby-keyword kw">case</span> <span class="ruby-identifier">code</span>
-47:           <span class="ruby-keyword kw">when</span> <span class="ruby-value">1</span>
-48:             <span class="ruby-identifier">raise</span> <span class="ruby-constant">RPCAborted</span>, <span class="ruby-identifier">msg</span>
-49: 
-50:           <span class="ruby-keyword kw">when</span> <span class="ruby-value">2</span>
-51:             <span class="ruby-identifier">raise</span> <span class="ruby-constant">UnknownRPCAction</span>, <span class="ruby-identifier">msg</span>
-52: 
-53:           <span class="ruby-keyword kw">when</span> <span class="ruby-value">3</span>
-54:             <span class="ruby-identifier">raise</span> <span class="ruby-constant">MissingRPCData</span>, <span class="ruby-identifier">msg</span>
-55: 
-56:           <span class="ruby-keyword kw">when</span> <span class="ruby-value">4</span>
-57:             <span class="ruby-identifier">raise</span> <span class="ruby-constant">InvalidRPCData</span>, <span class="ruby-identifier">msg</span>
-58: 
-59:           <span class="ruby-keyword kw">else</span>
-60:             <span class="ruby-identifier">raise</span> <span class="ruby-constant">UnknownRPCError</span>, <span class="ruby-identifier">msg</span>
-61:         <span class="ruby-keyword kw">end</span>
-62:       <span class="ruby-keyword kw">end</span>
-</pre>
-          </div>
-        </div>
-      </div>
-
-      <div id="method-M000078" class="method-detail">
-        <a name="M000078"></a>
-
-        <div class="method-heading">
-          <a href="#M000078" 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('M000078-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000078-source">
-<pre>
-    <span class="ruby-comment cmt"># File lib/mcollective/rpc/reply.rb, line 74</span>
-74:       <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>)
-75:         <span class="ruby-ivar">@data</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">default</span>)
-76:       <span class="ruby-keyword kw">end</span>
-</pre>
-          </div>
-        </div>
-      </div>
-
-      <div id="method-M000073" class="method-detail">
-        <a name="M000073"></a>
-
-        <div class="method-heading">
-          <a href="#M000073" class="method-signature">
-          <span class="method-name">initialize_data</span><span class="method-args">()</span>
-          </a>
-        </div>
-      
-        <div class="method-description">
-          <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000073-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000073-source">
-<pre>
-    <span class="ruby-comment cmt"># File lib/mcollective/rpc/reply.rb, line 21</span>
-21:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize_data</span>
-22:         <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@ddl</span>.<span class="ruby-identifier">actions</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-ivar">@action</span>)
-23:           <span class="ruby-identifier">raise</span> <span class="ruby-value str">&quot;No action '%s' defined for agent '%s' in the DDL&quot;</span> <span class="ruby-operator">%</span> [<span class="ruby-ivar">@action</span>, <span class="ruby-ivar">@ddl</span>.<span class="ruby-identifier">pluginname</span>]
-24:         <span class="ruby-keyword kw">end</span>
-25: 
-26:         <span class="ruby-identifier">interface</span> = <span class="ruby-ivar">@ddl</span>.<span class="ruby-identifier">action_interface</span>(<span class="ruby-ivar">@action</span>)
-27: 
-28:         <span class="ruby-identifier">interface</span>[<span class="ruby-identifier">:output</span>].<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">output</span><span class="ruby-operator">|</span>
-29:           <span class="ruby-comment cmt"># must deep clone this data to avoid accidental updates of the DDL in cases where the</span>
-30:           <span class="ruby-comment cmt"># default is for example a string and someone does &lt;&lt; on it</span>
-31:           <span class="ruby-ivar">@data</span>[<span class="ruby-identifier">output</span>] = <span class="ruby-constant">Marshal</span>.<span class="ruby-identifier">load</span>(<span class="ruby-constant">Marshal</span>.<span class="ruby-identifier">dump</span>(<span class="ruby-identifier">interface</span>[<span class="ruby-identifier">:output</span>][<span class="ruby-identifier">output</span>].<span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">:default</span>, <span class="ruby-keyword kw">nil</span>)))
-32:         <span class="ruby-keyword kw">end</span>
-33:       <span class="ruby-keyword kw">end</span>
-</pre>
-          </div>
-        </div>
-      </div>
-
-      <div id="method-M000079" class="method-detail">
-        <a name="M000079"></a>
-
-        <div class="method-heading">
-          <a href="#M000079" class="method-signature">
-          <span class="method-name">to_hash</span><span class="method-args">()</span>
-          </a>
-        </div>
-      
-        <div class="method-description">
-          <p>
-Returns a compliant Hash of the reply that should be sent over the
-middleware
-</p>
-          <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000079-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000079-source">
-<pre>
-    <span class="ruby-comment cmt"># File lib/mcollective/rpc/reply.rb, line 80</span>
-80:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_hash</span>
-81:         <span class="ruby-keyword kw">return</span> {<span class="ruby-identifier">:statuscode</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-ivar">@statuscode</span>,
-82:                 <span class="ruby-identifier">:statusmsg</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-ivar">@statusmsg</span>,
-83:                 <span class="ruby-identifier">:data</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-ivar">@data</span>}
-84:       <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