This is the s-xml-rpc Reference Manual, version 7, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Sep 15 06:38:29 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
s-xml-rpc
Common Lisp XML-RPC Package
Sven Van Caekenberghe
Sven Van Caekenberghe <svc@mac.com>
Lesser Lisp General Public License (LLGPL)
s-xml-rpc is a Common Lisp implementation of the XML-RPC procotol for both client and server
7
s-xml
(system).
sb-bsd-sockets
(system).
src
(module).
Modules are listed depth-first from the system components tree.
s-xml-rpc/src
s-xml-rpc
(system).
base64.lisp
(file).
package.lisp
(file).
sysdeps.lisp
(file).
xml-rpc.lisp
(file).
extensions.lisp
(file).
Files are sorted by type and then listed depth-first from the systems components trees.
s-xml-rpc/s-xml-rpc.asd
s-xml-rpc/src/base64.lisp
s-xml-rpc/src/package.lisp
s-xml-rpc/src/sysdeps.lisp
s-xml-rpc/src/xml-rpc.lisp
s-xml-rpc/src/extensions.lisp
s-xml-rpc/src/base64.lisp
src
(module).
decode-base64
(function).
decode-base64-bytes
(function).
encode-base64
(function).
encode-base64-bytes
(function).
+base64-alphabet+
(special variable).
+inverse-base64-alphabet+
(special variable).
core-decode-base64
(function).
core-encode-base64
(function).
skip-base64-whitespace
(function).
s-xml-rpc/src/package.lisp
base64.lisp
(file).
src
(module).
s-xml-rpc/src/sysdeps.lisp
package.lisp
(file).
src
(module).
stop-server
(function).
*server-processes*
(special variable).
run-process
(function).
start-standard-server
(function).
with-open-socket-stream
(macro).
s-xml-rpc/src/xml-rpc.lisp
package.lisp
(file).
sysdeps.lisp
(file).
base64.lisp
(file).
src
(module).
*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).
*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).
s-xml-rpc/src/extensions.lisp
package.lisp
(file).
xml-rpc.lisp
(file).
src
(module).
system.getcapabilities
(function).
system.listmethods
(function).
system.methodhelp
(function).
system.methodsignature
(function).
system.multicall
(function).
do-one-multicall
(function).
Packages are listed by definition order.
s-base64
An implementation of standard Base64 encoding and decoding
common-lisp
.
decode-base64
(function).
decode-base64-bytes
(function).
encode-base64
(function).
encode-base64-bytes
(function).
+base64-alphabet+
(special variable).
+inverse-base64-alphabet+
(special variable).
core-decode-base64
(function).
core-encode-base64
(function).
skip-base64-whitespace
(function).
s-xml-rpc
An implementation of the standard XML-RPC protocol for both client and server
common-lisp
.
s-base64
.
s-xml
.
*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 reader).
xml-rpc-error-place
(generic reader).
xml-rpc-fault
(condition).
xml-rpc-fault-code
(generic reader).
xml-rpc-fault-string
(generic reader).
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).
*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
(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).
Definitions are sorted by export status, category, package, and then by lexicographic order.
String specifying the default XML-RPC agent to include in server responses
When not null, a string to be used as Authorization header
A function to execute the xml-rpc call and return the result, accepting a method-name string and a optional argument list
When T the XML-RPC client and server part will be more verbose about their protocol
When not nil it specifies where debugging output should be written to
String naming the default XML-RPC host to use
Package for XML-RPC callable functions
Integer specifying the default XML-RPC port to use
When not null, a string naming the XML-RPC proxy host to use
When not null, an integer specifying the XML-RPC proxy port to use
String specifying the default XML-RPC URL to use
Encode and execute an XML-RPC call with name and args, using the list of server-keywords
Decode a base64 encoded character input stream into a binary output stream
Decode a base64 encoded character stream, returns a byte array
Encode a binary input stream into a base64 encoded character output stream
Encode a byte array into a base64b encoded character stream
Encode an XML-RPC call with name and args as an XML string
Execute method METHOD-NAME on ARGUMENTS, or raise an error if no such method exists in *XML-RPC-PACKAGE*
Get the value of a specific member of an XML-RPC-STRUCT
Set the value of a specific member of an XML-RPC-STRUCT
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.
Kill a server process by name (as started by start-standard-server)
Get a list of supported capabilities; see http://groups.yahoo.com/group/xml-rpc/message/2897 for the specification.
List the methods that are available on this server.
Returns the function documentation for the given method.
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.
Implement system.multicall; see http://www.xmlrpc.com/discuss/msgReader$1208 for the specification.
Execute an already encoded XML-RPC call and return the decoded result
Create a new XML-RPC-STRUCT from the arguments: alternating member names and values
Return the alist of member names and values from an XML-RPC struct
Compare two XML-RPC-STRUCTs for equality
Return T when the argument is an XML-RPC struct
Create a new XML-RPC-TIME struct with the universal time specified, defaulting to now
Return T when the argument is an XML-RPC time
Return the universal time from an XML-RPC time
Get the data from an XML-RPC error
xml-rpc-error
)) ¶data
.
Get the place from an XML-RPC error
xml-rpc-error
)) ¶Get the code from an XML-RPC fault
xml-rpc-fault
)) ¶code
.
Get the string from an XML-RPC fault
xml-rpc-fault
)) ¶xml-rpc-struct
) stream) ¶xml-rpc-time
) stream) ¶xml-literal
) stream) ¶Parent condition for all conditions thrown by the XML-RPC package
error
.
This condition is thrown when an XML-RPC protocol error occurs
This condition is thrown when the XML-RPC server returns a fault
An XML-RPC-STRUCT is an associative map of member names and values
structure-object
.
A wrapper around a Common Lisp universal time to be interpreted as an XML-RPC-TIME
structure-object
.
Unique ID for incoming connections
Execute body with a bidirectional socket stream opened to host:port
Tries to describe a remote server using system.* methods
Looks for a method with the given name in *xml-rpc-package*, except that colons in the name get converted to hyphens.
Handle an actual call, reading XML from in and returning the XML-encoded result.
Convert string in the XML-RPC variant of ISO8601 to a Common Lisp universal time
Create and run a new process with name, executing function on arguments
Start a server process with name, listening on port, delegating to connection-handler with stream as argument
Convert a Common Lisp universal time to a string in the XML-RPC variant of ISO8601
Create a new XML-LITERAL struct with the specified content.
Return the content of a literal xml string
Return T when the argument is an unescaped xml string
Identify ourselves
Handle an incoming connection, doing both all HTTP and XML-RPC stuff
Jump to: | (
C D E F G H I M P R S T U V W X |
---|
Jump to: | (
C D E F G H I M P R S T U V W X |
---|
Jump to: | *
+
A C D P S U |
---|
Jump to: | *
+
A C D P S U |
---|
Jump to: | B C E F M P S X |
---|
Jump to: | B C E F M P S X |
---|