--- /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::Request</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::Request</td>
+ </tr>
+ <tr class="top-aligned-row">
+ <td><strong>In:</strong></td>
+ <td>
+ <a href="../../../files/lib/mcollective/rpc/request_rb.html">
+ lib/mcollective/rpc/request.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 requests for <a
+href="../RPC.html">MCollective::RPC</a> agents
+</p>
+
+ </div>
+
+
+ </div>
+
+ <div id="method-list">
+ <h3 class="section-bar">Methods</h3>
+
+ <div class="name-list">
+ <a href="#M000138">[]</a>
+ <a href="#M000139">fetch</a>
+ <a href="#M000136">include?</a>
+ <a href="#M000135">new</a>
+ <a href="#M000137">should_respond?</a>
+ <a href="#M000140">to_hash</a>
+ <a href="#M000142">to_json</a>
+ <a href="#M000141">validate!</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">action</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">agent</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">caller</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">data</td>
+ <td class="context-item-value"> [RW] </td>
+ <td class="context-item-desc"></td>
+ </tr>
+ <tr class="top-aligned-row context-row">
+ <td class="context-item-name">ddl</td>
+ <td class="context-item-value"> [RW] </td>
+ <td class="context-item-desc"></td>
+ </tr>
+ <tr class="top-aligned-row context-row">
+ <td class="context-item-name">sender</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">time</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">uniqid</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-M000135" class="method-detail">
+ <a name="M000135"></a>
+
+ <div class="method-heading">
+ <a href="#M000135" class="method-signature">
+ <span class="method-name">new</span><span class="method-args">(msg, ddl)</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p><a class="source-toggle" href="#"
+ onclick="toggleCode('M000135-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000135-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc/request.rb, line 7</span>
+ 7: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">msg</span>, <span class="ruby-identifier">ddl</span>)
+ 8: <span class="ruby-ivar">@time</span> = <span class="ruby-identifier">msg</span>[<span class="ruby-identifier">:msgtime</span>]
+ 9: <span class="ruby-ivar">@action</span> = <span class="ruby-identifier">msg</span>[<span class="ruby-identifier">:body</span>][<span class="ruby-identifier">:action</span>]
+10: <span class="ruby-ivar">@data</span> = <span class="ruby-identifier">msg</span>[<span class="ruby-identifier">:body</span>][<span class="ruby-identifier">:data</span>]
+11: <span class="ruby-ivar">@sender</span> = <span class="ruby-identifier">msg</span>[<span class="ruby-identifier">:senderid</span>]
+12: <span class="ruby-ivar">@agent</span> = <span class="ruby-identifier">msg</span>[<span class="ruby-identifier">:body</span>][<span class="ruby-identifier">:agent</span>]
+13: <span class="ruby-ivar">@uniqid</span> = <span class="ruby-identifier">msg</span>[<span class="ruby-identifier">:requestid</span>]
+14: <span class="ruby-ivar">@caller</span> = <span class="ruby-identifier">msg</span>[<span class="ruby-identifier">:callerid</span>] <span class="ruby-operator">||</span> <span class="ruby-value str">"unknown"</span>
+15: <span class="ruby-ivar">@ddl</span> = <span class="ruby-identifier">ddl</span>
+16: <span class="ruby-keyword kw">end</span>
+</pre>
+ </div>
+ </div>
+ </div>
+
+ <h3 class="section-bar">Public Instance methods</h3>
+
+ <div id="method-M000138" class="method-detail">
+ <a name="M000138"></a>
+
+ <div class="method-heading">
+ <a href="#M000138" class="method-signature">
+ <span class="method-name">[]</span><span class="method-args">(key)</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p>
+If data is a hash, gives easy access to its members, else returns nil
+</p>
+ <p><a class="source-toggle" href="#"
+ onclick="toggleCode('M000138-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000138-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc/request.rb, line 34</span>
+34: <span class="ruby-keyword kw">def</span> <span class="ruby-operator">[]</span>(<span class="ruby-identifier">key</span>)
+35: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">nil</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@data</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Hash</span>)
+36: <span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@data</span>[<span class="ruby-identifier">key</span>]
+37: <span class="ruby-keyword kw">end</span>
+</pre>
+ </div>
+ </div>
+ </div>
+
+ <div id="method-M000139" class="method-detail">
+ <a name="M000139"></a>
+
+ <div class="method-heading">
+ <a href="#M000139" 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('M000139-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000139-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc/request.rb, line 39</span>
+39: <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>)
+40: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">nil</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@data</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Hash</span>)
+41: <span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@data</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">default</span>)
+42: <span class="ruby-keyword kw">end</span>
+</pre>
+ </div>
+ </div>
+ </div>
+
+ <div id="method-M000136" class="method-detail">
+ <a name="M000136"></a>
+
+ <div class="method-heading">
+ <a href="#M000136" class="method-signature">
+ <span class="method-name">include?</span><span class="method-args">(key)</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p>
+If data is a hash, quick helper to get access to it‘s <a
+href="Request.html#M000136">include?</a> method else returns false
+</p>
+ <p><a class="source-toggle" href="#"
+ onclick="toggleCode('M000136-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000136-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc/request.rb, line 20</span>
+20: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">include?</span>(<span class="ruby-identifier">key</span>)
+21: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@data</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Hash</span>)
+22: <span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@data</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">key</span>)
+23: <span class="ruby-keyword kw">end</span>
+</pre>
+ </div>
+ </div>
+ </div>
+
+ <div id="method-M000137" class="method-detail">
+ <a name="M000137"></a>
+
+ <div class="method-heading">
+ <a href="#M000137" class="method-signature">
+ <span class="method-name">should_respond?</span><span class="method-args">()</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p>
+If no :process_results is specified always respond else respond based on
+the supplied property
+</p>
+ <p><a class="source-toggle" href="#"
+ onclick="toggleCode('M000137-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000137-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc/request.rb, line 27</span>
+27: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">should_respond?</span>
+28: <span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@data</span>[<span class="ruby-identifier">:process_results</span>] <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@data</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">:process_results</span>)
+29:
+30: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span>
+31: <span class="ruby-keyword kw">end</span>
+</pre>
+ </div>
+ </div>
+ </div>
+
+ <div id="method-M000140" class="method-detail">
+ <a name="M000140"></a>
+
+ <div class="method-heading">
+ <a href="#M000140" class="method-signature">
+ <span class="method-name">to_hash</span><span class="method-args">()</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p><a class="source-toggle" href="#"
+ onclick="toggleCode('M000140-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000140-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc/request.rb, line 44</span>
+44: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_hash</span>
+45: <span class="ruby-keyword kw">return</span> {<span class="ruby-identifier">:agent</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@agent</span>,
+46: <span class="ruby-identifier">:action</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@action</span>,
+47: <span class="ruby-identifier">:data</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@data</span>}
+48: <span class="ruby-keyword kw">end</span>
+</pre>
+ </div>
+ </div>
+ </div>
+
+ <div id="method-M000142" class="method-detail">
+ <a name="M000142"></a>
+
+ <div class="method-heading">
+ <a href="#M000142" class="method-signature">
+ <span class="method-name">to_json</span><span class="method-args">()</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p><a class="source-toggle" href="#"
+ onclick="toggleCode('M000142-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000142-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc/request.rb, line 55</span>
+55: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_json</span>
+56: <span class="ruby-identifier">to_hash</span>.<span class="ruby-identifier">merge!</span>({<span class="ruby-identifier">:sender</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@sender</span>,
+57: <span class="ruby-identifier">:callerid</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@callerid</span>,
+58: <span class="ruby-identifier">:uniqid</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@uniqid</span>}).<span class="ruby-identifier">to_json</span>
+59: <span class="ruby-keyword kw">end</span>
+</pre>
+ </div>
+ </div>
+ </div>
+
+ <div id="method-M000141" class="method-detail">
+ <a name="M000141"></a>
+
+ <div class="method-heading">
+ <a href="#M000141" class="method-signature">
+ <span class="method-name">validate!</span><span class="method-args">()</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p>
+Validate the request against the <a href="../DDL.html">DDL</a>
+</p>
+ <p><a class="source-toggle" href="#"
+ onclick="toggleCode('M000141-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000141-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc/request.rb, line 51</span>
+51: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">validate!</span>
+52: <span class="ruby-ivar">@ddl</span>.<span class="ruby-identifier">validate_rpc_request</span>(<span class="ruby-ivar">@action</span>, <span class="ruby-ivar">@data</span>)
+53: <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