The s-xml-rpc Reference Manual

4.1.1 s-xml-rpc/s-xml-rpc.asd

Source

s-xml-rpc.asd.

Parent Component

s-xml-rpc (system).

ASDF Systems

s-xml-rpc.

---

4.1.2 s-xml-rpc/src/base64.lisp

Source

s-xml-rpc.asd.

Parent Component

src (module).

Packages

s-base64.

Public Interface

• decode-base64 (function).
• decode-base64-bytes (function).
• encode-base64 (function).
• encode-base64-bytes (function).

Internals

• +base64-alphabet+ (special variable).
• +inverse-base64-alphabet+ (special variable).
• core-decode-base64 (function).
• core-encode-base64 (function).
• skip-base64-whitespace (function).

---

4.1.3 s-xml-rpc/src/package.lisp

Dependency

base64.lisp (file).

Source

s-xml-rpc.asd.

Parent Component

src (module).

Packages

• s-xml-rpc-exports.
• s-xml-rpc.

---

4.1.4 s-xml-rpc/src/sysdeps.lisp

Dependency

package.lisp (file).

Source

s-xml-rpc.asd.

Parent Component

src (module).

Public Interface

stop-server (function).

Internals

• *server-processes* (special variable).
• run-process (function).
• start-standard-server (function).
• with-open-socket-stream (macro).

---

4.1.5 s-xml-rpc/src/xml-rpc.lisp

Dependencies

• package.lisp (file).
• sysdeps.lisp (file).
• base64.lisp (file).

Source

s-xml-rpc.asd.

Parent Component

src (module).

Public Interface

• *xml-rpc-agent* (special variable).
• *xml-rpc-authorization* (special variable).
• *xml-rpc-call-hook* (special variable).
• *xml-rpc-debug* (special variable).
• *xml-rpc-debug-stream* (special variable).
• *xml-rpc-host* (special variable).
• *xml-rpc-package* (special variable).
• *xml-rpc-port* (special variable).
• *xml-rpc-proxy-host* (special variable).
• *xml-rpc-proxy-port* (special variable).
• *xml-rpc-url* (special variable).
• call-xml-rpc-server (function).
• encode-xml-rpc-call (function).
• execute-xml-rpc-call (function).
• get-xml-rpc-struct-member (function).
• (setf get-xml-rpc-struct-member) (function).
• print-object (method).
• print-object (method).
• print-object (method).
• start-xml-rpc-server (function).
• xml-rpc-call (function).
• xml-rpc-condition (condition).
• xml-rpc-error (condition).
• xml-rpc-error-data (reader method).
• xml-rpc-error-place (reader method).
• xml-rpc-fault (condition).
• xml-rpc-fault-code (reader method).
• xml-rpc-fault-string (reader method).
• xml-rpc-struct (function).
• xml-rpc-struct (structure).
• xml-rpc-struct-alist (reader).
• (setf xml-rpc-struct-alist) (writer).
• xml-rpc-struct-equal (function).
• xml-rpc-struct-p (function).
• xml-rpc-time (function).
• xml-rpc-time (structure).
• xml-rpc-time-p (function).
• xml-rpc-time-universal-time (reader).
• (setf xml-rpc-time-universal-time) (writer).

Internals

• *counter* (special variable).
• +crlf+ (special variable).
• +xml-rpc-method-characters+ (special variable).
• copy-xml-literal (function).
• copy-xml-rpc-struct (function).
• copy-xml-rpc-time (function).
• debug-stream (function).
• decode-xml-rpc (function).
• decode-xml-rpc-finish-element (function).
• decode-xml-rpc-new-element (function).
• decode-xml-rpc-text (function).
• describe-server (function).
• encode-xml-rpc-args (function).
• encode-xml-rpc-array (function).
• encode-xml-rpc-fault (function).
• encode-xml-rpc-fault-value (function).
• encode-xml-rpc-result (function).
• encode-xml-rpc-struct (function).
• encode-xml-rpc-value (function).
• find-xml-rpc-method (function).
• format-debug (function).
• format-header (function).
• handle-xml-rpc-call (function).
• iso8601->universal-time (function).
• make-xml-literal (function).
• make-xml-rpc-struct (function).
• make-xml-rpc-time (function).
• print-xml-literal (function).
• print-xml-rpc-struct (function).
• print-xml-rpc-time (function).
• tokens (function).
• universal-time->iso8601 (function).
• valid-xml-rpc-method-name-p (function).
• xml-literal (function).
• xml-literal (structure).
• xml-literal-content (reader).
• (setf xml-literal-content) (writer).
• xml-literal-p (function).
• xml-rpc-implementation-version (function).
• xml-rpc-server-connection-handler (function).
• xml-rpc-server-default-error-handler (function).

