The s-xml-rpc Reference Manual

1 Systems
- 1.1 s-xml-rpc
2 Modules
- 2.1 s-xml-rpc/src
3 Files
- 3.1 Lisp
4 Packages
5 Definitions
- 5.1 Exported definitions
- 5.2 Internal definitions
Appendix A Indexes

The s-xml-rpc Reference Manual

This is the s-xml-rpc Reference Manual, version 7, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 12:32:32 2018 GMT+0.

1 Systems

The main system appears first, followed by any subsystem dependency.

1.1 `s-xml-rpc`

Maintainer

Sven Van Caekenberghe <svc@mac.com>

Author

Sven Van Caekenberghe <svc@mac.com>

License

Lesser Lisp General Public License (LLGPL)

Description

Common Lisp XML-RPC Package

Long Description

s-xml-rpc is a Common Lisp implementation of the XML-RPC procotol for both client and server

Version

Dependencies

s-xml
sb-bsd-sockets

Source

s-xml-rpc.asd (file)

Component

src (module)

2 Modules

Modules are listed depth-first from the system components tree.

2.1 `s-xml-rpc/src`

Parent

s-xml-rpc (system)

Location

src/

Components

base64.lisp (file)
package.lisp (file)
sysdeps.lisp (file)
xml-rpc.lisp (file)
extensions.lisp (file)

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

3.1 Lisp

3.1.1 `s-xml-rpc.asd`

Location: s-xml-rpc.asd
Systems: s-xml-rpc (system)

3.1.2 `s-xml-rpc/src/base64.lisp`

Parent

src (module)

Location

src/base64.lisp

Packages

s-base64

Exported Definitions

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

Internal Definitions

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

3.1.3 `s-xml-rpc/src/package.lisp`

Dependency

base64.lisp (file)

Parent

src (module)

Location

src/package.lisp

Packages

s-xml-rpc-exports
s-xml-rpc

3.1.4 `s-xml-rpc/src/sysdeps.lisp`

Dependency

package.lisp (file)

Parent

src (module)

Location

src/sysdeps.lisp

Exported Definitions

stop-server (function)

Internal Definitions

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

3.1.5 `s-xml-rpc/src/xml-rpc.lisp`

Dependencies

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

Parent

src (module)

Location

src/xml-rpc.lisp

Exported Definitions

*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)
start-xml-rpc-server (function)
xml-rpc-call (function)
xml-rpc-condition (condition)
xml-rpc-error (condition)
xml-rpc-error-data (method)
xml-rpc-error-place (method)
xml-rpc-fault (condition)
xml-rpc-fault-code (method)
xml-rpc-fault-string (method)
xml-rpc-struct (function)
xml-rpc-struct (structure)
xml-rpc-struct-alist (function)
(setf xml-rpc-struct-alist) (function)
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 (function)
(setf xml-rpc-time-universal-time) (function)

Internal Definitions

*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 (function)
(setf xml-literal-content) (function)
xml-literal-p (function)
xml-rpc-implementation-version (function)
xml-rpc-server-connection-handler (function)

3.1.6 `s-xml-rpc/src/extensions.lisp`

Dependencies

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

Parent

src (module)

Location

src/extensions.lisp

Exported Definitions

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

Internal Definitions

do-one-multicall (function)

4 Packages

Packages are listed by definition order.

4.1 `s-base64`

An implementation of standard Base64 encoding and decoding

Source

base64.lisp (file)

Use List

common-lisp

Used By List

s-xml-rpc

Exported Definitions

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

Internal Definitions

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

4.2 `s-xml-rpc-exports`

This package contains the functions callable via xml-rpc.

Source: package.lisp (file)

4.3 `s-xml-rpc`

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

Source

package.lisp (file)

Use List

s-base64
s-xml
common-lisp

Exported Definitions

*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)
start-xml-rpc-server (function)
stop-server (function)
system.getcapabilities (function)
system.listmethods (function)
system.methodhelp (function)
system.methodsignature (function)
system.multicall (function)
xml-rpc-call (function)
xml-rpc-condition (condition)
xml-rpc-error (condition)
xml-rpc-error-data (generic function)
xml-rpc-error-data (method)
xml-rpc-error-place (generic function)
xml-rpc-error-place (method)
xml-rpc-fault (condition)
xml-rpc-fault-code (generic function)
xml-rpc-fault-code (method)
xml-rpc-fault-string (generic function)
xml-rpc-fault-string (method)
xml-rpc-struct (function)
xml-rpc-struct (structure)
xml-rpc-struct-alist (function)
(setf xml-rpc-struct-alist) (function)
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 (function)
(setf xml-rpc-time-universal-time) (function)

