This is the cleric Reference Manual, version 0.2.4, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Jun 15 04:56:29 2025 GMT+0.
cleric/cleric.asdcleric/src/packages.lispcleric/src/listen.lispcleric/src/local-node.lispcleric/src/remote-node.lispcleric/src/atom-cache.lispcleric/src/atom-cache-entries.lispcleric/src/distribution-header.lispcleric/src/handshake-protocol.lispcleric/src/handshake.lispcleric/src/md5.lispcleric/src/control-message.lispcleric/src/node-protocol.lispThe main system appears first, followed by any subsystem dependency.
clericCommon Lisp Erlang Interface - An implementation of the Erlang distribution protocol.
Markus Flambard <mflambard@common-lisp.net>
MIT License
0.2.4
epmd (system).
erlang-term (system).
usocket (system).
md5 (system).
alexandria (system).
com.gigamonkeys.binary-data (system).
src (module).
Modules are listed depth-first from the system components tree.
cleric/srccleric (system).
packages.lisp (file).
listen.lisp (file).
local-node.lisp (file).
remote-node.lisp (file).
atom-cache.lisp (file).
atom-cache-entries.lisp (file).
distribution-header.lisp (file).
handshake-protocol.lisp (file).
handshake.lisp (file).
md5.lisp (file).
control-message.lisp (file).
node-protocol.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cleric/cleric.asdcleric/src/packages.lispcleric/src/listen.lispcleric/src/local-node.lispcleric/src/remote-node.lispcleric/src/atom-cache.lispcleric/src/atom-cache-entries.lispcleric/src/distribution-header.lispcleric/src/handshake-protocol.lispcleric/src/handshake.lispcleric/src/md5.lispcleric/src/control-message.lispcleric/src/node-protocol.lispcleric/src/listen.lisppackages.lisp (file).
src (module).
already-listening-on-socket (condition).
listening-p (function).
listening-port (function).
not-listening-on-socket (condition).
start-listening (function).
start-listening-on-socket-restart (function).
stop-listening (function).
*listening-socket* (special variable).
accept-connect (function).
port (reader method).
cleric/src/local-node.lisppackages.lisp (file).
src (module).
+highest-version-supported+ (constant).
+lowest-version-supported+ (constant).
make-pid (function).
make-reference (function).
node-host (function).
node-name (function).
this-node (function).
(setf this-node) (function).
*pid-id-counter* (special variable).
*reference-id-counter* (special variable).
*this-node* (special variable).
generate-new-pid-id (function).
generate-new-reference-id (function).
cleric/src/remote-node.lisppackages.lisp (file).
handshake.lisp (file).
listen.lisp (file).
local-node.lisp (file).
atom-cache.lisp (file).
src (module).
connected-remote-nodes (function).
node-unreachable-error (condition).
print-object (method).
remote-node (class).
remote-node-accept-connect (function).
remote-node-connect (function).
remote-node-host (reader method).
remote-node-name (reader method).
remote-node-port (reader method).
remote-node-socket (reader method).
try-connect-again-restart (function).
*remote-nodes* (special variable).
find-connected-remote-node (function).
make-remote-node (function).
register-connected-remote-node (function).
remote-node-atom-cache (reader method).
remote-node-sockets (function).
socket-stream (method).
cleric/src/atom-cache.lisppackages.lisp (file).
src (module).
print-object (method).
*atom-cache* (special variable).
atom-cache (structure).
atom-cache-add (function).
atom-cache-add-new (function).
atom-cache-find-free (function).
atom-cache-get (function).
atom-cache-location-of (function).
atom-cache-p (function).
atom-cache-print-atoms (function).
atom-cache-segments (reader).
copy-atom-cache (function).
make-atom-cache (function).
print-atom-cache (function).
cleric/src/atom-cache-entries.lisppackages.lisp (file).
atom-cache.lisp (file).
src (module).
add-cache-reference (function).
atom-cache-collector (class).
cache-references (reader method).
find-cache-reference (function).
get-cache-reference (function).
make-atom-cache-collector (function).
make-cache-reference-collection (function).
cleric/src/distribution-header.lisppackages.lisp (file).
atom-cache.lisp (file).
src (module).
+distribution-header-tag+ (constant).
atom-length (function).
decode-atom-cache-ref (function).
decode-distribution-header (function).
decode-flags (function).
encode-atom-cache-refs (function).
encode-flags (function).
long-atom-p (function).
long-atoms-p (function).
make-distribution-header (function).
cleric/src/handshake-protocol.lisppackages.lisp (file).
src (module).
challenge (reader method).
challenge (reader method).
(setf challenge) (writer method).
(setf challenge) (writer method).
challenge (class).
challenge-ack (class).
challenge-reply (class).
digest (reader method).
digest (reader method).
(setf digest) (writer method).
(setf digest) (writer method).
flags (reader method).
flags (reader method).
(setf flags) (writer method).
(setf flags) (writer method).
full-node-name (reader method).
full-node-name (reader method).
(setf full-node-name) (writer method).
(setf full-node-name) (writer method).
make-challenge-ack-message (function).
make-challenge-message (function).
make-challenge-reply-message (function).
make-name-message (function).
make-status-message (function).
name (class).
read-challenge-ack-message (function).
read-challenge-message (function).
read-challenge-reply-message (function).
read-name-message (function).
read-status-message (function).
status (reader method).
(setf status) (writer method).
status (class).
version (reader method).
version (reader method).
(setf version) (writer method).
(setf version) (writer method).
write-message (function).
handshake-message (class).
message-length (reader method).
(setf message-length) (writer method).
read-object (method).
read-object (method).
read-object (method).
read-object (method).
read-object (method).
read-object (method).
tag (reader method).
(setf tag) (writer method).
write-object (method).
write-object (method).
write-object (method).
write-object (method).
write-object (method).
write-object (method).
cleric/src/handshake.lisppackages.lisp (file).
handshake-protocol.lisp (file).
local-node.lisp (file).
md5.lisp (file).
src (module).
connection-closed-error (condition).
handshake-failed-error (condition).
reason (reader method).
reason (reader method).
try-again (condition).
try-again-condition-p (function).
+dflag-atom-cache+ (constant).
+dflag-bit-binaries+ (constant).
+dflag-dist-hdr-atom-cache+ (constant).
+dflag-dist-monitor+ (constant).
+dflag-dist-monitor-name+ (constant).
+dflag-export-ptr-tag+ (constant).
+dflag-extended-pids-ports+ (constant).
+dflag-extended-references+ (constant).
+dflag-fun-tags+ (constant).
+dflag-hidden-atom-cache+ (constant).
+dflag-new-floats+ (constant).
+dflag-new-fun-tags+ (constant).
+dflag-published+ (constant).
+dflag-small-atom-tags+ (constant).
+dflag-unicode-io+ (constant).
capability-flags (function).
equal-digests (function).
generate-challenge (function).
perform-client-handshake (function).
perform-server-handshake (function).
cleric/src/md5.lisppackages.lisp (file).
src (module).
calculate-digest (function).
cleric/src/control-message.lisppackages.lisp (file).
src (module).
cookie (reader method).
cookie (reader method).
exit (class).
exit2 (class).
from-pid (reader method).
from-pid (reader method).
from-pid (reader method).
from-pid (reader method).
from-pid (reader method).
group-leader (class).
link (class).
message (reader method).
message (reader method).
node-link (class).
reason (reader method).
reg-send (class).
send (class).
to-name (reader method).
to-pid (reader method).
to-pid (reader method).
to-pid (reader method).
to-pid (reader method).
to-pid (reader method).
trace-token (reader method).
unlink (class).
+cm-exit+ (constant).
+cm-exit-tt+ (constant).
+cm-exit2+ (constant).
+cm-exit2-tt+ (constant).
+cm-group-leader+ (constant).
+cm-link+ (constant).
+cm-node-link+ (constant).
+cm-reg-send+ (constant).
+cm-reg-send-tt+ (constant).
+cm-send+ (constant).
+cm-send-tt+ (constant).
+cm-unlink+ (constant).
control-message (class).
decode-control-message (function).
encode-control-message (generic function).
make-control-message (function).
cleric/src/node-protocol.lisppackages.lisp (file).
distribution-header.lisp (file).
control-message.lisp (file).
remote-node.lisp (file).
src (module).
link (function).
receive-node-messages (function).
reg-send (function).
send (function).
unlink (function).
+pass-through+ (constant).
+tock+ (constant).
read-node-message (function).
write-node-message (function).
Packages are listed by definition order.
common-lisp-erlang-interface-systemcleric-epmd-clientcleric-handshake-protocolcommon-lisp-erlang-interfacecleric-epmd-clientAn EPMD (Erlang Port Mapper Daemon) client.
cleric-epmd
common-lisp.
epmd-client.
cleric-handshake-protocolNode distribution handshake protocol.
com.gigamonkeys.binary-data.
com.gigamonkeys.binary-data.common-datatypes.
common-lisp.
challenge (generic reader).
(setf challenge) (generic writer).
challenge (class).
challenge-ack (class).
challenge-reply (class).
digest (generic reader).
(setf digest) (generic writer).
flags (generic reader).
(setf flags) (generic writer).
full-node-name (generic reader).
(setf full-node-name) (generic writer).
make-challenge-ack-message (function).
make-challenge-message (function).
make-challenge-reply-message (function).
make-name-message (function).
make-status-message (function).
name (class).
name (slot).
read-challenge-ack-message (function).
read-challenge-message (function).
read-challenge-reply-message (function).
read-name-message (function).
read-status-message (function).
status (generic reader).
(setf status) (generic writer).
status (class).
version (generic reader).
(setf version) (generic writer).
write-message (function).
handshake-message (class).
message-length (generic reader).
(setf message-length) (generic writer).
tag (generic reader).
(setf tag) (generic writer).
common-lisp-erlang-interfaceCLERIC (Common Lisp Erlang Interface) - An implementation of the Erlang distribution protocol.
cleric
cleric-handshake-protocol.
common-lisp.
erlang-term.
etf-bops.
+highest-version-supported+ (constant).
+lowest-version-supported+ (constant).
already-listening-on-socket (condition).
connected-remote-nodes (function).
connection-closed-error (condition).
cookie (generic reader).
exit (class).
exit2 (class).
from-pid (generic reader).
group-leader (class).
handshake-failed-error (condition).
link (function).
link (class).
listening-p (function).
listening-port (function).
make-pid (function).
make-reference (function).
message (generic reader).
node-host (function).
node-link (class).
node-name (function).
node-unreachable-error (condition).
not-listening-on-socket (condition).
reason (generic reader).
receive-node-messages (function).
reg-send (function).
reg-send (class).
remote-node (class).
remote-node-accept-connect (function).
remote-node-connect (function).
remote-node-host (generic reader).
remote-node-name (generic reader).
remote-node-port (generic reader).
remote-node-socket (generic reader).
send (function).
send (class).
start-listening (function).
start-listening-on-socket-restart (function).
stop-listening (function).
this-node (function).
(setf this-node) (function).
to-name (generic reader).
to-pid (generic reader).
trace-token (generic reader).
try-again (condition).
try-again-condition-p (function).
try-connect-again-restart (function).
unlink (function).
unlink (class).
*atom-cache* (special variable).
*listening-socket* (special variable).
*pid-id-counter* (special variable).
*reference-id-counter* (special variable).
*remote-nodes* (special variable).
*this-node* (special variable).
+cm-exit+ (constant).
+cm-exit-tt+ (constant).
+cm-exit2+ (constant).
+cm-exit2-tt+ (constant).
+cm-group-leader+ (constant).
+cm-link+ (constant).
+cm-node-link+ (constant).
+cm-reg-send+ (constant).
+cm-reg-send-tt+ (constant).
+cm-send+ (constant).
+cm-send-tt+ (constant).
+cm-unlink+ (constant).
+dflag-atom-cache+ (constant).
+dflag-bit-binaries+ (constant).
+dflag-dist-hdr-atom-cache+ (constant).
+dflag-dist-monitor+ (constant).
+dflag-dist-monitor-name+ (constant).
+dflag-export-ptr-tag+ (constant).
+dflag-extended-pids-ports+ (constant).
+dflag-extended-references+ (constant).
+dflag-fun-tags+ (constant).
+dflag-hidden-atom-cache+ (constant).
+dflag-new-floats+ (constant).
+dflag-new-fun-tags+ (constant).
+dflag-published+ (constant).
+dflag-small-atom-tags+ (constant).
+dflag-unicode-io+ (constant).
+distribution-header-tag+ (constant).
+pass-through+ (constant).
+tock+ (constant).
accept-connect (function).
add-cache-reference (function).
atom-cache (structure).
atom-cache-add (function).
atom-cache-add-new (function).
atom-cache-collector (class).
atom-cache-find-free (function).
atom-cache-get (function).
atom-cache-location-of (function).
atom-cache-p (function).
atom-cache-print-atoms (function).
atom-cache-segments (reader).
atom-length (function).
cache-references (generic reader).
calculate-digest (function).
capability-flags (function).
control-message (class).
copy-atom-cache (function).
decode-atom-cache-ref (function).
decode-control-message (function).
decode-distribution-header (function).
decode-flags (function).
encode-atom-cache-refs (function).
encode-control-message (generic function).
encode-flags (function).
equal-digests (function).
find-cache-reference (function).
find-connected-remote-node (function).
generate-challenge (function).
generate-new-pid-id (function).
generate-new-reference-id (function).
get-cache-reference (function).
long-atom-p (function).
long-atoms-p (function).
make-atom-cache (function).
make-atom-cache-collector (function).
make-cache-reference-collection (function).
make-control-message (function).
make-distribution-header (function).
make-remote-node (function).
perform-client-handshake (function).
perform-server-handshake (function).
port (generic reader).
print-atom-cache (function).
read-node-message (function).
register-connected-remote-node (function).
remote-node-atom-cache (generic reader).
remote-node-sockets (function).
socket-stream (generic function).
write-node-message (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Highest version of the Erlang distribution protocol supported.
Lowest version of the Erlang distribution protocol supported.
Create a link between two Pids.
Create a new Erlang PID.
Create a new Erlang reference.
Return the host part of a node identifier
Return the name part of a node identifier
Waits for and receives messages from connected nodes.
Send a message to a registered Pid.
Connect and perform handshake with a remote node.
Send a message to Pid.
Remove a link between two Pids.
challenge-reply)) ¶automatically generated reader method
challenge-reply)) ¶automatically generated writer method
challenge-ack)) ¶automatically generated reader method
challenge-reply)) ¶automatically generated reader method
challenge-ack)) ¶automatically generated writer method
challenge-reply)) ¶automatically generated writer method
group-leader)) ¶automatically generated reader method
reg-send)) ¶automatically generated reader method
unlink)) ¶automatically generated reader method
remote-node)) ¶automatically generated reader method
host.
remote-node)) ¶The name of the remote node.
name.
remote-node)) ¶automatically generated reader method
port.
remote-node)) ¶automatically generated reader method
group-leader)) ¶automatically generated reader method
control-message)) ¶automatically generated reader method
integer) (collector atom-cache-collector)) ¶etf-atom-cache-interface.
remote-node) stream) ¶atom-cache) stream) ¶symbol) (collector atom-cache-collector)) ¶etf-atom-cache-interface.
This error is signaled when trying to listen on a socket when already listening on an existing socket.
error.
port.
This error is signaled when trying to read from a socket stream that has been closed.
error.
This error is signaled if the handshake during connection to a remote node fails.
error.
This error is signaled when trying to connect to a node that is unreachable.
error.
This condition is signaled when trying to accept connections with a listening socket.
error.
This condition is signaled when trying to connect to a remote node that is busy.
condition.
:digest
EXIT Control Message.
GROUP_LEADER Control Message.
LINK Control Message.
NODE_LINK Control Message.
REG_SEND Control Message.
(quote common-lisp-erlang-interface::||)
:cookie
This slot is read-only.
A representation of a remote node.
:socket
This slot is read-only.
(common-lisp-erlang-interface::make-atom-cache)
This slot is read-only.
:port
This slot is read-only.
:node-type
0
:protocol
:highest-version
:lowest-version
The name of the remote node.
:name
This slot is read-only.
:host
This slot is read-only.
:full-name
#()
:extra-field
(quote common-lisp-erlang-interface::|init|)
:group-leader
SEND Control Message.
(quote common-lisp-erlang-interface::||)
:cookie
This slot is read-only.
:status
UNLINK Control Message.
An atom cache.
The listening socket. NIL if not listening.
Remote nodes connected to.
The name and host for this node.
Decode a sequence of bytes to a Control Message.
Generate a random 32-bit unsigned integer.
atom-cache-collector)) ¶The collection of cache references.
Encodes the Control Message to a vector of bytes.
group-leader) &key &allow-other-keys) ¶handshake-message)) ¶automatically generated reader method
handshake-message)) ¶automatically generated writer method
already-listening-on-socket)) ¶port.
remote-node)) ¶automatically generated reader method
remote-node)) ¶handshake-message)) ¶automatically generated reader method
tag.
handshake-message)) ¶automatically generated writer method
tag.
name) streamvar1) ¶com.gigamonkeys.binary-data.
challenge) streamvar1) ¶com.gigamonkeys.binary-data.
status) streamvar1) ¶com.gigamonkeys.binary-data.
challenge-reply) streamvar1) ¶com.gigamonkeys.binary-data.
challenge-ack) streamvar1) ¶com.gigamonkeys.binary-data.
handshake-message) streamvar1) ¶com.gigamonkeys.binary-data.
name) streamvar3) ¶com.gigamonkeys.binary-data.
challenge) streamvar3) ¶com.gigamonkeys.binary-data.
status) streamvar3) ¶com.gigamonkeys.binary-data.
challenge-reply) streamvar3) ¶com.gigamonkeys.binary-data.
challenge-ack) streamvar3) ¶com.gigamonkeys.binary-data.
handshake-message) streamvar3) ¶com.gigamonkeys.binary-data.
Erlang atom cache
structure-object.
(array symbol (8 256))
(make-array (quote (8 256)) :element-type (quote symbol) :initial-element nil)
This slot is read-only.
The atom cache collector is used to retrieve already cached
atoms and to collect atom references to be used in a protocol message.
The atom cache used for a node connection.
:atom-cache
The collection of cache references.
(common-lisp-erlang-interface::make-cache-reference-collection)
:cache-references
This slot is read-only.
:trace-token
This slot is read-only.
| Jump to: | (
A C D E F G L M N P R S T U V W |
|---|
| Jump to: | (
A C D E F G L M N P R S T U V W |
|---|
| Jump to: | *
+
A C D E F G H L M N P R S T V |
|---|
| Jump to: | *
+
A C D E F G H L M N P R S T V |
|---|
| Jump to: | A C D E F G H L M N P R S T U |
|---|
| Jump to: | A C D E F G H L M N P R S T U |
|---|