ruby/lib/xmlrpc
drbrain 83d7aca7f6 * Various .document files: Update .document files to match files which
have documentation.


git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@31524 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2011-05-11 22:31:17 +00:00
..
README.rdoc added howto 2004-11-16 14:12:53 +00:00
README.txt * lib/gserver.rb: documented 2004-05-04 15:42:39 +00:00
base64.rb * {ext,lib,test}/**/*.rb: removed trailing spaces. 2009-03-06 03:56:38 +00:00
client.rb * {ext,lib,test}/**/*.rb: removed trailing spaces. 2009-03-06 03:56:38 +00:00
config.rb * {ext,lib,test}/**/*.rb: removed trailing spaces. 2009-03-06 03:56:38 +00:00
create.rb Use Float#finite?. 2011-04-22 13:35:43 +00:00
datetime.rb * {ext,lib,test}/**/*.rb: removed trailing spaces. 2009-03-06 03:56:38 +00:00
httpserver.rb * lib/*.rb: Remove unused variable warnings. 2010-11-08 20:59:01 +00:00
marshal.rb * {ext,lib,test}/**/*.rb: removed trailing spaces. 2009-03-06 03:56:38 +00:00
parser.rb * lib/*.rb: Remove unused variable warnings. 2010-11-08 20:59:01 +00:00
server.rb * lib: fixed typo. a patch by Sho Hashimoto in [ruby-dev:40716]. 2010-03-20 03:30:59 +00:00
utils.rb * lib/xmlrpc/utils.rb: Fixing an incompatibility with 2010-04-28 18:51:35 +00:00

README.txt

= XMLRPC for Ruby, Standard Library Documentation

== Overview

XMLRPC is a lightweight protocol that enables remote procedure calls over
HTTP.  It is defined at http://www.xmlrpc.com.

XMLRPC allows you to create simple distributed computing solutions that span
computer languages.  Its distinctive feature is its simplicity compared to
other approaches like SOAP and CORBA.

The Ruby standard library package 'xmlrpc' enables you to create a server that
implements remote procedures and a client that calls them.  Very little code
is required to achieve either of these.

== Example

Try the following code.  It calls a standard demonstration remote procedure.

  require 'xmlrpc/client'
  require 'pp'

  server = XMLRPC::Client.new2("http://xmlrpc-c.sourceforge.net/api/sample.php")
  result = server.call("sample.sumAndDifference", 5, 3)
  pp result

== Documentation

See http://www.ntecs.de/projects/xmlrpc4r.  There is plenty of detail there to
use the client and implement a server.