X-Git-Url: https://review.fuel-infra.org/gitweb?a=blobdiff_plain;f=doc%2Fclasses%2FMCollective%2FRPC%2FResult.html;fp=doc%2Fclasses%2FMCollective%2FRPC%2FResult.html;h=0000000000000000000000000000000000000000;hb=7c9314f502cde8daad23b61d10b24a542e04154a;hp=225f3c847fb795d5c3041e98a7f060a5bc8f13d5;hpb=d1f1649ba43c5cbc43c4beb2380096ba051d646a;p=packages%2Fprecise%2Fmcollective.git diff --git a/doc/classes/MCollective/RPC/Result.html b/doc/classes/MCollective/RPC/Result.html deleted file mode 100644 index 225f3c8..0000000 --- a/doc/classes/MCollective/RPC/Result.html +++ /dev/null @@ -1,317 +0,0 @@ - - - - - - Class: MCollective::RPC::Result - - - - - - - - - - -
- - - - - - - - - - - - - - -
ClassMCollective::RPC::Result
In: - - lib/mcollective/rpc/result.rb - -
-
Parent: - Object -
-
- - -
- - - -
- -
-

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

- -
- - -
- -
-

Methods

- -
- []   - []=   - each   - fetch   - new   - to_json   -
-
- -
- - - -
-

Included Modules

- -
- Enumerable -
-
- -
- - - - - -
-

Attributes

- -
- - - - - - - - - - - - - - - - -
action [R] 
agent [R] 
results [R] 
-
-
- - - - -
-

Public Class methods

- -
- - -
- - new(agent, action, result={}) - -
- -
-

[Source]

-
-
-    # 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) - -
- -
-

[Source]

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

[Source]

-
-
-    # File lib/mcollective/rpc/result.rb, line 23
-23:       def []=(idx, item)
-24:         @results[idx] = item
-25:       end
-
-
-
-
- -
- - -
- - each() {|k,v| ...} - -
- -
-

[Source]

-
-
-    # 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) - -
- -
-

[Source]

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

[Source]

-
-
-    # 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
-
-
-
-
- - -
- - -
- - -
-

[Validate]

-
- - - \ No newline at end of file