---

4.1.6 s-xml-rpc/src/extensions.lisp

Dependencies

• package.lisp (file).
• xml-rpc.lisp (file).

Source

s-xml-rpc.asd.

Parent Component

src (module).

Public Interface

• system.getcapabilities (function).
• system.listmethods (function).
• system.methodhelp (function).
• system.methodsignature (function).
• system.multicall (function).

Internals

do-one-multicall (function).

---

6.1.1 Special variables

Special Variable: *xml-rpc-agent* ¶

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

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Special Variable: *xml-rpc-authorization* ¶

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

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Special Variable: *xml-rpc-call-hook* ¶

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

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Special Variable: *xml-rpc-debug* ¶

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

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Special Variable: *xml-rpc-debug-stream* ¶

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

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Special Variable: *xml-rpc-host* ¶

String naming the default XML-RPC host to use

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Special Variable: *xml-rpc-package* ¶

Package for XML-RPC callable functions

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Special Variable: *xml-rpc-port* ¶

Integer specifying the default XML-RPC port to use

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Special Variable: *xml-rpc-proxy-host* ¶

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

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Special Variable: *xml-rpc-proxy-port* ¶

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

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Special Variable: *xml-rpc-url* ¶

String specifying the default XML-RPC URL to use

Package

s-xml-rpc.

Source

xml-rpc.lisp.

---

6.1.2 Ordinary functions

Function: call-xml-rpc-server (server-keywords name &rest args) ¶

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

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Function: decode-base64 (in out) ¶

Decode a base64 encoded character input stream into a binary output stream

Package

s-base64.

Source

base64.lisp.

Function: decode-base64-bytes (stream) ¶

Decode a base64 encoded character stream, returns a byte array

Package

s-base64.

Source

base64.lisp.

Function: encode-base64 (in out &optional break-lines) ¶

Encode a binary input stream into a base64 encoded character output stream

Package

s-base64.

Source

base64.lisp.

Function: encode-base64-bytes (array stream &optional break-lines) ¶

Encode a byte array into a base64b encoded character stream

Package

s-base64.

Source

base64.lisp.

Function: encode-xml-rpc-call (name &rest args) ¶

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

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Function: execute-xml-rpc-call (method-name &rest arguments) ¶

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

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Function: get-xml-rpc-struct-member (struct member) ¶

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

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Function: (setf get-xml-rpc-struct-member) (struct member) ¶

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

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Function: start-xml-rpc-server (&key port url agent error-handler) ¶

Start an XML-RPC server in a separate process.
When provided, ERROR-HANDLER must be a function of one argument, the condition that was raised during execution of the XML-RPC method on the server side.

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Function: stop-server (name) ¶

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

Package

s-xml-rpc.

Source

sysdeps.lisp.

Function: system.getcapabilities () ¶

Get a list of supported capabilities; see http://groups.yahoo.com/group/xml-rpc/message/2897 for the specification.

Package

s-xml-rpc.

Source

extensions.lisp.

Function: system.listmethods () ¶

List the methods that are available on this server.

Package

s-xml-rpc.

Source

extensions.lisp.

Function: system.methodhelp (method-name) ¶

Returns the function documentation for the given method.

Package

s-xml-rpc.

Source

extensions.lisp.

Function: system.methodsignature (method-name) ¶

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.

Package

s-xml-rpc.

Source

extensions.lisp.

Function: system.multicall (calls) ¶

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

Package

s-xml-rpc.

Source

extensions.lisp.

Function: xml-rpc-call (encoded &key url agent host port authorization proxy-host proxy-port) ¶

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

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Function: xml-rpc-struct (&rest args) ¶

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

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Reader: xml-rpc-struct-alist (instance) ¶

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

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Target Slot

alist.

Writer: (setf xml-rpc-struct-alist) (instance) ¶

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Target Slot

alist.

Function: xml-rpc-struct-equal (struct1 struct2) ¶