Internal Definitions

*counter* (special variable)
*server-processes* (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)
do-one-multicall (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)
run-process (function)
start-standard-server (function)
tokens (function)
universal-time->iso8601 (function)
valid-xml-rpc-method-name-p (function)
with-open-socket-stream (macro)
xml-literal (function)
xml-literal (structure)
xml-literal-content (function)
(setf xml-literal-content) (function)
xml-literal-p (function)
xml-rpc-implementation-version (function)
xml-rpc-server-connection-handler (function)

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

5.1 Exported definitions

5.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 (file)

Special Variable: *xml-rpc-authorization*

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

Package: s-xml-rpc
Source: xml-rpc.lisp (file)

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 (file)

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 (file)

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 (file)

Special Variable: *xml-rpc-host*

String naming the default XML-RPC host to use

Package: s-xml-rpc
Source: xml-rpc.lisp (file)

Special Variable: *xml-rpc-package*

Package for XML-RPC callable functions

Package: s-xml-rpc
Source: xml-rpc.lisp (file)

Special Variable: *xml-rpc-port*

Integer specifying the default XML-RPC port to use

Package: s-xml-rpc
Source: xml-rpc.lisp (file)

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 (file)

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 (file)

Special Variable: *xml-rpc-url*

String specifying the default XML-RPC URL to use

Package: s-xml-rpc
Source: xml-rpc.lisp (file)

5.1.2 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 (file)

Function: decode-base64 IN OUT

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

Package: s-base64
Source: base64.lisp (file)

Function: decode-base64-bytes STREAM

Decode a base64 encoded character stream, returns a byte array

Package: s-base64
Source: base64.lisp (file)

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 (file)

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 (file)

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 (file)

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 (file)

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 (file)
Writer: (setf get-xml-rpc-struct-member) (function)

Function: (setf get-xml-rpc-struct-member) VALUE STRUCT MEMBER

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

Package: s-xml-rpc
Source: xml-rpc.lisp (file)
Reader: get-xml-rpc-struct-member (function)

Function: start-xml-rpc-server &key PORT URL AGENT

Start an XML-RPC server in a separate process

Package: s-xml-rpc
Source: xml-rpc.lisp (file)

Function: stop-server NAME

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

Package: s-xml-rpc
Source: sysdeps.lisp (file)

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 (file)

Function: system.listmethods ()

List the methods that are available on this server.

Package: s-xml-rpc
Source: extensions.lisp (file)

Function: system.methodhelp METHOD-NAME

Returns the function documentation for the given method.

Package: s-xml-rpc
Source: extensions.lisp (file)

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 (file)

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 (file)

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 (file)

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 (file)

Function: 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 (file)
Writer: (setf xml-rpc-struct-alist) (function)

Function: (setf xml-rpc-struct-alist) VALUE INSTANCE

Package: s-xml-rpc
Source: xml-rpc.lisp (file)
Reader: xml-rpc-struct-alist (function)

Function: xml-rpc-struct-equal STRUCT1 STRUCT2

Compare two XML-RPC-STRUCTs for equality

Package: s-xml-rpc
Source: xml-rpc.lisp (file)

Function: xml-rpc-struct-p OBJECT

Return T when the argument is an XML-RPC struct

Package: s-xml-rpc
Source: xml-rpc.lisp (file)

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 (file)

Function: xml-rpc-time-p OBJECT

Return T when the argument is an XML-RPC time

Package: s-xml-rpc
Source: xml-rpc.lisp (file)

Function: xml-rpc-time-universal-time INSTANCE

Return the universal time from an XML-RPC time

Package: s-xml-rpc
Source: xml-rpc.lisp (file)
Writer: (setf xml-rpc-time-universal-time) (function)

Function: (setf xml-rpc-time-universal-time) VALUE INSTANCE

Package: s-xml-rpc
Source: xml-rpc.lisp (file)
Reader: xml-rpc-time-universal-time (function)

5.1.3 Generic functions

Generic Function: xml-rpc-error-data CONDITION

Get the data from an XML-RPC error

Package

s-xml-rpc

