summaryrefslogtreecommitdiff
path: root/README.txt
blob: 6ec8b74950031be4123c597a94a27ced95e534c4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
XmlRpc Light, a small XmlRpc library based on Xml Light and Ocamlnet
====================================================================
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version,,
 * with the special exception on linking described in file LICENSE.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

What is XmlRpc Light?
---------------------

XmlRpc-Light is an XmlRpc client and server library written in
OCaml. It is based on the the Xml-Light and Ocamlnet libraries.

Installation:
-------------

Debian binary:

    sudo apt-get install libxmlrpc-light-ocaml-dev    

Debian source:

    sudo apt-get install libxml-light-ocaml-dev libnethttpd-ocaml-dev
    make
    sudo make install

Fedora binary:

    sudo yum install ocaml-xmlrpc-light

For other environments, install xml-light and ocamlnet from sources available
at the following locations:

    Xml-Light: http://tech.motion-twin.com/xmllight.html
    Ocamlnet: http://projects.camlcity.org/projects/ocamlnet.html

And then run, as usual:

    make
    sudo make install

To uninstall XmlRpc-Light, which you will also need to do if you have
already installed a previous version, type:

    sudo make uninstall

Usage:
------

Client example:

    let rpc = new XmlRpc.client "http://localhost:8000" in
    let result = rpc#call "echo" [`String "hello!"] in
    print_endline (XmlRpc.dump result) ]}

Server example:

    let server = new XmlRpcServer.cgi () in
    server#register "demo.sayHello"
      (fun _ -> `String "Hello!");
    server#run () 

See the Ocamldoc-generated documentation in the "doc" directory for more
details.

Contributors:
-------------

Dave Benjamin (dave@ramenlabs.com)

License:
--------

See LICENSE