Compare two XML-RPC-STRUCTs for equality

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Function: xml-rpc-struct-p (object) ¶

Return T when the argument is an XML-RPC struct

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Function: xml-rpc-time (&optional universal-time) ¶

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

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Function: xml-rpc-time-p (object) ¶

Return T when the argument is an XML-RPC time

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Reader: xml-rpc-time-universal-time (instance) ¶

Return the universal time from an XML-RPC time

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Target Slot

universal-time.

Writer: (setf xml-rpc-time-universal-time) (instance) ¶

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Target Slot

universal-time.

---

6.1.3 Generic functions

Generic Reader: xml-rpc-error-data (condition) ¶

Get the data from an XML-RPC error

Package

s-xml-rpc.

Methods

Reader Method: xml-rpc-error-data ((condition xml-rpc-error)) ¶

Source

xml-rpc.lisp.

Target Slot

data.

Generic Reader: xml-rpc-error-place (condition) ¶

Get the place from an XML-RPC error

Package

s-xml-rpc.

Methods

Reader Method: xml-rpc-error-place ((condition xml-rpc-error)) ¶

Source

xml-rpc.lisp.

Target Slot

place.

Generic Reader: xml-rpc-fault-code (condition) ¶

Get the code from an XML-RPC fault

Package

s-xml-rpc.

Methods

Reader Method: xml-rpc-fault-code ((condition xml-rpc-fault)) ¶

Source

xml-rpc.lisp.

Target Slot

code.

Generic Reader: xml-rpc-fault-string (condition) ¶

Get the string from an XML-RPC fault

Package

s-xml-rpc.

Methods

Reader Method: xml-rpc-fault-string ((condition xml-rpc-fault)) ¶

Source

xml-rpc.lisp.

Target Slot

string.

---

6.1.4 Standalone methods

Method: print-object ((object xml-rpc-struct) stream) ¶

Source

xml-rpc.lisp.

Method: print-object ((object xml-rpc-time) stream) ¶

Source

xml-rpc.lisp.

Method: print-object ((object xml-literal) stream) ¶

Source

xml-rpc.lisp.

---

6.1.5 Conditions

Condition: xml-rpc-condition ¶

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

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Direct superclasses

error.

Direct subclasses

• xml-rpc-error.
• xml-rpc-fault.

Condition: xml-rpc-error ¶

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

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Direct superclasses

xml-rpc-condition.

Direct methods

• xml-rpc-error-data.
• xml-rpc-error-place.

Direct slots

Slot: place ¶

Initargs

:code

Readers

xml-rpc-error-place.

Writers

This slot is read-only.

Slot: data ¶

Initargs

:data

Readers

xml-rpc-error-data.

Writers

This slot is read-only.

Condition: xml-rpc-fault ¶

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

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Direct superclasses

xml-rpc-condition.

Direct methods

• xml-rpc-fault-code.
• xml-rpc-fault-string.

Direct slots

Slot: code ¶

Initargs

:code

Readers

xml-rpc-fault-code.

Writers

This slot is read-only.

Slot: string ¶

Package

common-lisp.

Initargs

:string

Readers

xml-rpc-fault-string.

Writers

This slot is read-only.

---

6.1.6 Structures

Structure: xml-rpc-struct ¶

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

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Direct superclasses

structure-object.

Direct methods

print-object.

Direct slots

Slot: alist ¶

Readers

xml-rpc-struct-alist.

Writers

(setf xml-rpc-struct-alist).

Structure: xml-rpc-time ¶

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

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Direct superclasses

structure-object.

Direct methods

print-object.

Direct slots

Slot: universal-time ¶

Readers

xml-rpc-time-universal-time.

Writers

(setf xml-rpc-time-universal-time).

---

6.2.1 Special variables

Special Variable: *counter* ¶

Unique ID for incoming connections

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Special Variable: *server-processes* ¶

Package

s-xml-rpc.

Source

sysdeps.lisp.

Special Variable: +base64-alphabet+ ¶

Package

s-base64.

Source

base64.lisp.

Special Variable: +crlf+ ¶

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Special Variable: +inverse-base64-alphabet+ ¶

Package

s-base64.

Source

base64.lisp.

Special Variable: +xml-rpc-method-characters+ ¶

Package

s-xml-rpc.

Source

xml-rpc.lisp.

---

6.2.2 Macros

Macro: with-open-socket-stream ((var host port) &body body) ¶