Methods

Method: xml-rpc-error-data (CONDITION xml-rpc-error)

Source: xml-rpc.lisp (file)

Generic Function: xml-rpc-error-place CONDITION

Get the place from an XML-RPC error

Package

s-xml-rpc

Methods

Method: xml-rpc-error-place (CONDITION xml-rpc-error)

Source: xml-rpc.lisp (file)

Generic Function: xml-rpc-fault-code CONDITION

Get the code from an XML-RPC fault

Package

s-xml-rpc

Methods

Method: xml-rpc-fault-code (CONDITION xml-rpc-fault)

Source: xml-rpc.lisp (file)

Generic Function: xml-rpc-fault-string CONDITION

Get the string from an XML-RPC fault

Package

s-xml-rpc

Methods

Method: xml-rpc-fault-string (CONDITION xml-rpc-fault)

Source: xml-rpc.lisp (file)

5.1.4 Conditions

Condition: xml-rpc-condition ()

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

Package

s-xml-rpc

Source

xml-rpc.lisp (file)

Direct superclasses

error (condition)

Direct subclasses

xml-rpc-fault (condition)
xml-rpc-error (condition)

Condition: xml-rpc-error ()

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

Package

s-xml-rpc

Source

xml-rpc.lisp (file)

Direct superclasses

xml-rpc-condition (condition)

Direct methods

xml-rpc-error-data (method)
xml-rpc-error-place (method)

Direct slots

Slot: place

Initargs: :code
Readers: xml-rpc-error-place (generic function)

Slot: data

Initargs: :data
Readers: xml-rpc-error-data (generic function)

Condition: xml-rpc-fault ()

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

Package

s-xml-rpc

Source

xml-rpc.lisp (file)

Direct superclasses

xml-rpc-condition (condition)

Direct methods

xml-rpc-fault-string (method)
xml-rpc-fault-code (method)

Direct slots

Slot: code

Initargs: :code
Readers: xml-rpc-fault-code (generic function)

Slot: string

Initargs: :string
Readers: xml-rpc-fault-string (generic function)

5.1.5 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 (file)

Direct superclasses

structure-object (structure)

Direct methods

print-object (method)

Direct slots

Slot: alist

Readers: xml-rpc-struct-alist (function)
Writers: (setf xml-rpc-struct-alist) (function)

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 (file)

Direct superclasses

structure-object (structure)

Direct methods

print-object (method)

Direct slots

Slot: universal-time

Readers: xml-rpc-time-universal-time (function)
Writers: (setf xml-rpc-time-universal-time) (function)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *counter*

Unique ID for incoming connections

Package: s-xml-rpc
Source: xml-rpc.lisp (file)

Special Variable: *server-processes*

Package: s-xml-rpc
Source: sysdeps.lisp (file)

Special Variable: +base64-alphabet+

Package: s-base64
Source: base64.lisp (file)

Special Variable: +crlf+

Package: s-xml-rpc
Source: xml-rpc.lisp (file)

Special Variable: +inverse-base64-alphabet+

Package: s-base64
Source: base64.lisp (file)

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

Package: s-xml-rpc
Source: xml-rpc.lisp (file)

5.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 (file)

5.2.3 Functions

Function: copy-xml-literal INSTANCE

Package: s-xml-rpc
Source: xml-rpc.lisp (file)

Function: copy-xml-rpc-struct INSTANCE

Package: s-xml-rpc
Source: xml-rpc.lisp (file)

Function: copy-xml-rpc-time INSTANCE

Package: s-xml-rpc
Source: xml-rpc.lisp (file)

Function: core-decode-base64 CHAR1 CHAR2 CHAR3 CHAR4

Package: s-base64
Source: base64.lisp (file)

Function: core-encode-base64 BYTE1 BYTE2 BYTE3

Package: s-base64
Source: base64.lisp (file)

Function: debug-stream IN

Package: s-xml-rpc
Source: xml-rpc.lisp (file)

Function: decode-xml-rpc STREAM

Package: s-xml-rpc
Source: xml-rpc.lisp (file)

Function: decode-xml-rpc-finish-element NAME ATTRIBUTES PARENT-SEED SEED

Package: s-xml-rpc
Source: xml-rpc.lisp (file)

Function: decode-xml-rpc-new-element NAME ATTRIBUTES SEED

Package: s-xml-rpc
Source: xml-rpc.lisp (file)

