1 USING: help.syntax help.markup ;
5 { $values { "rpc" "an RPC data type" } { "xml" "an XML document" } }
6 { $description "converts an RPC data type into an XML document which can be sent to another computer" }
7 { $see-also receive-rpc } ;
10 { $values { "xml" "an XML document" } { "rpc" "an RPC data type" } }
11 { $description "parses an XML document into an RPC data type, for further local processing" }
12 { $see-also send-rpc } ;
15 { $values { "string" "a string" } { "base64" "a base64 tuple" } }
16 { $description "creates a base64 tuple using the data in the string. This marks the data for encoding in the base64 format" }
17 { $see-also base64 } ;
20 { $class-description "a piece of data marked for encoding as base64 in an XML-RPC message" }
21 { $see-also <base64> } ;
24 { $values { "name" "a string" } { "params" "a sequence" } { "rpc-method" rpc-method } }
25 { $description "creates a tuple reprsenting a method call which can be translated using send-rpc into an XML-RPC document" }
26 { $see-also rpc-method <rpc-response> <rpc-fault> } ;
29 { $class-description "a tuple which is equivalent to an XML-RPC method send. Contains two fields, name and params" }
30 { $see-also <rpc-method> rpc-response rpc-fault } ;
33 { $values { "params" "a sequence" } { "rpc-response" rpc-response } }
34 { $description "creates a tuple representing a data response in XML-RPC" }
35 { $see-also rpc-response <rpc-method> <rpc-fault> } ;
38 { $class-description "represents an XML-RPC method response, with a number of paramters holding data. Contains one field, params, a sequence" }
39 { $see-also <rpc-response> rpc-method rpc-fault } ;
42 { $values { "code" "an integer" } { "string" "a string" } { "rpc-fault" rpc-fault } }
43 { $description "creates a tuple representing an exception in RPC, to be returned to the caller. The code is a number representing what type of error it is, and the string is a description" }
44 { $see-also rpc-fault <rpc-method> <rpc-response> } ;
47 { $class-description "represents an XML-RPC fault" }
48 { $see-also <rpc-fault> rpc-method rpc-response } ;
51 { $values { "rpc" "an XML-RPC input tuple" } { "url" "a URL" }
52 { "rpc" "an XML-RPC output tuple" } }
53 { $description "posts an XML-RPC document to the specified URL, receives the response and parses it as XML-RPC, returning the tuple" } ;
55 ARTICLE: { "xml-rpc" "intro" } "XML-RPC"
56 "This is the XML-RPC library. XML-RPC is used instead of SOAP because it is far simpler and easier to use for most tasks. The library was implemented by Daniel Ehrenberg."
58 "The most important words that this library implements are:"
59 { $subsection send-rpc }
60 { $subsection receive-rpc }
61 "data types in XML-RPC"
62 { $subsection base64 }
63 { $subsection rpc-method }
64 { $subsection rpc-response }
65 { $subsection rpc-fault }
66 "the constructors for these are"
67 { $subsection <base64> }
68 { $subsection <rpc-method> }
69 { $subsection <rpc-response> }
70 { $subsection <rpc-fault> }
72 { $subsection post-rpc } ;