Execute body with a bidirectional socket stream opened to host:port

Package

s-xml-rpc.

Source

sysdeps.lisp.

---

6.2.3 Ordinary functions

Function: copy-xml-literal (instance) ¶

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Function: copy-xml-rpc-struct (instance) ¶

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Function: copy-xml-rpc-time (instance) ¶

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Function: core-decode-base64 (char1 char2 char3 char4) ¶

Package

s-base64.

Source

base64.lisp.

Function: core-encode-base64 (byte1 byte2 byte3) ¶

Package

s-base64.

Source

base64.lisp.

Function: debug-stream (in) ¶

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Function: decode-xml-rpc (stream) ¶

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Function: decode-xml-rpc-finish-element (name attributes parent-seed seed) ¶

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Function: decode-xml-rpc-new-element (name attributes seed) ¶

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Function: decode-xml-rpc-text (string seed) ¶

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Function: describe-server (&key host port url) ¶

Tries to describe a remote server using system.* methods

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Function: do-one-multicall (call-struct) ¶

Package

s-xml-rpc.

Source

extensions.lisp.

Function: encode-xml-rpc-args (args stream) ¶

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Function: encode-xml-rpc-array (sequence stream) ¶

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Function: encode-xml-rpc-fault (fault-string &optional fault-code) ¶

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Function: encode-xml-rpc-fault-value (fault-string &optional fault-code) ¶

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Function: encode-xml-rpc-result (value) ¶

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Function: encode-xml-rpc-struct (struct stream) ¶

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Function: encode-xml-rpc-value (arg stream) ¶

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Function: find-xml-rpc-method (method-name) ¶

Looks for a method with the given name in *xml-rpc-package*, except that colons in the name get converted to hyphens.

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Function: format-debug (&rest args) ¶

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Function: format-header (stream headers) ¶

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Function: handle-xml-rpc-call (in id) ¶

Handle an actual call, reading XML from in and returning the XML-encoded result.

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Function: iso8601->universal-time (string) ¶

Convert string in the XML-RPC variant of ISO8601 to a Common Lisp universal time

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Function: make-xml-literal (&key content) ¶

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Function: make-xml-rpc-struct (&key alist) ¶

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Function: make-xml-rpc-time (&key universal-time) ¶

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Function: print-xml-literal (xml-literal stream depth) ¶

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Function: print-xml-rpc-struct (xml-element stream depth) ¶

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Function: print-xml-rpc-time (xml-rpc-time stream depth) ¶

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Function: run-process (name function &rest arguments) ¶

Create and run a new process with name, executing function on arguments

Package

s-xml-rpc.

Source

sysdeps.lisp.

Function: skip-base64-whitespace (stream) ¶

Package

s-base64.

Source

base64.lisp.

Function: start-standard-server (&key port name connection-handler) ¶

Start a server process with name, listening on port, delegating to connection-handler with stream as argument

Package

s-xml-rpc.

Source

sysdeps.lisp.

Function: tokens (string &key start separators) ¶

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Function: universal-time->iso8601 (time &optional stream) ¶

Convert a Common Lisp universal time to a string in the XML-RPC variant of ISO8601

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Function: valid-xml-rpc-method-name-p (method-name) ¶

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Function: xml-literal (content) ¶

Create a new XML-LITERAL struct with the specified content.

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Reader: xml-literal-content (instance) ¶

Return the content of a literal xml string

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Target Slot

content.

Writer: (setf xml-literal-content) (instance) ¶

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Target Slot

content.

Function: xml-literal-p (object) ¶

Return T when the argument is an unescaped xml string

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Function: xml-rpc-implementation-version () ¶

Identify ourselves

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Function: xml-rpc-server-connection-handler (connection id agent url &optional error-handler) ¶

Handle an incoming connection, doing both all HTTP and XML-RPC stuff

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Function: xml-rpc-server-default-error-handler (c) ¶

Package

s-xml-rpc.

Source

xml-rpc.lisp.

---

6.2.4 Structures

Structure: xml-literal ¶

A wrapper around a Common Lisp string that will be sent over the wire unescaped

Package

s-xml-rpc.

Source

xml-rpc.lisp.

Direct superclasses

structure-object.

Direct methods

print-object.

Direct slots

Slot: content ¶

Readers

xml-literal-content.

Writers

(setf xml-literal-content).

---