1 <?xml version="1.0" encoding="iso-8859-1"?>
3 PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
6 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
8 <title>Class: MCollective::RPC::Reply</title>
9 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10 <meta http-equiv="Content-Script-Type" content="text/javascript" />
11 <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
12 <script type="text/javascript">
15 function popupCode( url ) {
16 window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
19 function toggleCode( id ) {
20 if ( document.getElementById )
21 elem = document.getElementById( id );
22 else if ( document.all )
23 elem = eval( "document.all." + id );
27 elemStyle = elem.style;
29 if ( elemStyle.display != "block" ) {
30 elemStyle.display = "block"
32 elemStyle.display = "none"
38 // Make codeblocks hidden by default
39 document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
49 <div id="classHeader">
50 <table class="header-table">
51 <tr class="top-aligned-row">
52 <td><strong>Class</strong></td>
53 <td class="class-name-in-header">MCollective::RPC::Reply</td>
55 <tr class="top-aligned-row">
56 <td><strong>In:</strong></td>
58 <a href="../../../files/lib/mcollective/rpc/reply_rb.html">
59 lib/mcollective/rpc/reply.rb
65 <tr class="top-aligned-row">
66 <td><strong>Parent:</strong></td>
73 <!-- banner header -->
75 <div id="bodyContent">
79 <div id="contextContent">
81 <div id="description">
83 Simple class to manage compliant replies to <a
84 href="../RPC.html">MCollective::RPC</a>
92 <div id="method-list">
93 <h3 class="section-bar">Methods</h3>
95 <div class="name-list">
96 <a href="#M000077">[]</a>
97 <a href="#M000076">[]=</a>
98 <a href="#M000074">fail</a>
99 <a href="#M000075">fail!</a>
100 <a href="#M000078">fetch</a>
101 <a href="#M000073">initialize_data</a>
102 <a href="#M000072">new</a>
103 <a href="#M000079">to_hash</a>
118 <div id="attribute-list">
119 <h3 class="section-bar">Attributes</h3>
121 <div class="name-list">
123 <tr class="top-aligned-row context-row">
124 <td class="context-item-name">data</td>
125 <td class="context-item-value"> [RW] </td>
126 <td class="context-item-desc"></td>
128 <tr class="top-aligned-row context-row">
129 <td class="context-item-name">statuscode</td>
130 <td class="context-item-value"> [RW] </td>
131 <td class="context-item-desc"></td>
133 <tr class="top-aligned-row context-row">
134 <td class="context-item-name">statusmsg</td>
135 <td class="context-item-value"> [RW] </td>
136 <td class="context-item-desc"></td>
144 <!-- if method_list -->
146 <h3 class="section-bar">Public Class methods</h3>
148 <div id="method-M000072" class="method-detail">
149 <a name="M000072"></a>
151 <div class="method-heading">
152 <a href="#M000072" class="method-signature">
153 <span class="method-name">new</span><span class="method-args">(action, ddl)</span>
157 <div class="method-description">
158 <p><a class="source-toggle" href="#"
159 onclick="toggleCode('M000072-source');return false;">[Source]</a></p>
160 <div class="method-source-code" id="M000072-source">
162 <span class="ruby-comment cmt"># File lib/mcollective/rpc/reply.rb, line 7</span>
163 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>)
164 8: <span class="ruby-ivar">@data</span> = {}
165 9: <span class="ruby-ivar">@statuscode</span> = <span class="ruby-value">0</span>
166 10: <span class="ruby-ivar">@statusmsg</span> = <span class="ruby-value str">"OK"</span>
167 11: <span class="ruby-ivar">@ddl</span> = <span class="ruby-identifier">ddl</span>
168 12: <span class="ruby-ivar">@action</span> = <span class="ruby-identifier">action</span>
170 14: <span class="ruby-keyword kw">begin</span>
171 15: <span class="ruby-identifier">initialize_data</span>
172 16: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
173 17: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">warn</span>(<span class="ruby-value str">"Could not pre-populate reply data from the DDL: %s: %s"</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> ])
174 18: <span class="ruby-keyword kw">end</span>
175 19: <span class="ruby-keyword kw">end</span>
181 <h3 class="section-bar">Public Instance methods</h3>
183 <div id="method-M000077" class="method-detail">
184 <a name="M000077"></a>
186 <div class="method-heading">
187 <a href="#M000077" class="method-signature">
188 <span class="method-name">[]</span><span class="method-args">(key)</span>
192 <div class="method-description">
194 Read from the data hash
196 <p><a class="source-toggle" href="#"
197 onclick="toggleCode('M000077-source');return false;">[Source]</a></p>
198 <div class="method-source-code" id="M000077-source">
200 <span class="ruby-comment cmt"># File lib/mcollective/rpc/reply.rb, line 70</span>
201 70: <span class="ruby-keyword kw">def</span> <span class="ruby-operator">[]</span>(<span class="ruby-identifier">key</span>)
202 71: <span class="ruby-ivar">@data</span>[<span class="ruby-identifier">key</span>]
203 72: <span class="ruby-keyword kw">end</span>
209 <div id="method-M000076" class="method-detail">
210 <a name="M000076"></a>
212 <div class="method-heading">
213 <a href="#M000076" class="method-signature">
214 <span class="method-name">[]=</span><span class="method-args">(key, val)</span>
218 <div class="method-description">
220 Write to the data hash
222 <p><a class="source-toggle" href="#"
223 onclick="toggleCode('M000076-source');return false;">[Source]</a></p>
224 <div class="method-source-code" id="M000076-source">
226 <span class="ruby-comment cmt"># File lib/mcollective/rpc/reply.rb, line 65</span>
227 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>)
228 66: <span class="ruby-ivar">@data</span>[<span class="ruby-identifier">key</span>] = <span class="ruby-identifier">val</span>
229 67: <span class="ruby-keyword kw">end</span>
235 <div id="method-M000074" class="method-detail">
236 <a name="M000074"></a>
238 <div class="method-heading">
239 <a href="#M000074" class="method-signature">
240 <span class="method-name">fail</span><span class="method-args">(msg, code=1)</span>
244 <div class="method-description">
246 Helper to fill in statusmsg and code on failure
248 <p><a class="source-toggle" href="#"
249 onclick="toggleCode('M000074-source');return false;">[Source]</a></p>
250 <div class="method-source-code" id="M000074-source">
252 <span class="ruby-comment cmt"># File lib/mcollective/rpc/reply.rb, line 36</span>
253 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>)
254 37: <span class="ruby-ivar">@statusmsg</span> = <span class="ruby-identifier">msg</span>
255 38: <span class="ruby-ivar">@statuscode</span> = <span class="ruby-identifier">code</span>
256 39: <span class="ruby-keyword kw">end</span>
262 <div id="method-M000075" class="method-detail">
263 <a name="M000075"></a>
265 <div class="method-heading">
266 <a href="#M000075" class="method-signature">
267 <span class="method-name">fail!</span><span class="method-args">(msg, code=1)</span>
271 <div class="method-description">
273 Helper that fills in statusmsg and code but also raises an appropriate
276 <p><a class="source-toggle" href="#"
277 onclick="toggleCode('M000075-source');return false;">[Source]</a></p>
278 <div class="method-source-code" id="M000075-source">
280 <span class="ruby-comment cmt"># File lib/mcollective/rpc/reply.rb, line 42</span>
281 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>)
282 43: <span class="ruby-ivar">@statusmsg</span> = <span class="ruby-identifier">msg</span>
283 44: <span class="ruby-ivar">@statuscode</span> = <span class="ruby-identifier">code</span>
285 46: <span class="ruby-keyword kw">case</span> <span class="ruby-identifier">code</span>
286 47: <span class="ruby-keyword kw">when</span> <span class="ruby-value">1</span>
287 48: <span class="ruby-identifier">raise</span> <span class="ruby-constant">RPCAborted</span>, <span class="ruby-identifier">msg</span>
289 50: <span class="ruby-keyword kw">when</span> <span class="ruby-value">2</span>
290 51: <span class="ruby-identifier">raise</span> <span class="ruby-constant">UnknownRPCAction</span>, <span class="ruby-identifier">msg</span>
292 53: <span class="ruby-keyword kw">when</span> <span class="ruby-value">3</span>
293 54: <span class="ruby-identifier">raise</span> <span class="ruby-constant">MissingRPCData</span>, <span class="ruby-identifier">msg</span>
295 56: <span class="ruby-keyword kw">when</span> <span class="ruby-value">4</span>
296 57: <span class="ruby-identifier">raise</span> <span class="ruby-constant">InvalidRPCData</span>, <span class="ruby-identifier">msg</span>
298 59: <span class="ruby-keyword kw">else</span>
299 60: <span class="ruby-identifier">raise</span> <span class="ruby-constant">UnknownRPCError</span>, <span class="ruby-identifier">msg</span>
300 61: <span class="ruby-keyword kw">end</span>
301 62: <span class="ruby-keyword kw">end</span>
307 <div id="method-M000078" class="method-detail">
308 <a name="M000078"></a>
310 <div class="method-heading">
311 <a href="#M000078" class="method-signature">
312 <span class="method-name">fetch</span><span class="method-args">(key, default)</span>
316 <div class="method-description">
317 <p><a class="source-toggle" href="#"
318 onclick="toggleCode('M000078-source');return false;">[Source]</a></p>
319 <div class="method-source-code" id="M000078-source">
321 <span class="ruby-comment cmt"># File lib/mcollective/rpc/reply.rb, line 74</span>
322 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>)
323 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>)
324 76: <span class="ruby-keyword kw">end</span>
330 <div id="method-M000073" class="method-detail">
331 <a name="M000073"></a>
333 <div class="method-heading">
334 <a href="#M000073" class="method-signature">
335 <span class="method-name">initialize_data</span><span class="method-args">()</span>
339 <div class="method-description">
340 <p><a class="source-toggle" href="#"
341 onclick="toggleCode('M000073-source');return false;">[Source]</a></p>
342 <div class="method-source-code" id="M000073-source">
344 <span class="ruby-comment cmt"># File lib/mcollective/rpc/reply.rb, line 21</span>
345 21: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize_data</span>
346 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>)
347 23: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"No action '%s' defined for agent '%s' in the DDL"</span> <span class="ruby-operator">%</span> [<span class="ruby-ivar">@action</span>, <span class="ruby-ivar">@ddl</span>.<span class="ruby-identifier">pluginname</span>]
348 24: <span class="ruby-keyword kw">end</span>
350 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>)
352 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>
353 29: <span class="ruby-comment cmt"># must deep clone this data to avoid accidental updates of the DDL in cases where the</span>
354 30: <span class="ruby-comment cmt"># default is for example a string and someone does << on it</span>
355 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>)))
356 32: <span class="ruby-keyword kw">end</span>
357 33: <span class="ruby-keyword kw">end</span>
363 <div id="method-M000079" class="method-detail">
364 <a name="M000079"></a>
366 <div class="method-heading">
367 <a href="#M000079" class="method-signature">
368 <span class="method-name">to_hash</span><span class="method-args">()</span>
372 <div class="method-description">
374 Returns a compliant Hash of the reply that should be sent over the
377 <p><a class="source-toggle" href="#"
378 onclick="toggleCode('M000079-source');return false;">[Source]</a></p>
379 <div class="method-source-code" id="M000079-source">
381 <span class="ruby-comment cmt"># File lib/mcollective/rpc/reply.rb, line 80</span>
382 80: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_hash</span>
383 81: <span class="ruby-keyword kw">return</span> {<span class="ruby-identifier">:statuscode</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@statuscode</span>,
384 82: <span class="ruby-identifier">:statusmsg</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@statusmsg</span>,
385 83: <span class="ruby-identifier">:data</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@data</span>}
386 84: <span class="ruby-keyword kw">end</span>
399 <div id="validator-badges">
400 <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>