class

XMLRPC::Client

v2_2_9 - Show latest stable - Superclass: Object

Provides remote procedure calls to a XML-RPC server.

After setting the connection-parameters with XMLRPC::Client.new which creates a new XMLRPC::Client instance, you can execute a remote procedure by sending the XMLRPC::Client#call or XMLRPC::Client#call2 message to this new instance.

The given parameters indicate which method to call on the remote-side and of course the parameters for the remote procedure.

require "xmlrpc/client"

server = XMLRPC::Client.new("www.ruby-lang.org", "/RPC2", 80)
begin
  param = server.call("michael.add", 4, 5)
  puts "4 + 5 = #{param}"
rescue XMLRPC::FaultException => e
  puts "Error:"
  puts e.faultCode
  puts e.faultString
end

or

require "xmlrpc/client"

server = XMLRPC::Client.new("www.ruby-lang.org", "/RPC2", 80)
ok, param = server.call2("michael.add", 4, 5)
if ok then
  puts "4 + 5 = #{param}"
else
  puts "Error:"
  puts param.faultCode
  puts param.faultString
end

Included modules

  • XMLRPC::ParseContentType
  • XMLRPC::ParserWriterChooseMixin

Constants

USER_AGENT = "XMLRPC::Client (Ruby #{RUBY_VERSION})"

Attributes

[RW]cookie
[R]http
[RW]http_header_extra
[R]http_last_response
[R]password
[R]timeout
[R]user

Files

  • lib/xmlrpc/client.rb