Function: decode-xml-rpc-text STRING SEED

Package: s-xml-rpc
Source: xml-rpc.lisp (file)

Function: describe-server &key HOST PORT URL

Tries to describe a remote server using system.* methods

Package: s-xml-rpc
Source: xml-rpc.lisp (file)

Function: do-one-multicall CALL-STRUCT

Package: s-xml-rpc
Source: extensions.lisp (file)

Function: encode-xml-rpc-args ARGS STREAM

Package: s-xml-rpc
Source: xml-rpc.lisp (file)

Function: encode-xml-rpc-array SEQUENCE STREAM

Package: s-xml-rpc
Source: xml-rpc.lisp (file)

Function: encode-xml-rpc-fault FAULT-STRING &optional FAULT-CODE

Package: s-xml-rpc
Source: xml-rpc.lisp (file)

Function: encode-xml-rpc-fault-value FAULT-STRING &optional FAULT-CODE

Package: s-xml-rpc
Source: xml-rpc.lisp (file)

Function: encode-xml-rpc-result VALUE

Package: s-xml-rpc
Source: xml-rpc.lisp (file)

Function: encode-xml-rpc-struct STRUCT STREAM

Package: s-xml-rpc
Source: xml-rpc.lisp (file)

Function: encode-xml-rpc-value ARG STREAM

Package: s-xml-rpc
Source: xml-rpc.lisp (file)

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 (file)

Function: format-debug &rest ARGS

Package: s-xml-rpc
Source: xml-rpc.lisp (file)

Function: format-header STREAM HEADERS

Package: s-xml-rpc
Source: xml-rpc.lisp (file)

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 (file)

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 (file)

Function: make-xml-literal &key (CONTENT CONTENT)

Package: s-xml-rpc
Source: xml-rpc.lisp (file)

Function: make-xml-rpc-struct &key (ALIST ALIST)

Package: s-xml-rpc
Source: xml-rpc.lisp (file)

Function: make-xml-rpc-time &key (UNIVERSAL-TIME UNIVERSAL-TIME)

Package: s-xml-rpc
Source: xml-rpc.lisp (file)

Function: print-xml-literal XML-LITERAL STREAM DEPTH

Package: s-xml-rpc
Source: xml-rpc.lisp (file)

Function: print-xml-rpc-struct XML-ELEMENT STREAM DEPTH

Package: s-xml-rpc
Source: xml-rpc.lisp (file)

Function: print-xml-rpc-time XML-RPC-TIME STREAM DEPTH

Package: s-xml-rpc
Source: xml-rpc.lisp (file)

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 (file)

Function: skip-base64-whitespace STREAM

Package: s-base64
Source: base64.lisp (file)

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 (file)

Function: tokens STRING &key START SEPARATORS

Package: s-xml-rpc
Source: xml-rpc.lisp (file)

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 (file)

Function: valid-xml-rpc-method-name-p METHOD-NAME

Package: s-xml-rpc
Source: xml-rpc.lisp (file)

Function: xml-literal CONTENT

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

Package: s-xml-rpc
Source: xml-rpc.lisp (file)

Function: xml-literal-content INSTANCE

Return the content of a literal xml string

Package: s-xml-rpc
Source: xml-rpc.lisp (file)
Writer: (setf xml-literal-content) (function)

Function: (setf xml-literal-content) VALUE INSTANCE

Package: s-xml-rpc
Source: xml-rpc.lisp (file)
Reader: xml-literal-content (function)

Function: xml-literal-p OBJECT

Return T when the argument is an unescaped xml string

Package: s-xml-rpc
Source: xml-rpc.lisp (file)

Function: xml-rpc-implementation-version ()

Identify ourselves

Package: s-xml-rpc
Source: xml-rpc.lisp (file)

Function: xml-rpc-server-connection-handler CONNECTION ID AGENT URL

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

Package: s-xml-rpc
Source: xml-rpc.lisp (file)

5.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 (file)

Direct superclasses

structure-object (structure)

Direct methods

print-object (method)

Direct slots

Slot: content

Readers: xml-literal-content (function)
Writers: (setf xml-literal-content) (function)

Appendix A Indexes

A.1 Concepts

Jump to:	F L M S

	Index Entry	Section

