This is the cl-mtgnet Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 15:29:11 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
cl-mtgnetClient library for the MTGNet RPC protocol.
Matthew Stickney <mtstickney@gmail.com>
MIT
trivial-utf-8 (system).
cl-json (system).
cl-netstring+ (system).
blackbird (system).
package.lisp (file).
marshall.lisp (file).
transport.lisp (file).
framer.lisp (file).
cl-mtgnet.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-mtgnet/cl-mtgnet.asdcl-mtgnet/package.lispcl-mtgnet/marshall.lispcl-mtgnet/transport.lispcl-mtgnet/framer.lispcl-mtgnet/cl-mtgnet.lispcl-mtgnet/marshall.lisppackage.lisp (file).
cl-mtgnet (system).
build-rpc-call (function).
build-rpc-error (function).
build-rpc-request (function).
build-rpc-response (function).
build-rpc-result (function).
build-rpc-warning-list (function).
invalid-json-obj (condition).
make-rpc-call (function).
make-rpc-error (function).
make-rpc-result (function).
marshall-rpc-call (function).
marshall-rpc-error (function).
marshall-rpc-request (function).
marshall-rpc-response (function).
marshall-rpc-result (function).
marshall-rpc-warning-list (function).
rpc-call (structure).
rpc-call-args (reader).
rpc-call-id (reader).
rpc-call-method (reader).
rpc-call-p (function).
rpc-call-service (reader).
rpc-error (structure).
rpc-error-code (reader).
rpc-error-data (reader).
rpc-error-message (reader).
rpc-error-p (function).
rpc-request (type).
rpc-request-p (function).
rpc-response (type).
rpc-response-p (function).
rpc-result (structure).
rpc-result-data (reader).
rpc-result-error (reader).
rpc-result-id (reader).
rpc-result-p (function).
rpc-result-warnings (reader).
rpc-warning-list (type).
rpc-warning-list-p (function).
unmarshall-rpc-call (function).
unmarshall-rpc-error (function).
unmarshall-rpc-request (function).
unmarshall-rpc-response (function).
unmarshall-rpc-result (function).
unmarshall-rpc-warning-list (function).
build-arg-list (function).
cat-symbol (function).
copy-rpc-call (function).
copy-rpc-error (function).
copy-rpc-result (function).
define-json-obj (macro).
define-object-array (macro).
encode-field (function).
marshall-arg-list (function).
obj-json (reader method).
(setf obj-json) (writer method).
obj-type (reader method).
(setf obj-type) (writer method).
optional-slot-p (function).
serial-slot-p (function).
slot-key (function).
slot-marshall-type (function).
slot-optional-p (function).
slot-symbol (function).
cl-mtgnet/transport.lispmarshall.lisp (file).
cl-mtgnet (system).
initialize-instance (method).
string-input-transport (class).
string-output-transport (class).
transport (class).
transport-connect (generic function).
transport-disconnect (generic function).
transport-flush (generic function).
transport-read (generic function).
transport-read-into! (generic function).
transport-write (generic function).
external-format (reader method).
external-format (reader method).
(setf external-format) (writer method).
(setf external-format) (writer method).
input-data (reader method).
(setf input-data) (writer method).
input-stream (reader method).
(setf input-stream) (writer method).
output-stream (reader method).
(setf output-stream) (writer method).
cl-mtgnet/framer.lisptransport.lisp (file).
cl-mtgnet (system).
data-framer (class).
frame-data (generic function).
frame-data* (generic function).
netstring-framer (class).
netstring-state (reader method).
(setf netstring-state) (writer method).
read-frame (generic function).
unframe-data (generic function).
write-frame (generic function).
cl-mtgnet/cl-mtgnet.lispframer.lisp (file).
cl-mtgnet (system).
*default-encoder* (special variable).
add-result (generic function).
connect (generic function).
disconnect (generic function).
duplicate-result-id (condition).
invoke-rpc-method (function).
make-call-obj (function).
make-result-promise (function).
process-next-response (generic function).
read-request (generic function).
read-response (generic function).
receive-frame (generic function).
remote-error (condition).
remote-error-code (reader method).
(setf remote-error-code) (writer method).
remote-error-data (reader method).
(setf remote-error-data) (writer method).
remote-error-msg (reader method).
(setf remote-error-msg) (writer method).
remote-error-type (reader method).
(setf remote-error-type) (writer method).
remote-warning (condition).
remote-warning-code (reader method).
(setf remote-warning-code) (writer method).
remote-warning-data (reader method).
(setf remote-warning-data) (writer method).
remote-warning-msg (reader method).
(setf remote-warning-msg) (writer method).
rpc-call-promise (function).
rpc-connection (class).
send-frame (generic function).
send-frame* (generic function).
send-request (generic function).
send-response (generic function).
submit-batch (generic function).
with-batch-calls (macro).
bind-args (macro).
connection-framer (reader method).
(setf connection-framer) (writer method).
connection-transport (reader method).
(setf connection-transport) (writer method).
current-request (reader method).
(setf current-request) (writer method).
has-key (function).
id (type).
next-response-promise (reader method).
(setf next-response-promise) (writer method).
read-result-with-id (function).
register-waiter (function).
reject-waiter (function).
resolve-waiter (function).
result-bucket (reader method).
(setf result-bucket) (writer method).
result-waiters (reader method).
(setf result-waiters) (writer method).
unregister-waiter (function).
waiter-exists-p (function).
waiter-reject-fn (function).
waiter-resolve-fn (function).
Packages are listed by definition order.
mtgnet-syscommon-lisp.
*default-encoder* (special variable).
add-result (generic function).
build-rpc-call (function).
build-rpc-error (function).
build-rpc-request (function).
build-rpc-response (function).
build-rpc-result (function).
build-rpc-warning-list (function).
connect (generic function).
data-framer (class).
disconnect (generic function).
duplicate-result-id (condition).
frame-data (generic function).
frame-data* (generic function).
invalid-json-obj (condition).
invoke-rpc-method (function).
make-call-obj (function).
make-result-promise (function).
make-rpc-call (function).
make-rpc-error (function).
make-rpc-result (function).
marshall-rpc-call (function).
marshall-rpc-error (function).
marshall-rpc-request (function).
marshall-rpc-response (function).
marshall-rpc-result (function).
marshall-rpc-warning-list (function).
netstring-framer (class).
netstring-state (generic reader).
(setf netstring-state) (generic writer).
process-next-response (generic function).
read-frame (generic function).
read-request (generic function).
read-response (generic function).
receive-frame (generic function).
remote-error (condition).
remote-error-code (generic reader).
(setf remote-error-code) (generic writer).
remote-error-data (generic reader).
(setf remote-error-data) (generic writer).
remote-error-msg (generic reader).
(setf remote-error-msg) (generic writer).
remote-error-type (generic reader).
(setf remote-error-type) (generic writer).
remote-warning (condition).
remote-warning-code (generic reader).
(setf remote-warning-code) (generic writer).
remote-warning-data (generic reader).
(setf remote-warning-data) (generic writer).
remote-warning-msg (generic reader).
(setf remote-warning-msg) (generic writer).
rpc-call (structure).
rpc-call-args (reader).
rpc-call-id (reader).
rpc-call-method (reader).
rpc-call-p (function).
rpc-call-promise (function).
rpc-call-service (reader).
rpc-connection (class).
rpc-error (structure).
rpc-error-code (reader).
rpc-error-data (reader).
rpc-error-message (reader).
rpc-error-p (function).
rpc-request (type).
rpc-request-p (function).
rpc-response (type).
rpc-response-p (function).
rpc-result (structure).
rpc-result-data (reader).
rpc-result-error (reader).
rpc-result-id (reader).
rpc-result-p (function).
rpc-result-warnings (reader).
rpc-warning-list (type).
rpc-warning-list-p (function).
send-frame (generic function).
send-frame* (generic function).
send-request (generic function).
send-response (generic function).
string-input-transport (class).
string-output-transport (class).
submit-batch (generic function).
synchronous-transport (class).
transport (class).
transport-connect (generic function).
transport-disconnect (generic function).
transport-flush (generic function).
transport-read (generic function).
transport-read-into! (generic function).
transport-write (generic function).
unframe-data (generic function).
unmarshall-rpc-call (function).
unmarshall-rpc-error (function).
unmarshall-rpc-request (function).
unmarshall-rpc-response (function).
unmarshall-rpc-result (function).
unmarshall-rpc-warning-list (function).
with-batch-calls (macro).
write-frame (generic function).
bind-args (macro).
build-arg-list (function).
cat-symbol (function).
connection-framer (generic reader).
(setf connection-framer) (generic writer).
connection-transport (generic reader).
(setf connection-transport) (generic writer).
copy-rpc-call (function).
copy-rpc-error (function).
copy-rpc-result (function).
current-request (generic reader).
(setf current-request) (generic writer).
define-json-obj (macro).
define-object-array (macro).
encode-field (function).
external-format (generic reader).
(setf external-format) (generic writer).
has-key (function).
id (type).
input-data (generic reader).
(setf input-data) (generic writer).
input-stream (generic reader).
(setf input-stream) (generic writer).
marshall-arg-list (function).
next-response-promise (generic reader).
(setf next-response-promise) (generic writer).
obj-json (generic reader).
(setf obj-json) (generic writer).
obj-type (generic reader).
(setf obj-type) (generic writer).
optional-slot-p (function).
output-stream (generic reader).
(setf output-stream) (generic writer).
read-result-with-id (function).
register-waiter (function).
reject-waiter (function).
resolve-waiter (function).
result-bucket (generic reader).
(setf result-bucket) (generic writer).
result-waiters (generic reader).
(setf result-waiters) (generic writer).
serial-slot-p (function).
slot-key (function).
slot-marshall-type (function).
slot-optional-p (function).
slot-symbol (function).
unregister-waiter (function).
waiter-exists-p (function).
waiter-reject-fn (function).
waiter-resolve-fn (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Arrange for RPC calls in this block to collect their calls into one request, which will be sent at the end of the block.
Return a promise that produces a result with an id of ID from CON.
Add an RPC result to the results received by CON.
rpc-connection) result) ¶Connect CON to the remote end.
rpc-connection)) ¶Disconnect the connection CON.
rpc-connection) &key abort) ¶Frame one or more data fragments for transmission.
netstring-framer) &rest datae) ¶Frame multiple data fragments for transmission.
netstring-framer) datae) ¶netstring-framer)) ¶automatically generated reader method
netstring-framer)) ¶automatically generated writer method
Process the next response, without triggering an additional read if one is already in progress.
rpc-connection)) ¶Read a frame from TRANSPORT.
netstring-framer) transport) ¶Read and unmarshall an RPC request from CON.
rpc-connection)) ¶Read and unmarshall an RPC response from CON.
rpc-connection)) ¶Read and return a frame of data sent over CON. Wraps READ-FRAME, mostly for extension convenience.
rpc-connection)) ¶remote-error)) ¶remote-error)) ¶code.
remote-error)) ¶remote-error)) ¶data.
remote-error)) ¶remote-error)) ¶msg.
remote-error)) ¶remote-error)) ¶type.
remote-warning)) ¶remote-warning)) ¶code.
remote-warning)) ¶remote-warning)) ¶data.
remote-warning)) ¶remote-warning)) ¶msg.
Use CON’s framer to write a frame over CON’s transport. Mostly for extension convenience.
rpc-connection) &rest datae) ¶Use CON’s framer to write a frame over CON’s transport. Wraps WRITE-FRAME, mostly for extension convenience.
rpc-connection) datae) ¶Marshall and send REQUEST over CON.
rpc-connection) request) ¶Marshall and send RESPONSE over CON.
rpc-connection) response) ¶rpc-connection) call-objs) ¶Connect TRANSPORT to the remote end, if necessary.
string-input-transport)) ¶Disconnect TRANSPORT from the remote end, if necessary.
string-output-transport) &key abort) ¶Flush buffers associated with TRANSPORT, if any.
string-output-transport)) ¶Read the next SIZE elements of data from TRANSPORT.
string-input-transport) size) ¶Destructively modify SEQ with elements from TRANSPORT.
string-input-transport) seq &key start end) ¶Send DATA to the remote end of TRANSPORT.
string-output-transport) data) ¶Return the data framed by FRAME.
netstring-framer) frame) ¶Send multiple data fragments as a single frame over TRANSPORT
netstring-framer) transport datae) ¶string-output-transport) &key) ¶condition.
error.
| Initarg | Value |
|---|---|
:data | nil |
common-lisp.
:type
:msg
:code
:data
A single method invocation.
structure-object.
string
""
This slot is read-only.
common-lisp.
string
""
This slot is read-only.
list
(quote nil)
This slot is read-only.
This slot is read-only.
Error object contained in a failed rpc-result.
The result of an RPC method invocation.
structure-object.
This slot is read-only.
common-lisp.
This slot is read-only.
(quote nil)
This slot is read-only.
This slot is read-only.
(cl-netstring+:make-decoder-state)
Class representing a connection to an RPC server
add-result.
connect.
(setf connection-framer).
connection-framer.
(setf connection-transport).
connection-transport.
(setf current-request).
current-request.
disconnect.
(setf next-response-promise).
next-response-promise.
process-next-response.
read-request.
read-response.
receive-frame.
(setf result-bucket).
result-bucket.
(setf result-waiters).
result-waiters.
send-frame.
send-frame*.
send-request.
send-response.
submit-batch.
:transport
:framer
(make-hash-table :test (quote equal))
(make-hash-table :test (quote equal))
Encode VALUE as an object field named FIELD, using ENCODER to encode VALUE.
Read responses from CON, storing results until a request containing a response with id ID arrives. Will process all results in a response before returning.
rpc-connection)) ¶automatically generated reader method
rpc-connection)) ¶automatically generated writer method
rpc-connection)) ¶automatically generated reader method
rpc-connection)) ¶automatically generated writer method
rpc-connection)) ¶automatically generated reader method
rpc-connection)) ¶automatically generated writer method
string-input-transport)) ¶automatically generated reader method
string-output-transport)) ¶automatically generated reader method
string-input-transport)) ¶automatically generated writer method
string-output-transport)) ¶automatically generated writer method
string-input-transport)) ¶automatically generated reader method
data.
string-input-transport)) ¶automatically generated writer method
data.
string-input-transport)) ¶automatically generated reader method
string-input-transport)) ¶automatically generated writer method
rpc-connection)) ¶automatically generated reader method
rpc-connection)) ¶automatically generated writer method
invalid-json-obj)) ¶invalid-json-obj)) ¶json.
invalid-json-obj)) ¶invalid-json-obj)) ¶type.
string-output-transport)) ¶automatically generated reader method
string-output-transport)) ¶automatically generated writer method
rpc-connection)) ¶automatically generated reader method
rpc-connection)) ¶automatically generated writer method
rpc-connection)) ¶automatically generated reader method
rpc-connection)) ¶automatically generated writer method
| Jump to: | (
A B C D E F G H I M N O P R S T U W |
|---|
| Jump to: | (
A B C D E F G H I M N O P R S T U W |
|---|
| Jump to: | *
A C D E F I J M N R S T W |
|---|
| Jump to: | *
A C D E F I J M N R S T W |
|---|
| Jump to: | C D F I M N P R S T |
|---|
| Jump to: | C D F I M N P R S T |
|---|