Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the cleric Reference Manual, version 0.2.4, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:30:16 2018 GMT+0.
• Introduction: | What cleric is all about | |
• 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 |
CLERIC is an implementation of the Erlang distribution protocol, comparable with erl_interface and jinterface.
Homepage: http://common-lisp.net/project/cleric/
Please see the doc/
directory for further documentation. The latest documentation is available online.
CLERIC is easily installed with Quicklisp.
> (ql:quickload :cleric)
To check out the latest code, use git:
$ git clone git://github.com/flambard/CLERIC.git
Quicklisp will download and install these libraries automatically when installing CLERIC.
Next: Modules, Previous: Introduction, Up: Top [Contents][Index]
The main system appears first, followed by any subsystem dependency.
• The cleric system: |
Markus Flambard <mflambard@common-lisp.net>
MIT License
Common Lisp Erlang Interface - An implementation of the Erlang distribution protocol.
0.2.4
cleric.asd (file)
src (module)
Modules are listed depth-first from the system components tree.
• The cleric/src module: |
cleric (system)
src/
Files are sorted by type and then listed depth-first from the systems components trees.
• Lisp files: |
Next: The cleric/src/packages<dot>lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
cleric.asd
cleric (system)
Next: The cleric/src/listen<dot>lisp file, Previous: The cleric<dot>asd file, Up: Lisp files [Contents][Index]
src (module)
src/packages.lisp
Next: The cleric/src/local-node<dot>lisp file, Previous: The cleric/src/packages<dot>lisp file, Up: Lisp files [Contents][Index]
packages.lisp (file)
src (module)
src/listen.lisp
Next: The cleric/src/remote-node<dot>lisp file, Previous: The cleric/src/listen<dot>lisp file, Up: Lisp files [Contents][Index]
packages.lisp (file)
src (module)
src/local-node.lisp
Next: The cleric/src/atom-cache<dot>lisp file, Previous: The cleric/src/local-node<dot>lisp file, Up: Lisp files [Contents][Index]
src (module)
src/remote-node.lisp
Next: The cleric/src/atom-cache-entries<dot>lisp file, Previous: The cleric/src/remote-node<dot>lisp file, Up: Lisp files [Contents][Index]
packages.lisp (file)
src (module)
src/atom-cache.lisp
Next: The cleric/src/distribution-header<dot>lisp file, Previous: The cleric/src/atom-cache<dot>lisp file, Up: Lisp files [Contents][Index]
src (module)
src/atom-cache-entries.lisp
Next: The cleric/src/handshake-protocol<dot>lisp file, Previous: The cleric/src/atom-cache-entries<dot>lisp file, Up: Lisp files [Contents][Index]
src (module)
src/distribution-header.lisp
Next: The cleric/src/handshake<dot>lisp file, Previous: The cleric/src/distribution-header<dot>lisp file, Up: Lisp files [Contents][Index]
packages.lisp (file)
src (module)
src/handshake-protocol.lisp
Next: The cleric/src/md5<dot>lisp file, Previous: The cleric/src/handshake-protocol<dot>lisp file, Up: Lisp files [Contents][Index]
src (module)
src/handshake.lisp
Next: The cleric/src/control-message<dot>lisp file, Previous: The cleric/src/handshake<dot>lisp file, Up: Lisp files [Contents][Index]
packages.lisp (file)
src (module)
src/md5.lisp
calculate-digest (function)
Next: The cleric/src/node-protocol<dot>lisp file, Previous: The cleric/src/md5<dot>lisp file, Up: Lisp files [Contents][Index]
packages.lisp (file)
src (module)
src/control-message.lisp
Previous: The cleric/src/control-message<dot>lisp file, Up: Lisp files [Contents][Index]
src (module)
src/node-protocol.lisp
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
• The common-lisp-erlang-interface-system package: | ||
• The cleric-epmd-client package: | ||
• The common-lisp-erlang-interface package: | ||
• The cleric-handshake-protocol package: |
Next: The cleric-epmd-client package, Previous: Packages, Up: Packages [Contents][Index]
cleric.asd
cleric-system
common-lisp
Next: The common-lisp-erlang-interface package, Previous: The common-lisp-erlang-interface-system package, Up: Packages [Contents][Index]
An EPMD (Erlang Port Mapper Daemon) client.
packages.lisp (file)
cleric-epmd
Next: The cleric-handshake-protocol package, Previous: The cleric-epmd-client package, Up: Packages [Contents][Index]
CLERIC (Common Lisp Erlang Interface) - An implementation of the Erlang distribution protocol.
packages.lisp (file)
cleric
Previous: The common-lisp-erlang-interface package, Up: Packages [Contents][Index]
Node distribution handshake protocol.
packages.lisp (file)
Definitions are sorted by export status, category, package, and then by lexicographic order.
• Exported definitions: | ||
• Internal definitions: |
Next: Internal definitions, Previous: Definitions, Up: Definitions [Contents][Index]
• Exported constants: | ||
• Exported functions: | ||
• Exported generic functions: | ||
• Exported conditions: | ||
• Exported classes: |
Next: Exported functions, Previous: Exported definitions, Up: Exported definitions [Contents][Index]
Highest version of the Erlang distribution protocol supported.
local-node.lisp (file)
Lowest version of the Erlang distribution protocol supported.
local-node.lisp (file)
Next: Exported generic functions, Previous: Exported constants, Up: Exported definitions [Contents][Index]
remote-node.lisp (file)
Create a link between two Pids.
node-protocol.lisp (file)
listen.lisp (file)
listen.lisp (file)
handshake-protocol.lisp (file)
handshake-protocol.lisp (file)
handshake-protocol.lisp (file)
handshake-protocol.lisp (file)
Create a new Erlang PID.
local-node.lisp (file)
Create a new Erlang reference.
local-node.lisp (file)
handshake-protocol.lisp (file)
Return the host part of a node identifier
local-node.lisp (file)
Return the name part of a node identifier
local-node.lisp (file)
handshake-protocol.lisp (file)
handshake-protocol.lisp (file)
handshake-protocol.lisp (file)
handshake-protocol.lisp (file)
handshake-protocol.lisp (file)
Waits for and receives messages from connected nodes.
node-protocol.lisp (file)
Send a message to a registered Pid.
node-protocol.lisp (file)
remote-node.lisp (file)
Connect and perform handshake with a remote node.
remote-node.lisp (file)
Send a message to Pid.
node-protocol.lisp (file)
listen.lisp (file)
listen.lisp (file)
listen.lisp (file)
local-node.lisp (file)
handshake.lisp (file)
remote-node.lisp (file)
Remove a link between two Pids.
node-protocol.lisp (file)
handshake-protocol.lisp (file)
Next: Exported conditions, Previous: Exported functions, Up: Exported definitions [Contents][Index]
automatically generated reader method
handshake-protocol.lisp (file)
automatically generated writer method
handshake-protocol.lisp (file)
automatically generated reader method
handshake-protocol.lisp (file)
automatically generated writer method
handshake-protocol.lisp (file)
automatically generated reader method
control-message.lisp (file)
automatically generated reader method
control-message.lisp (file)
automatically generated reader method
handshake-protocol.lisp (file)
automatically generated writer method
handshake-protocol.lisp (file)
automatically generated reader method
handshake-protocol.lisp (file)
automatically generated writer method
handshake-protocol.lisp (file)
automatically generated reader method
handshake-protocol.lisp (file)
automatically generated writer method
handshake-protocol.lisp (file)
automatically generated reader method
handshake-protocol.lisp (file)
automatically generated writer method
handshake-protocol.lisp (file)
automatically generated reader method
control-message.lisp (file)
automatically generated reader method
control-message.lisp (file)
automatically generated reader method
control-message.lisp (file)
automatically generated reader method
control-message.lisp (file)
automatically generated reader method
control-message.lisp (file)
automatically generated reader method
handshake-protocol.lisp (file)
automatically generated writer method
handshake-protocol.lisp (file)
automatically generated reader method
handshake-protocol.lisp (file)
automatically generated writer method
handshake-protocol.lisp (file)
automatically generated reader method
control-message.lisp (file)
automatically generated reader method
control-message.lisp (file)
automatically generated reader method
control-message.lisp (file)
handshake.lisp (file)
handshake.lisp (file)
automatically generated reader method
remote-node.lisp (file)
The name of the remote node.
remote-node.lisp (file)
automatically generated reader method
remote-node.lisp (file)
automatically generated reader method
remote-node.lisp (file)
automatically generated reader method
handshake-protocol.lisp (file)
automatically generated writer method
handshake-protocol.lisp (file)
automatically generated reader method
control-message.lisp (file)
automatically generated reader method
control-message.lisp (file)
automatically generated reader method
control-message.lisp (file)
automatically generated reader method
control-message.lisp (file)
automatically generated reader method
control-message.lisp (file)
automatically generated reader method
control-message.lisp (file)
automatically generated reader method
control-message.lisp (file)
automatically generated reader method
handshake-protocol.lisp (file)
automatically generated writer method
handshake-protocol.lisp (file)
automatically generated reader method
handshake-protocol.lisp (file)
automatically generated writer method
handshake-protocol.lisp (file)
Next: Exported classes, Previous: Exported generic functions, Up: Exported definitions [Contents][Index]
This error is signaled when trying to listen on a socket when already listening on an existing socket.
listen.lisp (file)
error (condition)
port (method)
:port
port (generic function)
This error is signaled when trying to read from a socket stream that has been closed.
handshake.lisp (file)
error (condition)
This error is signaled if the handshake during connection to a remote node fails.
handshake.lisp (file)
error (condition)
reason (method)
:reason
reason (generic function)
This error is signaled when trying to connect to a node that is unreachable.
remote-node.lisp (file)
error (condition)
This condition is signaled when trying to accept connections with a listening socket.
listen.lisp (file)
error (condition)
This condition is signaled when trying to connect to a remote node that is busy.
handshake.lisp (file)
condition (condition)
reason (method)
:reason
reason (generic function)
Previous: Exported conditions, Up: Exported definitions [Contents][Index]
handshake-protocol.lisp (file)
handshake-message (class)
:version
version (generic function)
(setf version) (generic function)
:flags
flags (generic function)
(setf flags) (generic function)
:challenge
challenge (generic function)
(setf challenge) (generic function)
:full-node-name
full-node-name (generic function)
(setf full-node-name) (generic function)
handshake-protocol.lisp (file)
handshake-message (class)
:digest
digest (generic function)
(setf digest) (generic function)
handshake-protocol.lisp (file)
handshake-message (class)
:challenge
challenge (generic function)
(setf challenge) (generic function)
:digest
digest (generic function)
(setf digest) (generic function)
EXIT Control Message.
control-message.lisp (file)
control-message (class)
exit2 (class)
:from-pid
from-pid (generic function)
:to-pid
to-pid (generic function)
:reason
reason (generic function)
EXIT2 Control Message.
control-message.lisp (file)
exit (class)
encode-control-message (method)
GROUP_LEADER Control Message.
control-message.lisp (file)
control-message (class)
:from-pid
from-pid (generic function)
:to-pid
to-pid (generic function)
LINK Control Message.
control-message.lisp (file)
control-message (class)
:from-pid
from-pid (generic function)
:to-pid
to-pid (generic function)
handshake-protocol.lisp (file)
handshake-message (class)
:version
version (generic function)
(setf version) (generic function)
:flags
flags (generic function)
(setf flags) (generic function)
:full-node-name
full-node-name (generic function)
(setf full-node-name) (generic function)
NODE_LINK Control Message.
control-message.lisp (file)
control-message (class)
encode-control-message (method)
REG_SEND Control Message.
control-message.lisp (file)
control-message (class)
:from-pid
from-pid (generic function)
:cookie
(quote common-lisp-erlang-interface::||)
cookie (generic function)
:to-name
to-name (generic function)
:message
message (generic function)
A representation of a remote node.
remote-node.lisp (file)
standard-object (class)
:socket
remote-node-socket (generic function)
(common-lisp-erlang-interface::make-atom-cache)
remote-node-atom-cache (generic function)
:port
remote-node-port (generic function)
:node-type
:protocol
0
:highest-version
:lowest-version
The name of the remote node.
:name
remote-node-name (generic function)
:host
remote-node-host (generic function)
:full-name
:extra-field
#()
:group-leader
(quote common-lisp-erlang-interface::|init|)
SEND Control Message.
control-message.lisp (file)
control-message (class)
:cookie
(quote common-lisp-erlang-interface::||)
cookie (generic function)
:to-pid
to-pid (generic function)
:message
message (generic function)
handshake-protocol.lisp (file)
handshake-message (class)
:status
status (generic function)
(setf status) (generic function)
UNLINK Control Message.
control-message.lisp (file)
control-message (class)
:from-pid
from-pid (generic function)
:to-pid
to-pid (generic function)
Previous: Exported definitions, Up: Definitions [Contents][Index]
• Internal constants: | ||
• Internal special variables: | ||
• Internal functions: | ||
• Internal generic functions: | ||
• Internal structures: | ||
• Internal classes: |
Next: Internal special variables, Previous: Internal definitions, Up: Internal definitions [Contents][Index]
control-message.lisp (file)
control-message.lisp (file)
control-message.lisp (file)
control-message.lisp (file)
control-message.lisp (file)
control-message.lisp (file)
control-message.lisp (file)
control-message.lisp (file)
control-message.lisp (file)
control-message.lisp (file)
control-message.lisp (file)
control-message.lisp (file)
handshake.lisp (file)
handshake.lisp (file)
handshake.lisp (file)
handshake.lisp (file)
handshake.lisp (file)
handshake.lisp (file)
handshake.lisp (file)
handshake.lisp (file)
handshake.lisp (file)
handshake.lisp (file)
handshake.lisp (file)
handshake.lisp (file)
handshake.lisp (file)
handshake.lisp (file)
handshake.lisp (file)
distribution-header.lisp (file)
node-protocol.lisp (file)
node-protocol.lisp (file)
Next: Internal functions, Previous: Internal constants, Up: Internal definitions [Contents][Index]
An atom cache.
atom-cache.lisp (file)
The listening socket. NIL if not listening.
listen.lisp (file)
local-node.lisp (file)
local-node.lisp (file)
Remote nodes connected to.
remote-node.lisp (file)
The name and host for this node.
local-node.lisp (file)
Next: Internal generic functions, Previous: Internal special variables, Up: Internal definitions [Contents][Index]
listen.lisp (file)
atom-cache-entries.lisp (file)
atom-cache.lisp (file)
atom-cache.lisp (file)
atom-cache.lisp (file)
atom-cache.lisp (file)
atom-cache.lisp (file)
atom-cache.lisp (file)
atom-cache.lisp (file)
atom-cache.lisp (file)
distribution-header.lisp (file)
md5.lisp (file)
handshake.lisp (file)
atom-cache.lisp (file)
distribution-header.lisp (file)
Decode a sequence of bytes to a Control Message.
control-message.lisp (file)
distribution-header.lisp (file)
distribution-header.lisp (file)
distribution-header.lisp (file)
distribution-header.lisp (file)
handshake.lisp (file)
atom-cache-entries.lisp (file)
remote-node.lisp (file)
Generate a random 32-bit unsigned integer.
handshake.lisp (file)
local-node.lisp (file)
local-node.lisp (file)
atom-cache-entries.lisp (file)
distribution-header.lisp (file)
distribution-header.lisp (file)
atom-cache.lisp (file)
atom-cache-entries.lisp (file)
atom-cache-entries.lisp (file)
control-message.lisp (file)
distribution-header.lisp (file)
remote-node.lisp (file)
handshake.lisp (file)
handshake.lisp (file)
atom-cache.lisp (file)
node-protocol.lisp (file)
remote-node.lisp (file)
remote-node.lisp (file)
node-protocol.lisp (file)
Next: Internal structures, Previous: Internal functions, Up: Internal definitions [Contents][Index]
The collection of cache references.
atom-cache-entries.lisp (file)
Encodes the Control Message to a vector of bytes.
control-message.lisp (file)
automatically generated reader method
handshake-protocol.lisp (file)
automatically generated writer method
handshake-protocol.lisp (file)
listen.lisp (file)
automatically generated reader method
remote-node.lisp (file)
remote-node.lisp (file)
automatically generated reader method
handshake-protocol.lisp (file)
automatically generated writer method
handshake-protocol.lisp (file)
Next: Internal classes, Previous: Internal generic functions, Up: Internal definitions [Contents][Index]
Erlang atom cache
atom-cache.lisp (file)
structure-object (structure)
print-object (method)
(array symbol (8 256))
(make-array (quote (8 256)) :element-type (quote symbol) :initial-element nil)
atom-cache-segments (function)
(setf atom-cache-segments) (function)
Previous: Internal structures, Up: Internal definitions [Contents][Index]
The atom cache collector is used to retrieve already cached
atoms and to collect atom references to be used in a protocol message.
atom-cache-entries.lisp (file)
standard-object (class)
The atom cache used for a node connection.
:atom-cache
The collection of cache references.
:cache-references
(common-lisp-erlang-interface::make-cache-reference-collection)
cache-references (generic function)
control-message.lisp (file)
standard-object (class)
trace-token (method)
:trace-token
trace-token (generic function)
handshake-protocol.lisp (file)
standard-object (class)
:message-length
message-length (generic function)
(setf message-length) (generic function)
:tag
tag (generic function)
(setf tag) (generic function)
Previous: Definitions, Up: Top [Contents][Index]
• Concept index: | ||
• Function index: | ||
• Variable index: | ||
• Data type index: |
Next: Function index, Previous: Indexes, Up: Indexes [Contents][Index]
Jump to: | C F L M |
---|
Jump to: | C F L M |
---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
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 |
---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
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 |
---|
Previous: Variable index, Up: Indexes [Contents][Index]
Jump to: | A C E G H L N P R S T U |
---|
Jump to: | A C E G H L N P R S T U |
---|