ruby--ruby

mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00

History

gsinclair 898a1e7197 * lib/gserver.rb: documented * lib/xmlrpc/README.txt: introduced for documentation purposes git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@6245 b2dd03c8-39d4-4d8f-98ff-823fe69b080e		2004-05-04 15:42:39 +00:00
..
base64.rb	* lib/xmlrpc: import.	2003-07-19 10:05:54 +00:00
client.rb	class XMLRPC::Client:	2003-11-17 21:30:31 +00:00
config.rb	* lib/xmlrpc: import.	2003-07-19 10:05:54 +00:00
create.rb	* lib/xmlrpc: import.	2003-07-19 10:05:54 +00:00
datetime.rb	* lib/xmlrpc: import.	2003-07-19 10:05:54 +00:00
httpserver.rb	* lib/xmlrpc: import.	2003-07-19 10:05:54 +00:00
marshal.rb	* lib/xmlrpc: import.	2003-07-19 10:05:54 +00:00
parser.rb	* exception message clean-up by Ian Macdonald <ian@caliban.org>.	2004-03-29 07:54:38 +00:00
README.txt	* lib/gserver.rb: documented	2004-05-04 15:42:39 +00:00
server.rb	applied patch by OHARA Shigeki:	2003-10-07 11:22:16 +00:00
utils.rb	* gc.c (id2ref): recycle check should be done by klass == 0.	2003-08-14 17:20:14 +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.