lib/xmlrpc/client.rb

10 require "xmlrpc/create"
16 module XMLRPC # :nodoc:
20   # After setting the connection-parameters with XMLRPC::Client.new which
21   # creates a new XMLRPC::Client instance, you can execute a remote procedure
22   # by sending the XMLRPC::Client#call or XMLRPC::Client#call2
30   #     server = XMLRPC::Client.new("www.ruby-lang.org", "/RPC2", 80)
34   #     rescue XMLRPC::FaultException => e
44   #     server = XMLRPC::Client.new("www.ruby-lang.org", "/RPC2", 80)
55     USER_AGENT = "XMLRPC::Client (Ruby #{RUBY_VERSION})"
119       @create = nil
161     # Receives a Hash and calls XMLRPC::Client.new
238     # * Date, Time, XMLRPC::DateTime
239     # * XMLRPC::Base64
240     # * A Ruby object which class includes XMLRPC::Marshallable
251     # +dateTime.iso8601+ type is always returned as a XMLRPC::DateTime object.
253     # String is always returned. XMLRPC::Base64 is returned as a String from
257     # XMLRPC::FaultException exception is raised, which has two accessor-methods
268     # The difference between this method and XMLRPC::Client#call is, that
269     # this method will <b>NOT</b> raise a XMLRPC::FaultException exception.
272     # the second value is +true+ or an XMLRPC::FaultException.
274     # Both are explained in XMLRPC::Client#call.
278       request = create().methodCall(method, *args)
283     # Similar to XMLRPC::Client#call, however can be called concurrently and
308     # Same as XMLRPC::Client#call2, but can be called concurrently.
310     # See also XMLRPC::Client#call_async
312       request = create().methodCall(method, *args)
318     # You can use this method to execute several methods on a XMLRPC server
335     # Same as XMLRPC::Client#multicall, but returns two parameters instead of
336     # raising an XMLRPC::FaultException.
338     # See XMLRPC::Client#call2
343     # Similar to XMLRPC::Client#multicall, however can be called concurrently and
368     # Same as XMLRPC::Client#multicall2, but can be called concurrently.
370     # See also XMLRPC::Client#multicall_async
376     # Returns an object of class XMLRPC::Client::Proxy, initialized with
379     # A proxy object returned by this method behaves like XMLRPC::Client#call,
380     # i.e. a call on that object will raise a XMLRPC::FaultException when a
386     # Almost the same like XMLRPC::Client#proxy only that a call on the returned
387     # XMLRPC::Client::Proxy object will return two parameters.
389     # See XMLRPC::Client#call2
394     # Similar to XMLRPC::Client#proxy, however can be called concurrently and
414     # Same as XMLRPC::Client#proxy2, but can be called concurrently.
416     # See also XMLRPC::Client#proxy_async
532             XMLRPC::FaultException.new(param["faultCode"], param["faultString"])
547     # XMLRPC::Client::Proxy#method_missing and will forward the method call to
551     # XMLRPC::Client#proxy or XMLRPC::Client#proxy2.
555     #     server = XMLRPC::Client.new("www.ruby-lang.org", "/RPC2", 80)
565       # Creates an object which provides XMLRPC::Client::Proxy#method_missing.
567       # The given +server+ must be an instance of XMLRPC::Client, which is the
585       # XMLRPC::Client::Proxy#new.
599 end # module XMLRPC