Magic handler to invoke remote methods
Once the stub is created using the constructor or the RPC#rpcclient helper you can call remote
actions easily:
ret = rpc.echo(:msg => "hello world")
This will call the ‘echo’ action of the ‘rpctest’
agent and return the result as an array, the array will be a simplified
result set from the usual full MCollective::Client#req with additional
error codes and error text:
{
:sender => "remote.box.com",
:statuscode => 0,
:statusmsg => "OK",
:data => "hello world"
}
If :statuscode is 0 then everything went find, if it’s 1 then you
supplied the correct arguments etc but the request could not be completed,
you’ll find a human parsable reason in :statusmsg then.
Codes 2 to 5 maps directly to UnknownRPCAction, MissingRPCData, InvalidRPCData and UnknownRPCError see below for a
description of those, in each case :statusmsg would be the reason for
failure.
To get access to the full result of the MCollective::Client#req calls you can
pass in a block:
rpc.echo(:msg => "hello world") do |resp|
pp resp
end
In this case resp will the result from MCollective::Client#req. Instead of
returning simple text and codes as above you’ll also need to handle
the following exceptions:
UnknownRPCAction - There is no
matching action on the agent MissingRPCData - You did not supply all
the needed parameters for the action InvalidRPCData - The data you did supply
did not pass validation UnknownRPCError - Some other error
prevented the agent from running
During calls a progress indicator will be shown of how many results
we’ve received against how many nodes were discovered, you can
disable this by setting progress to false:
rpc.progress = false
This supports a 2nd mode where it will send the SimpleRPC request and never
handle the responses. It’s a bit like UDP, it sends the request with
the filter attached and you only get back the requestid, you have no
indication about results.
You can invoke this using:
puts rpc.echo(:process_results => false)
This will output just the request id.
Batched processing is supported:
printrpc rpc.ping(:batch_size => 5)
This will do everything exactly as normal but communicate to only 5 agents
at a time
231: def method_missing(method_name, *args, &block)
232:
233: args = args[0]
234: args = {} if args.nil?
235:
236: action = method_name.to_s
237:
238: @stats.reset
239:
240: validate_request(action, args)
241:
242:
243:
244: batch_mode = args.include?(:batch_size) || @batch_mode
245: batch_size = args.delete(:batch_size) || @batch_size
246: batch_sleep_time = args.delete(:batch_sleep_time) || @batch_sleep_time
247:
248:
249:
250:
251: batch_mode = (batch_mode && Integer(batch_size) > 0)
252:
253:
254:
255:
256: if @limit_targets
257: target_nodes = pick_nodes_from_discovered(@limit_targets)
258: Log.debug("Picked #{target_nodes.join(',')} as limited target(s)")
259:
260: custom_request(action, args, target_nodes, {"identity" => /^(#{target_nodes.join('|')})$/}, &block)
261: elsif batch_mode
262: call_agent_batched(action, args, options, batch_size, batch_sleep_time, &block)
263: else
264: call_agent(action, args, options, :auto, &block)
265: end
266: end
![[+]](../../images/find.png "show/hide quicksearch")