F
	File, Lisp, `s-xml-rpc.asd`:	The s-xml-rpc<dot>asd file
	File, Lisp, `s-xml-rpc/src/base64.lisp`:	The s-xml-rpc/src/base64<dot>lisp file
	File, Lisp, `s-xml-rpc/src/extensions.lisp`:	The s-xml-rpc/src/extensions<dot>lisp file
	File, Lisp, `s-xml-rpc/src/package.lisp`:	The s-xml-rpc/src/package<dot>lisp file
	File, Lisp, `s-xml-rpc/src/sysdeps.lisp`:	The s-xml-rpc/src/sysdeps<dot>lisp file
	File, Lisp, `s-xml-rpc/src/xml-rpc.lisp`:	The s-xml-rpc/src/xml-rpc<dot>lisp file

L
	Lisp File, `s-xml-rpc.asd`:	The s-xml-rpc<dot>asd file
	Lisp File, `s-xml-rpc/src/base64.lisp`:	The s-xml-rpc/src/base64<dot>lisp file
	Lisp File, `s-xml-rpc/src/extensions.lisp`:	The s-xml-rpc/src/extensions<dot>lisp file
	Lisp File, `s-xml-rpc/src/package.lisp`:	The s-xml-rpc/src/package<dot>lisp file
	Lisp File, `s-xml-rpc/src/sysdeps.lisp`:	The s-xml-rpc/src/sysdeps<dot>lisp file
	Lisp File, `s-xml-rpc/src/xml-rpc.lisp`:	The s-xml-rpc/src/xml-rpc<dot>lisp file

M
	Module, `s-xml-rpc/src`:	The s-xml-rpc/src module

S
	`s-xml-rpc.asd`:	The s-xml-rpc<dot>asd file
	`s-xml-rpc/src`:	The s-xml-rpc/src module
	`s-xml-rpc/src/base64.lisp`:	The s-xml-rpc/src/base64<dot>lisp file
	`s-xml-rpc/src/extensions.lisp`:	The s-xml-rpc/src/extensions<dot>lisp file
	`s-xml-rpc/src/package.lisp`:	The s-xml-rpc/src/package<dot>lisp file
	`s-xml-rpc/src/sysdeps.lisp`:	The s-xml-rpc/src/sysdeps<dot>lisp file
	`s-xml-rpc/src/xml-rpc.lisp`:	The s-xml-rpc/src/xml-rpc<dot>lisp file

Jump to:	F L M S

A.2 Functions

