S-XML-RPC

### API for package S-XML-RPC

> An implementation of the standard XML-RPC protocol for both client and server

*xml-rpc-agent* variable

> String specifying the default XML-RPC agent to include in server responses

> Initial value: `"LispWorks 4.3.7"`

*xml-rpc-authorization* variable

> When not null, a string to be used as Authorization header

> Initial value: `NIL`

*xml-rpc-call-hook* variable

> A function to execute the xml-rpc call and return the result, accepting a method-name string and a optional argument list

> Initial value: `EXECUTE-XML-RPC-CALL`

*xml-rpc-debug* variable

> When T the XML-RPC client and server part will be more verbose about their protocol

> Initial value: `NIL`

*xml-rpc-debug-stream* variable

> When not nil it specifies where debugging output should be written to

> Initial value: `NIL`

*xml-rpc-host* variable

> String naming the default XML-RPC host to use

> Initial value: `"localhost"`

*xml-rpc-package* variable

> Package for XML-RPC callable functions

> Initial value: `#`

*xml-rpc-port* variable

> Integer specifying the default XML-RPC port to use

> Initial value: `80`

*xml-rpc-proxy-host* variable

> When not null, a string naming the XML-RPC proxy host to use

> Initial value: `NIL`

*xml-rpc-proxy-port* variable

> When not null, an integer specifying the XML-RPC proxy port to use

> Initial value: `NIL`

*xml-rpc-url* variable

> String specifying the default XML-RPC URL to use

> Initial value: `"/RPC2"`

(call-xml-rpc-server server-keywords name &rest args) function

> Encode and execute an XML-RPC call with name and args, using the list of server-keywords

(encode-xml-rpc-call name &rest args) function

> Encode an XML-RPC call with name and args as an XML string

(execute-xml-rpc-call method-name &rest arguments) function

> Execute method METHOD-NAME on ARGUMENTS, or raise an error if no such method exists in *XML-RPC-PACKAGE*

(get-xml-rpc-struct-member struct member) function

> Get the value of a specific member of an XML-RPC-STRUCT

(setf (get-xml-rpc-struct-member struct member) value) function

> Set the value of a specific member of an XML-RPC-STRUCT

(start-xml-rpc-server &key (port *xml-rpc-port*) (url *xml-rpc-url*) (agent *xml-rpc-agent*)) function

> Start an XML-RPC server in a separate process

(stop-server name) function

> Kill a server process by name (as started by start-standard-server)

(system.listmethods) function

> List the methods that are available on this server.

(system.methodhelp method-name) function

> Returns the function documentation for the given method.

(system.methodsignature method-name) function

> Dummy system.methodSignature implementation. There's no way to get (and no concept of) required argument types in Lisp, so this function always returns nil or errors.

(system.multicall calls) function

> Implement system.multicall; see http://www.xmlrpc.com/discuss/msgReader$1208 for the specification.

(xml-rpc-call 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*)) function

> Execute an already encoded XML-RPC call and return the decoded result

xml-rpc-condition condition

> Parent condition for all conditions thrown by the XML-RPC package

> Class precedence list: `xml-rpc-condition error serious-condition condition standard-object t`

xml-rpc-error condition

> This condition is thrown when an XML-RPC protocol error occurs

> Class precedence list: `xml-rpc-error xml-rpc-condition error serious-condition condition standard-object t`

> Class init args: `:data :code`

(xml-rpc-error-data xml-rpc-error) generic-function

> Get the data from an XML-RPC error

(xml-rpc-error-place xml-rpc-error) generic-function

> Get the place from an XML-RPC error

xml-rpc-fault condition

> This condition is thrown when the XML-RPC server returns a fault

> Class precedence list: `xml-rpc-fault xml-rpc-condition error serious-condition condition standard-object t`

> Class init args: `:string :code`

(xml-rpc-fault-code xml-rpc-fault) generic-function

> Get the code from an XML-RPC fault

(xml-rpc-fault-string xml-rpc-fault) generic-function

> Get the string from an XML-RPC fault

xml-rpc-struct structure

> An XML-RPC-STRUCT is an associative map of member names and values

(xml-rpc-struct &rest args) function

> Create a new XML-RPC-STRUCT from the arguments: alternating member names and values

(xml-rpc-struct-alist object) function

> Return the alist of member names and values from an XML-RPC struct

(xml-rpc-struct-equal struct1 struct2) function

> Compare two XML-RPC-STRUCTs for equality

(xml-rpc-struct-p object) function

> Return T when the argument is an XML-RPC struct

xml-rpc-time structure

> A wrapper around a Common Lisp universal time to be interpreted as an XML-RPC-TIME

(xml-rpc-time &optional (universal-time (get-universal-time))) function

> Create a new XML-RPC-TIME struct with the universal time specified, defaulting to now

(xml-rpc-time-p object) function

> Return T when the argument is an XML-RPC time

(xml-rpc-time-universal-time object) function

> Return the universal time from an XML-RPC time

Documentation generated by lispdoc running on LispWorks