/[s-xml-rpc]/public_html/S-XML-RPC.html
ViewVC logotype

Contents of /public_html/S-XML-RPC.html

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.1 - (show annotations)
Mon Jun 14 20:25:18 2004 UTC (9 years, 10 months ago) by scaekenberghe
Branch: MAIN
CVS Tags: HEAD
File MIME type: text/html
updated docs with API reference, etc...
1 <html><head><title>S-XML-RPC</title></head><body><h3>API for package S-XML-RPC</h3>
2 <blockquote>An implementation of the standard XML-RPC protocol for both client and server</blockquote>
3 <p><b>*xml-rpc-agent*</b>&nbsp;&nbsp;&nbsp;<i>variable</i></p>
4 <blockquote>String specifying the default XML-RPC agent to include in server responses</blockquote>
5 <blockquote>Initial value: <tt>"LispWorks 4.3.7"</tt></blockquote>
6 <p><b>*xml-rpc-authorization*</b>&nbsp;&nbsp;&nbsp;<i>variable</i></p>
7 <blockquote>When not null, a string to be used as Authorization header</blockquote>
8 <blockquote>Initial value: <tt>NIL</tt></blockquote>
9 <p><b>*xml-rpc-call-hook*</b>&nbsp;&nbsp;&nbsp;<i>variable</i></p>
10 <blockquote>A function to execute the xml-rpc call and return the result, accepting a method-name string and a optional argument list</blockquote>
11 <blockquote>Initial value: <tt>EXECUTE-XML-RPC-CALL</tt></blockquote>
12 <p><b>*xml-rpc-debug*</b>&nbsp;&nbsp;&nbsp;<i>variable</i></p>
13 <blockquote>When T the XML-RPC client and server part will be more verbose about their protocol</blockquote>
14 <blockquote>Initial value: <tt>NIL</tt></blockquote>
15 <p><b>*xml-rpc-debug-stream*</b>&nbsp;&nbsp;&nbsp;<i>variable</i></p>
16 <blockquote>When not nil it specifies where debugging output should be written to</blockquote>
17 <blockquote>Initial value: <tt>NIL</tt></blockquote>
18 <p><b>*xml-rpc-host*</b>&nbsp;&nbsp;&nbsp;<i>variable</i></p>
19 <blockquote>String naming the default XML-RPC host to use</blockquote>
20 <blockquote>Initial value: <tt>"localhost"</tt></blockquote>
21 <p><b>*xml-rpc-package*</b>&nbsp;&nbsp;&nbsp;<i>variable</i></p>
22 <blockquote>Package for XML-RPC callable functions</blockquote>
23 <blockquote>Initial value: <tt>#<The S-XML-RPC-EXPORTS package, 29/64 internal, 0/16 external></tt></blockquote>
24 <p><b>*xml-rpc-port*</b>&nbsp;&nbsp;&nbsp;<i>variable</i></p>
25 <blockquote>Integer specifying the default XML-RPC port to use</blockquote>
26 <blockquote>Initial value: <tt>80</tt></blockquote>
27 <p><b>*xml-rpc-proxy-host*</b>&nbsp;&nbsp;&nbsp;<i>variable</i></p>
28 <blockquote>When not null, a string naming the XML-RPC proxy host to use</blockquote>
29 <blockquote>Initial value: <tt>NIL</tt></blockquote>
30 <p><b>*xml-rpc-proxy-port*</b>&nbsp;&nbsp;&nbsp;<i>variable</i></p>
31 <blockquote>When not null, an integer specifying the XML-RPC proxy port to use</blockquote>
32 <blockquote>Initial value: <tt>NIL</tt></blockquote>
33 <p><b>*xml-rpc-url*</b>&nbsp;&nbsp;&nbsp;<i>variable</i></p>
34 <blockquote>String specifying the default XML-RPC URL to use</blockquote>
35 <blockquote>Initial value: <tt>"/RPC2"</tt></blockquote>
36 <p>(<b>call-xml-rpc-server</b> server-keywords name &rest args)&nbsp;&nbsp;&nbsp;<i>function</i></p>
37 <blockquote>Encode and execute an XML-RPC call with name and args, using the list of server-keywords</blockquote>
38 <p>(<b>encode-xml-rpc-call</b> name &rest args)&nbsp;&nbsp;&nbsp;<i>function</i></p>
39 <blockquote>Encode an XML-RPC call with name and args as an XML string</blockquote>
40 <p>(<b>execute-xml-rpc-call</b> method-name &rest arguments)&nbsp;&nbsp;&nbsp;<i>function</i></p>
41 <blockquote>Execute method METHOD-NAME on ARGUMENTS, or raise an error if
42 no such method exists in *XML-RPC-PACKAGE*</blockquote>
43 <p>(<b>get-xml-rpc-struct-member</b> struct member)&nbsp;&nbsp;&nbsp;<i>function</i></p>
44 <blockquote>Get the value of a specific member of an XML-RPC-STRUCT</blockquote>
45 <p>(setf (<b>get-xml-rpc-struct-member</b> struct member) value)&nbsp;&nbsp;&nbsp;<i>function</i></p>
46 <blockquote>Set the value of a specific member of an XML-RPC-STRUCT</blockquote>
47 <p>(<b>start-xml-rpc-server</b> &key (port *xml-rpc-port*) (url *xml-rpc-url*) (agent *xml-rpc-agent*))&nbsp;&nbsp;&nbsp;<i>function</i></p>
48 <blockquote>Start an XML-RPC server in a separate process</blockquote>
49 <p>(<b>stop-server</b> name)&nbsp;&nbsp;&nbsp;<i>function</i></p>
50 <blockquote>Kill a server process by name (as started by start-standard-server)</blockquote>
51 <p>(<b>system.listmethods</b>)&nbsp;&nbsp;&nbsp;<i>function</i></p>
52 <blockquote>List the methods that are available on this server.</blockquote>
53 <p>(<b>system.methodhelp</b> method-name)&nbsp;&nbsp;&nbsp;<i>function</i></p>
54 <blockquote>Returns the function documentation for the given method.</blockquote>
55 <p>(<b>system.methodsignature</b> method-name)&nbsp;&nbsp;&nbsp;<i>function</i></p>
56 <blockquote>Dummy system.methodSignature implementation. There's no way
57 to get (and no concept of) required argument types in Lisp, so
58 this function always returns nil or errors.</blockquote>
59 <p>(<b>system.multicall</b> calls)&nbsp;&nbsp;&nbsp;<i>function</i></p>
60 <blockquote>Implement system.multicall; see http://www.xmlrpc.com/discuss/msgReader$1208
61 for the specification.</blockquote>
62 <p>(<b>xml-rpc-call</b> encoded &key (url *xml-rpc-url*) (agent *xml-rpc-agent*) (host *xml-rpc-host*) (port *xml-rpc-port*) (authorization *xml-rpc-authorization*) (proxy-host *xml-rpc-proxy-host*) (proxy-port *xml-rpc-proxy-port*))&nbsp;&nbsp;&nbsp;<i>function</i></p>
63 <blockquote>Execute an already encoded XML-RPC call and return the decoded result</blockquote>
64 <p><b>xml-rpc-condition</b>&nbsp;&nbsp;&nbsp;<i>condition</i></p>
65 <blockquote>Parent condition for all conditions thrown by the XML-RPC package</blockquote>
66 <blockquote>Class precedence list: <tt> xml-rpc-condition error serious-condition condition standard-object t</tt></blockquote>
67 <p><b>xml-rpc-error</b>&nbsp;&nbsp;&nbsp;<i>condition</i></p>
68 <blockquote>This condition is thrown when an XML-RPC protocol error occurs</blockquote>
69 <blockquote>Class precedence list: <tt> xml-rpc-error xml-rpc-condition error serious-condition condition standard-object t</tt></blockquote>
70 <blockquote>Class init args: <tt> :data :code</tt></blockquote>
71 <p>(<b>xml-rpc-error-data</b> xml-rpc-error)&nbsp;&nbsp;&nbsp;<i>generic-function</i></p>
72 <blockquote>Get the data from an XML-RPC error</blockquote>
73 <p>(<b>xml-rpc-error-place</b> xml-rpc-error)&nbsp;&nbsp;&nbsp;<i>generic-function</i></p>
74 <blockquote>Get the place from an XML-RPC error</blockquote>
75 <p><b>xml-rpc-fault</b>&nbsp;&nbsp;&nbsp;<i>condition</i></p>
76 <blockquote>This condition is thrown when the XML-RPC server returns a fault</blockquote>
77 <blockquote>Class precedence list: <tt> xml-rpc-fault xml-rpc-condition error serious-condition condition standard-object t</tt></blockquote>
78 <blockquote>Class init args: <tt> :string :code</tt></blockquote>
79 <p>(<b>xml-rpc-fault-code</b> xml-rpc-fault)&nbsp;&nbsp;&nbsp;<i>generic-function</i></p>
80 <blockquote>Get the code from an XML-RPC fault</blockquote>
81 <p>(<b>xml-rpc-fault-string</b> xml-rpc-fault)&nbsp;&nbsp;&nbsp;<i>generic-function</i></p>
82 <blockquote>Get the string from an XML-RPC fault</blockquote>
83 <p><b>xml-rpc-struct</b>&nbsp;&nbsp;&nbsp;<i>structure</i></p>
84 <blockquote>An XML-RPC-STRUCT is an associative map of member names and values</blockquote>
85 <p>(<b>xml-rpc-struct</b> &rest args)&nbsp;&nbsp;&nbsp;<i>function</i></p>
86 <blockquote>Create a new XML-RPC-STRUCT from the arguments: alternating member names and values</blockquote>
87 <p>(<b>xml-rpc-struct-alist</b> object)&nbsp;&nbsp;&nbsp;<i>function</i></p>
88 <blockquote>Return the alist of member names and values from an XML-RPC struct</blockquote>
89 <p>(<b>xml-rpc-struct-equal</b> struct1 struct2)&nbsp;&nbsp;&nbsp;<i>function</i></p>
90 <blockquote>Compare two XML-RPC-STRUCTs for equality</blockquote>
91 <p>(<b>xml-rpc-struct-p</b> object)&nbsp;&nbsp;&nbsp;<i>function</i></p>
92 <blockquote>Return T when the argument is an XML-RPC struct</blockquote>
93 <p><b>xml-rpc-time</b>&nbsp;&nbsp;&nbsp;<i>structure</i></p>
94 <blockquote>A wrapper around a Common Lisp universal time to be interpreted as an XML-RPC-TIME</blockquote>
95 <p>(<b>xml-rpc-time</b> &optional (universal-time (get-universal-time)))&nbsp;&nbsp;&nbsp;<i>function</i></p>
96 <blockquote>Create a new XML-RPC-TIME struct with the universal time specified, defaulting to now</blockquote>
97 <p>(<b>xml-rpc-time-p</b> object)&nbsp;&nbsp;&nbsp;<i>function</i></p>
98 <blockquote>Return T when the argument is an XML-RPC time</blockquote>
99 <p>(<b>xml-rpc-time-universal-time</b> object)&nbsp;&nbsp;&nbsp;<i>function</i></p>
100 <blockquote>Return the universal time from an XML-RPC time</blockquote>
101 <font size=-1><p>Documentation generated by <a href="http://homepage.mac.com/svc/lispdoc/">lispdoc</a> running on LispWorks</p></font></body></html>

  ViewVC Help
Powered by ViewVC 1.1.5