Jump to:	( C D E F G H I M P R S T U V W X

	Index Entry	Section

(
	`(setf get-xml-rpc-struct-member)`:	Exported functions
	`(setf xml-literal-content)`:	Internal functions
	`(setf xml-rpc-struct-alist)`:	Exported functions
	`(setf xml-rpc-time-universal-time)`:	Exported functions

C
	`call-xml-rpc-server`:	Exported functions
	`copy-xml-literal`:	Internal functions
	`copy-xml-rpc-struct`:	Internal functions
	`copy-xml-rpc-time`:	Internal functions
	`core-decode-base64`:	Internal functions
	`core-encode-base64`:	Internal functions

D
	`debug-stream`:	Internal functions
	`decode-base64`:	Exported functions
	`decode-base64-bytes`:	Exported functions
	`decode-xml-rpc`:	Internal functions
	`decode-xml-rpc-finish-element`:	Internal functions
	`decode-xml-rpc-new-element`:	Internal functions
	`decode-xml-rpc-text`:	Internal functions
	`describe-server`:	Internal functions
	`do-one-multicall`:	Internal functions

E
	`encode-base64`:	Exported functions
	`encode-base64-bytes`:	Exported functions
	`encode-xml-rpc-args`:	Internal functions
	`encode-xml-rpc-array`:	Internal functions
	`encode-xml-rpc-call`:	Exported functions
	`encode-xml-rpc-fault`:	Internal functions
	`encode-xml-rpc-fault-value`:	Internal functions
	`encode-xml-rpc-result`:	Internal functions
	`encode-xml-rpc-struct`:	Internal functions
	`encode-xml-rpc-value`:	Internal functions
	`execute-xml-rpc-call`:	Exported functions

F
	`find-xml-rpc-method`:	Internal functions
	`format-debug`:	Internal functions
	`format-header`:	Internal functions
	`Function, (setf get-xml-rpc-struct-member)`:	Exported functions
	`Function, (setf xml-literal-content)`:	Internal functions
	`Function, (setf xml-rpc-struct-alist)`:	Exported functions
	`Function, (setf xml-rpc-time-universal-time)`:	Exported functions
	`Function, call-xml-rpc-server`:	Exported functions
	`Function, copy-xml-literal`:	Internal functions
	`Function, copy-xml-rpc-struct`:	Internal functions
	`Function, copy-xml-rpc-time`:	Internal functions
	`Function, core-decode-base64`:	Internal functions
	`Function, core-encode-base64`:	Internal functions
	`Function, debug-stream`:	Internal functions
	`Function, decode-base64`:	Exported functions
	`Function, decode-base64-bytes`:	Exported functions
	`Function, decode-xml-rpc`:	Internal functions
	`Function, decode-xml-rpc-finish-element`:	Internal functions
	`Function, decode-xml-rpc-new-element`:	Internal functions
	`Function, decode-xml-rpc-text`:	Internal functions
	`Function, describe-server`:	Internal functions
	`Function, do-one-multicall`:	Internal functions
	`Function, encode-base64`:	Exported functions
	`Function, encode-base64-bytes`:	Exported functions
	`Function, encode-xml-rpc-args`:	Internal functions
	`Function, encode-xml-rpc-array`:	Internal functions
	`Function, encode-xml-rpc-call`:	Exported functions
	`Function, encode-xml-rpc-fault`:	Internal functions
	`Function, encode-xml-rpc-fault-value`:	Internal functions
	`Function, encode-xml-rpc-result`:	Internal functions
	`Function, encode-xml-rpc-struct`:	Internal functions
	`Function, encode-xml-rpc-value`:	Internal functions
	`Function, execute-xml-rpc-call`:	Exported functions
	`Function, find-xml-rpc-method`:	Internal functions
	`Function, format-debug`:	Internal functions
	`Function, format-header`:	Internal functions
	`Function, get-xml-rpc-struct-member`:	Exported functions
	`Function, handle-xml-rpc-call`:	Internal functions
	`Function, iso8601->universal-time`:	Internal functions
	`Function, make-xml-literal`:	Internal functions
	`Function, make-xml-rpc-struct`:	Internal functions
	`Function, make-xml-rpc-time`:	Internal functions
	`Function, print-xml-literal`:	Internal functions
	`Function, print-xml-rpc-struct`:	Internal functions
	`Function, print-xml-rpc-time`:	Internal functions
	`Function, run-process`:	Internal functions
	`Function, skip-base64-whitespace`:	Internal functions
	`Function, start-standard-server`:	Internal functions
	`Function, start-xml-rpc-server`:	Exported functions
	`Function, stop-server`:	Exported functions
	`Function, system.getcapabilities`:	Exported functions
	`Function, system.listmethods`:	Exported functions
	`Function, system.methodhelp`:	Exported functions
	`Function, system.methodsignature`:	Exported functions
	`Function, system.multicall`:	Exported functions
	`Function, tokens`:	Internal functions
	`Function, universal-time->iso8601`:	Internal functions
	`Function, valid-xml-rpc-method-name-p`:	Internal functions
	`Function, xml-literal`:	Internal functions
	`Function, xml-literal-content`:	Internal functions
	`Function, xml-literal-p`:	Internal functions
	`Function, xml-rpc-call`:	Exported functions
	`Function, xml-rpc-implementation-version`:	Internal functions
	`Function, xml-rpc-server-connection-handler`:	Internal functions
	`Function, xml-rpc-struct`:	Exported functions
	`Function, xml-rpc-struct-alist`:	Exported functions
	`Function, xml-rpc-struct-equal`:	Exported functions
	`Function, xml-rpc-struct-p`:	Exported functions
	`Function, xml-rpc-time`:	Exported functions
	`Function, xml-rpc-time-p`:	Exported functions
	`Function, xml-rpc-time-universal-time`:	Exported functions

G
	`Generic Function, xml-rpc-error-data`:	Exported generic functions
	`Generic Function, xml-rpc-error-place`:	Exported generic functions
	`Generic Function, xml-rpc-fault-code`:	Exported generic functions
	`Generic Function, xml-rpc-fault-string`:	Exported generic functions
	`get-xml-rpc-struct-member`:	Exported functions

H
	`handle-xml-rpc-call`:	Internal functions

I
	`iso8601->universal-time`:	Internal functions

M
	`Macro, with-open-socket-stream`:	Internal macros
	`make-xml-literal`:	Internal functions
	`make-xml-rpc-struct`:	Internal functions
	`make-xml-rpc-time`:	Internal functions
	`Method, xml-rpc-error-data`:	Exported generic functions
	`Method, xml-rpc-error-place`:	Exported generic functions
	`Method, xml-rpc-fault-code`:	Exported generic functions
	`Method, xml-rpc-fault-string`:	Exported generic functions

P
	`print-xml-literal`:	Internal functions
	`print-xml-rpc-struct`:	Internal functions
	`print-xml-rpc-time`:	Internal functions

R
	`run-process`:	Internal functions

S
	`skip-base64-whitespace`:	Internal functions
	`start-standard-server`:	Internal functions
	`start-xml-rpc-server`:	Exported functions
	`stop-server`:	Exported functions
	`system.getcapabilities`:	Exported functions
	`system.listmethods`:	Exported functions
	`system.methodhelp`:	Exported functions
	`system.methodsignature`:	Exported functions
	`system.multicall`:	Exported functions

T
	`tokens`:	Internal functions

U
	`universal-time->iso8601`:	Internal functions

V
	`valid-xml-rpc-method-name-p`:	Internal functions

W
	`with-open-socket-stream`:	Internal macros

X
	`xml-literal`:	Internal functions
	`xml-literal-content`:	Internal functions
	`xml-literal-p`:	Internal functions
	`xml-rpc-call`:	Exported functions
	`xml-rpc-error-data`:	Exported generic functions
	`xml-rpc-error-data`:	Exported generic functions
	`xml-rpc-error-place`:	Exported generic functions
	`xml-rpc-error-place`:	Exported generic functions
	`xml-rpc-fault-code`:	Exported generic functions
	`xml-rpc-fault-code`:	Exported generic functions
	`xml-rpc-fault-string`:	Exported generic functions
	`xml-rpc-fault-string`:	Exported generic functions
	`xml-rpc-implementation-version`:	Internal functions
	`xml-rpc-server-connection-handler`:	Internal functions
	`xml-rpc-struct`:	Exported functions
	`xml-rpc-struct-alist`:	Exported functions
	`xml-rpc-struct-equal`:	Exported functions
	`xml-rpc-struct-p`:	Exported functions
	`xml-rpc-time`:	Exported functions
	`xml-rpc-time-p`:	Exported functions
	`xml-rpc-time-universal-time`:	Exported functions

Jump to:	( C D E F G H I M P R S T U V W X

A.3 Variables

Jump to:	* + A C D P S U

	Index Entry	Section

*
	`counter`:	Internal special variables
	`server-processes`:	Internal special variables
	`xml-rpc-agent`:	Exported special variables
	`xml-rpc-authorization`:	Exported special variables
	`xml-rpc-call-hook`:	Exported special variables
	`xml-rpc-debug`:	Exported special variables
	`xml-rpc-debug-stream`:	Exported special variables
	`xml-rpc-host`:	Exported special variables
	`xml-rpc-package`:	Exported special variables
	`xml-rpc-port`:	Exported special variables
	`xml-rpc-proxy-host`:	Exported special variables
	`xml-rpc-proxy-port`:	Exported special variables
	`xml-rpc-url`:	Exported special variables

+
	`+base64-alphabet+`:	Internal special variables
	`+crlf+`:	Internal special variables
	`+inverse-base64-alphabet+`:	Internal special variables
	`+xml-rpc-method-characters+`:	Internal special variables

A
	`alist`:	Exported structures

C
	`code`:	Exported conditions
	`content`:	Internal structures

D
	`data`:	Exported conditions

P
	`place`:	Exported conditions

S
	`Slot, alist`:	Exported structures
	`Slot, code`:	Exported conditions
	`Slot, content`:	Internal structures
	`Slot, data`:	Exported conditions
	`Slot, place`:	Exported conditions
	`Slot, string`:	Exported conditions
	`Slot, universal-time`:	Exported structures
	`Special Variable, counter`:	Internal special variables
	`Special Variable, server-processes`:	Internal special variables
	`Special Variable, xml-rpc-agent`:	Exported special variables
	`Special Variable, xml-rpc-authorization`:	Exported special variables
	`Special Variable, xml-rpc-call-hook`:	Exported special variables
	`Special Variable, xml-rpc-debug`:	Exported special variables
	`Special Variable, xml-rpc-debug-stream`:	Exported special variables
	`Special Variable, xml-rpc-host`:	Exported special variables
	`Special Variable, xml-rpc-package`:	Exported special variables
	`Special Variable, xml-rpc-port`:	Exported special variables
	`Special Variable, xml-rpc-proxy-host`:	Exported special variables
	`Special Variable, xml-rpc-proxy-port`:	Exported special variables
	`Special Variable, xml-rpc-url`:	Exported special variables
	`Special Variable, +base64-alphabet+`:	Internal special variables
	`Special Variable, +crlf+`:	Internal special variables
	`Special Variable, +inverse-base64-alphabet+`:	Internal special variables
	`Special Variable, +xml-rpc-method-characters+`:	Internal special variables
	`string`:	Exported conditions

U
	`universal-time`:	Exported structures

Jump to:	* + A C D P S U

A.4 Data types

Jump to:	C P S X

	Index Entry	Section

C
	`Condition, xml-rpc-condition`:	Exported conditions
	`Condition, xml-rpc-error`:	Exported conditions
	`Condition, xml-rpc-fault`:	Exported conditions

P
	`Package, s-base64`:	The s-base64 package
	`Package, s-xml-rpc`:	The s-xml-rpc package
	`Package, s-xml-rpc-exports`:	The s-xml-rpc-exports package

S
	`s-base64`:	The s-base64 package
	`s-xml-rpc`:	The s-xml-rpc system
	`s-xml-rpc`:	The s-xml-rpc package
	`s-xml-rpc-exports`:	The s-xml-rpc-exports package
	`Structure, xml-literal`:	Internal structures
	`Structure, xml-rpc-struct`:	Exported structures
	`Structure, xml-rpc-time`:	Exported structures
	`System, s-xml-rpc`:	The s-xml-rpc system

X
	`xml-literal`:	Internal structures
	`xml-rpc-condition`:	Exported conditions
	`xml-rpc-error`:	Exported conditions
	`xml-rpc-fault`:	Exported conditions
	`xml-rpc-struct`:	Exported structures
	`xml-rpc-time`:	Exported structures

Jump to:	C P S X

• Systems:		The systems documentation
• Modules:		The modules documentation
• Files:		The files documentation
• Packages:		The packages documentation
• Definitions:		The symbols documentation
• Indexes:		Concepts, functions, variables and data types

• The s-xml-rpc.asd file:
• The s-xml-rpc/src/base64.lisp file:
• The s-xml-rpc/src/package.lisp file:
• The s-xml-rpc/src/sysdeps.lisp file:
• The s-xml-rpc/src/xml-rpc.lisp file:
• The s-xml-rpc/src/extensions.lisp file:

• Exported special variables:
• Exported functions:
• Exported generic functions:
• Exported conditions:
• Exported structures:

• Internal special variables:
• Internal macros:
• Internal functions:
• Internal structures:

• Concept index:
• Function index:
• Variable index:
• Data type index:

• The s-base64 package:
• The s-xml-rpc-exports package:
• The s-xml-rpc package:

The s-xml-rpc Reference Manual

Table of Contents

The s-xml-rpc Reference Manual

1 Systems

1.1 s-xml-rpc

2 Modules

2.1 s-xml-rpc/src

3 Files

3.1 Lisp

3.1.1 s-xml-rpc.asd

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

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

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

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

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

4 Packages

4.1 s-base64

4.2 s-xml-rpc-exports

4.3 s-xml-rpc

5 Definitions

5.1 Exported definitions

5.1.1 Special variables

5.1.2 Functions

5.1.3 Generic functions

5.1.4 Conditions

5.1.5 Structures

5.2 Internal definitions

5.2.1 Special variables

5.2.2 Macros

5.2.3 Functions

5.2.4 Structures

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

1.1 `s-xml-rpc`

2.1 `s-xml-rpc/src`

3.1.1 `s-xml-rpc.asd`

3.1.2 `s-xml-rpc/src/base64.lisp`

3.1.3 `s-xml-rpc/src/package.lisp`

3.1.4 `s-xml-rpc/src/sysdeps.lisp`

3.1.5 `s-xml-rpc/src/xml-rpc.lisp`

3.1.6 `s-xml-rpc/src/extensions.lisp`

4.1 `s-base64`

4.2 `s-xml-rpc-exports`

4.3 `s-xml-rpc`