X-Git-Url: https://review.fuel-infra.org/gitweb?a=blobdiff_plain;ds=sidebyside;f=doc%2FMCollective%2FRPC%2FResult.html;fp=doc%2FMCollective%2FRPC%2FResult.html;h=9fc35811269e4ea81a04281d1836e1ab5dc80258;hb=7c9314f502cde8daad23b61d10b24a542e04154a;hp=0000000000000000000000000000000000000000;hpb=d1f1649ba43c5cbc43c4beb2380096ba051d646a;p=packages%2Fprecise%2Fmcollective.git diff --git a/doc/MCollective/RPC/Result.html b/doc/MCollective/RPC/Result.html new file mode 100644 index 0000000..9fc3581 --- /dev/null +++ b/doc/MCollective/RPC/Result.html @@ -0,0 +1,649 @@ + + + + + + + Class: MCollective::RPC::Result + + + + + + + + + + + +
+
+
+

In Files

+
+ +
+
+ + +
+ +
+ + + +
+

Parent

+ +

Object

+ +
+ + + + + + + +
+

Methods

+ +
+ + + + +
+

Included Modules

+
    + + +
  • Enumerable
    • + + +
+
+ +
+ +
+ + + + + +
+

Class Index + [+]

+
+
+ Quicksearch + +
+
+ + + +
+ + +
+
+ +
+

MCollective::RPC::Result

+ +
+

+Simple class to manage compliant results from MCollective::RPC agents +

+

+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 DDL +

+ +
+ + + + + + +
+

Attributes

+ + +
+ + +
+ agent[R] +
+ +
+ +

(Not documented)

+ +
+
+ +
+ + +
+ action[R] +
+ +
+ +

(Not documented)

+ +
+
+ +
+ + +
+ results[R] +
+ +
+ +

(Not documented)

+ +
+
+ +
+ + + + +
+

Public Class Methods

+ + +
+ + +
+ + new(agent, action, result={}) + click to toggle source + +
+ +
+ +

(Not documented)

+ + + +
+
+    # File lib/mcollective/rpc/result.rb, line 13
+13:       def initialize(agent, action, result={})
+14:         @agent = agent
+15:         @action = action
+16:         @results = result
+17:       end
+
+ +
+ + +
+ + +
+ +
+

Public Instance Methods

+ + +
+ + +
+ + [](idx) + click to toggle source + +
+ +
+ +

(Not documented)

+ + + +
+
+    # File lib/mcollective/rpc/result.rb, line 19
+19:       def [](idx)
+20:         @results[idx]
+21:       end
+
+ +
+ + +
+ + +
+ + +
+ + []=(idx, item) + click to toggle source + +
+ +
+ +

(Not documented)

+ + + +
+
+    # File lib/mcollective/rpc/result.rb, line 23
+23:       def []=(idx, item)
+24:         @results[idx] = item
+25:       end
+
+ +
+ + +
+ + +
+ + +
+ + each() + click to toggle source + +
+ +
+ +

(Not documented)

+ + + +
+
+    # File lib/mcollective/rpc/result.rb, line 31
+31:       def each
+32:         @results.each_pair {|k,v| yield(k,v) }
+33:       end
+
+ +
+ + +
+ + +
+ + +
+ + fetch(key, default) + click to toggle source + +
+ +
+ +

(Not documented)

+ + + +
+
+    # File lib/mcollective/rpc/result.rb, line 27
+27:       def fetch(key, default)
+28:         @results.fetch(key, default)
+29:       end
+
+ +
+ + +
+ + +
+ + +
+ + to_json(*a) + click to toggle source + +
+ +
+ +

(Not documented)

+ + + +
+
+    # File lib/mcollective/rpc/result.rb, line 35
+35:       def to_json(*a)
+36:         {:agent => @agent,
+37:          :action => @action,
+38:          :sender => @results[:sender],
+39:          :statuscode => @results[:statuscode],
+40:          :statusmsg => @results[:statusmsg],
+41:          :data => @results[:data]}.to_json(*a)
+42:       end
+
+ +
+ + +
+ + +
+ + +
+ + +
+ +

Disabled; run with --debug to generate this.

+ +
+ +
+

[Validate]

+

Generated with the Darkfish + Rdoc Generator 1.1.6.

+
+ + + +