The cleric Reference Manual

Table of Contents

The cleric Reference Manual

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.

1 Introduction

CLERIC - Common Lisp Erlang Interface

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.

How to install

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

Dependencies

• cl-epmd
• cl-erlang-term
• usocket
• binary-data
• CL-MD5
• Alexandria

Quicklisp will download and install these libraries automatically when installing CLERIC.

2 Systems

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

2.1 cleric

Author

Markus Flambard <mflambard@common-lisp.net>

License

MIT License

Description

Common Lisp Erlang Interface - An implementation of the Erlang distribution protocol.

Version

0.2.4

Dependencies

• epmd
• erlang-term
• usocket
• md5
• alexandria
• com.gigamonkeys.binary-data

Source

cleric.asd (file)

Component

src (module)

3 Modules

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

3.1 cleric/src

Parent

cleric (system)

Location

src/

Components

• 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)

4 Files

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

4.1 Lisp

4.1.1 cleric.asd

Location

cleric.asd

Systems

cleric (system)

Packages

common-lisp-erlang-interface-system

4.1.2 cleric/src/packages.lisp

Parent

src (module)

Location

src/packages.lisp

Packages

• cleric-epmd-client
• common-lisp-erlang-interface
• cleric-handshake-protocol

4.1.3 cleric/src/listen.lisp

Dependency

packages.lisp (file)

Parent

src (module)

Location

src/listen.lisp

Exported Definitions

• 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)

Internal Definitions

• *listening-socket* (special variable)
• accept-connect (function)
• port (method)

4.1.4 cleric/src/local-node.lisp

Dependency

packages.lisp (file)

Parent

src (module)

Location

src/local-node.lisp

Exported Definitions

• +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)

Internal Definitions

• *pid-id-counter* (special variable)
• *reference-id-counter* (special variable)
• *this-node* (special variable)
• generate-new-pid-id (function)
• generate-new-reference-id (function)

4.1.5 cleric/src/remote-node.lisp

Dependencies

• packages.lisp (file)
• handshake.lisp (file)
• listen.lisp (file)
• local-node.lisp (file)
• atom-cache.lisp (file)

Parent

src (module)

Location

src/remote-node.lisp

Exported Definitions

• connected-remote-nodes (function)
• node-unreachable-error (condition)
• remote-node (class)
• remote-node-accept-connect (function)
• remote-node-connect (function)
• remote-node-host (method)
• remote-node-name (method)
• remote-node-port (method)
• remote-node-socket (method)
• try-connect-again-restart (function)

Internal Definitions

• *remote-nodes* (special variable)
• find-connected-remote-node (function)
• make-remote-node (function)
• register-connected-remote-node (function)
• remote-node-atom-cache (method)
• remote-node-sockets (function)
• socket-stream (method)

4.1.6 cleric/src/atom-cache.lisp

Dependency

packages.lisp (file)

Parent

src (module)

Location

src/atom-cache.lisp

Internal Definitions

• *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 (function)
• copy-atom-cache (function)
• make-atom-cache (function)
• print-atom-cache (function)

4.1.7 cleric/src/atom-cache-entries.lisp

Dependencies

• packages.lisp (file)
• atom-cache.lisp (file)

Parent

src (module)

Location

src/atom-cache-entries.lisp

Internal Definitions

• add-cache-reference (function)
• atom-cache-collector (class)
• cache-references (method)
• find-cache-reference (function)
• get-cache-reference (function)
• make-atom-cache-collector (function)
• make-cache-reference-collection (function)

4.1.8 cleric/src/distribution-header.lisp

Dependencies

• packages.lisp (file)
• atom-cache.lisp (file)

Parent

src (module)

Location

src/distribution-header.lisp

Internal Definitions

• +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)

4.1.9 cleric/src/handshake-protocol.lisp

Dependency

packages.lisp (file)

Parent

src (module)

Location

src/handshake-protocol.lisp

Exported Definitions

• challenge (method)
• (setf challenge) (method)
• challenge (method)
• (setf challenge) (method)
• challenge (class)
• challenge-ack (class)
• challenge-reply (class)
• digest (method)
• (setf digest) (method)
• digest (method)
• (setf digest) (method)
• flags (method)
• (setf flags) (method)
• flags (method)
• (setf flags) (method)
• full-node-name (method)
• (setf full-node-name) (method)
• full-node-name (method)
• (setf full-node-name) (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 (method)
• (setf status) (method)
• status (class)
• version (method)
• (setf version) (method)
• version (method)
• (setf version) (method)
• write-message (function)

Internal Definitions

• handshake-message (class)
• message-length (method)
• (setf message-length) (method)
• tag (method)
• (setf tag) (method)

4.1.10 cleric/src/handshake.lisp

Dependencies

• packages.lisp (file)
• handshake-protocol.lisp (file)
• local-node.lisp (file)
• md5.lisp (file)

Parent

src (module)

Location

src/handshake.lisp

Exported Definitions

• connection-closed-error (condition)
• handshake-failed-error (condition)
• reason (method)
• reason (method)
• try-again (condition)
• try-again-condition-p (function)

Internal Definitions

• +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)

4.1.11 cleric/src/md5.lisp

Dependency

packages.lisp (file)

Parent

src (module)

Location

src/md5.lisp

Internal Definitions

calculate-digest (function)

4.1.12 cleric/src/control-message.lisp

Dependency

packages.lisp (file)

Parent

src (module)

Location

src/control-message.lisp

Exported Definitions

• cookie (method)
• cookie (method)
• exit (class)
• exit2 (class)
• from-pid (method)
• from-pid (method)
• from-pid (method)
• from-pid (method)
• from-pid (method)
• group-leader (class)
• link (class)
• message (method)
• message (method)
• node-link (class)
• reason (method)
• reg-send (class)
• send (class)
• to-name (method)
• to-pid (method)
• to-pid (method)
• to-pid (method)
• to-pid (method)
• to-pid (method)
• trace-token (method)
• unlink (class)

Internal Definitions

• +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)
• encode-control-message (method)
• encode-control-message (method)
• encode-control-message (method)
• encode-control-message (method)
• encode-control-message (method)
• encode-control-message (method)
• encode-control-message (method)
• encode-control-message (method)
• make-control-message (function)

4.1.13 cleric/src/node-protocol.lisp

Dependencies

• packages.lisp (file)
• distribution-header.lisp (file)
• control-message.lisp (file)
• remote-node.lisp (file)

Parent

src (module)

Location

src/node-protocol.lisp

Exported Definitions

• link (function)
• receive-node-messages (function)
• reg-send (function)
• send (function)
• unlink (function)

Internal Definitions

• +pass-through+ (constant)
• +tock+ (constant)
• read-node-message (function)
• write-node-message (function)

5 Packages

Packages are listed by definition order.

5.1 common-lisp-erlang-interface-system

Source

cleric.asd

Nickname

cleric-system

Use List

common-lisp

5.2 cleric-epmd-client

An EPMD (Erlang Port Mapper Daemon) client.

Source

packages.lisp (file)

Nickname

cleric-epmd

Use List

• epmd-client
• common-lisp

5.3 common-lisp-erlang-interface

CLERIC (Common Lisp Erlang Interface) - An implementation of the Erlang distribution protocol.

Source

packages.lisp (file)

Nickname

cleric

Use List

• etf-bops
• erlang-term
• cleric-handshake-protocol
• common-lisp

Exported Definitions

• +highest-version-supported+ (constant)
• +lowest-version-supported+ (constant)
• already-listening-on-socket (condition)
• connected-remote-nodes (function)
• connection-closed-error (condition)
• cookie (generic function)
• cookie (method)
• cookie (method)
• exit (class)
• exit2 (class)
• from-pid (generic function)
• from-pid (method)
• from-pid (method)
• from-pid (method)
• from-pid (method)
• from-pid (method)
• 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 function)
• message (method)
• message (method)
• node-host (function)
• node-link (class)
• node-name (function)
• node-unreachable-error (condition)
• not-listening-on-socket (condition)
• reason (generic function)
• reason (method)
• reason (method)
• reason (method)
• 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 function)
• remote-node-host (method)
• remote-node-name (generic function)
• remote-node-name (method)
• remote-node-port (generic function)
• remote-node-port (method)
• remote-node-socket (generic function)
• remote-node-socket (method)
• 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 function)
• to-name (method)
• to-pid (generic function)
• to-pid (method)
• to-pid (method)
• to-pid (method)
• to-pid (method)
• to-pid (method)
• trace-token (generic function)
• trace-token (method)
• try-again (condition)
• try-again-condition-p (function)
• try-connect-again-restart (function)
• unlink (function)
• unlink (class)

Internal Definitions

• *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 (function)
• atom-length (function)
• cache-references (generic function)
• cache-references (method)
• 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-control-message (method)
• encode-control-message (method)
• encode-control-message (method)
• encode-control-message (method)
• encode-control-message (method)
• encode-control-message (method)
• encode-control-message (method)
• encode-control-message (method)
• 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 function)
• port (method)
• print-atom-cache (function)
• read-node-message (function)
• register-connected-remote-node (function)
• remote-node-atom-cache (generic function)
• remote-node-atom-cache (method)
• remote-node-sockets (function)
• socket-stream (generic function)
• socket-stream (method)
• write-node-message (function)

5.4 cleric-handshake-protocol

Node distribution handshake protocol.

Source

packages.lisp (file)

Use List

• com.gigamonkeys.binary-data.common-datatypes
• com.gigamonkeys.binary-data
• common-lisp

Used By List

common-lisp-erlang-interface

Exported Definitions

• challenge (generic function)
• challenge (method)
• (setf challenge) (method)
• challenge (method)
• (setf challenge) (method)
• (setf challenge) (generic function)
• challenge (class)
• challenge-ack (class)
• challenge-reply (class)
• digest (generic function)
• digest (method)
• (setf digest) (method)
• digest (method)
• (setf digest) (method)
• (setf digest) (generic function)
• flags (generic function)
• flags (method)
• (setf flags) (method)
• flags (method)
• (setf flags) (method)
• (setf flags) (generic function)
• full-node-name (generic function)
• full-node-name (method)
• (setf full-node-name) (method)
• full-node-name (method)
• (setf full-node-name) (method)
• (setf full-node-name) (generic function)
• 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 (generic function)
• status (method)
• (setf status) (method)
• (setf status) (generic function)
• status (class)
• version (generic function)
• version (method)
• (setf version) (method)
• version (method)
• (setf version) (method)
• (setf version) (generic function)
• write-message (function)

Internal Definitions

• handshake-message (class)
• message-length (generic function)
• message-length (method)
• (setf message-length) (method)
• (setf message-length) (generic function)
• tag (generic function)
• tag (method)
• (setf tag) (method)
• (setf tag) (generic function)

6 Definitions

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

6.1 Exported definitions

6.1.1 Constants

Constant: +highest-version-supported+

Highest version of the Erlang distribution protocol supported.

Package

common-lisp-erlang-interface

Source

local-node.lisp (file)

Constant: +lowest-version-supported+

Lowest version of the Erlang distribution protocol supported.

Package

common-lisp-erlang-interface

Source

local-node.lisp (file)

6.1.2 Functions

Function: connected-remote-nodes ()

Package

common-lisp-erlang-interface

Source

remote-node.lisp (file)

Function: link FROM-PID TO-PID

Create a link between two Pids.

Package

common-lisp-erlang-interface

Source

node-protocol.lisp (file)

Function: listening-p ()

Package

common-lisp-erlang-interface

Source

listen.lisp (file)

Function: listening-port ()

Package

common-lisp-erlang-interface

Source

listen.lisp (file)

Function: make-challenge-ack-message DIGEST

Package

cleric-handshake-protocol

Source

handshake-protocol.lisp (file)

Function: make-challenge-message VERSION FLAGS CHALLENGE FULL-NODE-NAME

Package

cleric-handshake-protocol

Source

handshake-protocol.lisp (file)

Function: make-challenge-reply-message CHALLENGE DIGEST

Package

cleric-handshake-protocol

Source

handshake-protocol.lisp (file)

Function: make-name-message VERSION FLAGS FULL-NODE-NAME

Package

cleric-handshake-protocol

Source

handshake-protocol.lisp (file)

Function: make-pid ()

Create a new Erlang PID.

Package

common-lisp-erlang-interface

Source

local-node.lisp (file)

Function: make-reference ()

Create a new Erlang reference.

Package

common-lisp-erlang-interface

Source

local-node.lisp (file)

Function: make-status-message STATUS

Package

cleric-handshake-protocol

Source

handshake-protocol.lisp (file)

Function: node-host NODE-STRING

Return the host part of a node identifier

Package

common-lisp-erlang-interface

Source

local-node.lisp (file)

Function: node-name NODE-STRING

Return the name part of a node identifier

Package

common-lisp-erlang-interface

Source

local-node.lisp (file)

Function: read-challenge-ack-message STREAM

Package

cleric-handshake-protocol

Source

handshake-protocol.lisp (file)

Function: read-challenge-message STREAM

Package

cleric-handshake-protocol

Source

handshake-protocol.lisp (file)

Function: read-challenge-reply-message STREAM

Package

cleric-handshake-protocol

Source

handshake-protocol.lisp (file)

Function: read-name-message STREAM

Package

cleric-handshake-protocol

Source

handshake-protocol.lisp (file)

Function: read-status-message STREAM

Package

cleric-handshake-protocol

Source

handshake-protocol.lisp (file)

Function: receive-node-messages &key TIMEOUT

Waits for and receives messages from connected nodes.

Package

common-lisp-erlang-interface

Source

node-protocol.lisp (file)

Function: reg-send FROM-PID TO-NAME NODE MESSAGE

Send a message to a registered Pid.

Package

common-lisp-erlang-interface

Source

node-protocol.lisp (file)

Function: remote-node-accept-connect COOKIE

Package

common-lisp-erlang-interface

Source

remote-node.lisp (file)

Function: remote-node-connect NODE-INFO COOKIE

Connect and perform handshake with a remote node.

Package

common-lisp-erlang-interface

Source

remote-node.lisp (file)

Function: send TO-PID MESSAGE

Send a message to Pid.

Package

common-lisp-erlang-interface

Source

node-protocol.lisp (file)

Function: start-listening ()

Package

common-lisp-erlang-interface

Source

listen.lisp (file)

Function: start-listening-on-socket-restart CONDITION

Package

common-lisp-erlang-interface

Source

listen.lisp (file)

Function: stop-listening ()

Package

common-lisp-erlang-interface

Source

listen.lisp (file)

Function: this-node ()

Function: (setf this-node) NODE-NAME

Package

common-lisp-erlang-interface

Source

local-node.lisp (file)

Function: try-again-condition-p CONDITION

Package

common-lisp-erlang-interface

Source

handshake.lisp (file)

Function: try-connect-again-restart CONDITION

Package

common-lisp-erlang-interface

Source

remote-node.lisp (file)

Function: unlink FROM-PID TO-PID

Remove a link between two Pids.

Package

common-lisp-erlang-interface

Source

node-protocol.lisp (file)

Function: write-message STREAM MESSAGE

Package

cleric-handshake-protocol

Source

handshake-protocol.lisp (file)

6.1.3 Generic functions

Generic Function: challenge OBJECT

Generic Function: (setf challenge) NEW-VALUE OBJECT

Package

cleric-handshake-protocol

Methods

Method: challenge (CHALLENGE-REPLY challenge-reply)

automatically generated reader method

Source

handshake-protocol.lisp (file)

Method: (setf challenge) NEW-VALUE (CHALLENGE-REPLY challenge-reply)

automatically generated writer method

Source

handshake-protocol.lisp (file)

Method: challenge (CHALLENGE challenge)

automatically generated reader method

Source

handshake-protocol.lisp (file)

Method: (setf challenge) NEW-VALUE (CHALLENGE challenge)

automatically generated writer method

Source

handshake-protocol.lisp (file)

Generic Function: cookie OBJECT

Package

common-lisp-erlang-interface

Methods

Method: cookie (REG-SEND reg-send)

automatically generated reader method

Source

control-message.lisp (file)

Method: cookie (SEND send)

automatically generated reader method

Source

control-message.lisp (file)

Generic Function: digest OBJECT

Generic Function: (setf digest) NEW-VALUE OBJECT

Package

cleric-handshake-protocol

Methods

Method: digest (CHALLENGE-ACK challenge-ack)

automatically generated reader method

Source

handshake-protocol.lisp (file)

Method: (setf digest) NEW-VALUE (CHALLENGE-ACK challenge-ack)

automatically generated writer method

Source

handshake-protocol.lisp (file)

Method: digest (CHALLENGE-REPLY challenge-reply)

automatically generated reader method

Source

handshake-protocol.lisp (file)

Method: (setf digest) NEW-VALUE (CHALLENGE-REPLY challenge-reply)

automatically generated writer method

Source

handshake-protocol.lisp (file)

Generic Function: flags OBJECT

Generic Function: (setf flags) NEW-VALUE OBJECT

Package

cleric-handshake-protocol

Methods

Method: flags (CHALLENGE challenge)

automatically generated reader method

Source

handshake-protocol.lisp (file)

Method: (setf flags) NEW-VALUE (CHALLENGE challenge)

automatically generated writer method

Source

handshake-protocol.lisp (file)

Method: flags (NAME name)

automatically generated reader method

Source

handshake-protocol.lisp (file)

Method: (setf flags) NEW-VALUE (NAME name)

automatically generated writer method

Source

handshake-protocol.lisp (file)

Generic Function: from-pid OBJECT

Package

common-lisp-erlang-interface

Methods

Method: from-pid (GROUP-LEADER group-leader)

automatically generated reader method

Source

control-message.lisp (file)

Method: from-pid (REG-SEND reg-send)

automatically generated reader method

Source

control-message.lisp (file)

Method: from-pid (UNLINK unlink)

automatically generated reader method

Source

control-message.lisp (file)

Method: from-pid (EXIT exit)

automatically generated reader method

Source

control-message.lisp (file)

Method: from-pid (LINK link)

automatically generated reader method

Source

control-message.lisp (file)

Generic Function: full-node-name OBJECT

Generic Function: (setf full-node-name) NEW-VALUE OBJECT

Package

cleric-handshake-protocol

Methods

Method: full-node-name (CHALLENGE challenge)

automatically generated reader method

Source

handshake-protocol.lisp (file)

Method: (setf full-node-name) NEW-VALUE (CHALLENGE challenge)

automatically generated writer method

Source

handshake-protocol.lisp (file)

Method: full-node-name (NAME name)

automatically generated reader method

Source

handshake-protocol.lisp (file)

Method: (setf full-node-name) NEW-VALUE (NAME name)

automatically generated writer method

Source

handshake-protocol.lisp (file)

Generic Function: message OBJECT

Package

common-lisp-erlang-interface

Methods

Method: message (REG-SEND reg-send)

automatically generated reader method

Source

control-message.lisp (file)

Method: message (SEND send)

automatically generated reader method

Source

control-message.lisp (file)

Generic Function: reason CONDITION

Package

common-lisp-erlang-interface

Methods

Method: reason (EXIT exit)

automatically generated reader method

Source

control-message.lisp (file)

Method: reason (CONDITION handshake-failed-error)

Source

handshake.lisp (file)

Method: reason (CONDITION try-again)

Source

handshake.lisp (file)

Generic Function: remote-node-host OBJECT

Package

common-lisp-erlang-interface

Methods

Method: remote-node-host (REMOTE-NODE remote-node)

automatically generated reader method

Source

remote-node.lisp (file)

Generic Function: remote-node-name OBJECT

Package

common-lisp-erlang-interface

Methods

Method: remote-node-name (REMOTE-NODE remote-node)

The name of the remote node.

Source

remote-node.lisp (file)

Generic Function: remote-node-port OBJECT

Package

common-lisp-erlang-interface

Methods

Method: remote-node-port (REMOTE-NODE remote-node)

automatically generated reader method

Source

remote-node.lisp (file)

Generic Function: remote-node-socket OBJECT

Package

common-lisp-erlang-interface

Methods

Method: remote-node-socket (REMOTE-NODE remote-node)

automatically generated reader method

Source

remote-node.lisp (file)

Generic Function: status OBJECT

Generic Function: (setf status) NEW-VALUE OBJECT

Package

cleric-handshake-protocol

Methods

Method: status (STATUS status)

automatically generated reader method

Source

handshake-protocol.lisp (file)

Method: (setf status) NEW-VALUE (STATUS status)

automatically generated writer method

Source

handshake-protocol.lisp (file)

Generic Function: to-name OBJECT

Package

common-lisp-erlang-interface

Methods

Method: to-name (REG-SEND reg-send)

automatically generated reader method

Source

control-message.lisp (file)

Generic Function: to-pid OBJECT

Package

common-lisp-erlang-interface

Methods

Method: to-pid (GROUP-LEADER group-leader)

automatically generated reader method

Source

control-message.lisp (file)

Method: to-pid (UNLINK unlink)

automatically generated reader method

Source

control-message.lisp (file)

Method: to-pid (EXIT exit)

automatically generated reader method

Source

control-message.lisp (file)

Method: to-pid (SEND send)

automatically generated reader method

Source

control-message.lisp (file)

Method: to-pid (LINK link)

automatically generated reader method

Source

control-message.lisp (file)

Generic Function: trace-token OBJECT

Package

common-lisp-erlang-interface

Methods

Method: trace-token (CONTROL-MESSAGE control-message)

automatically generated reader method

Source

control-message.lisp (file)

Generic Function: version OBJECT

Generic Function: (setf version) NEW-VALUE OBJECT

Package

cleric-handshake-protocol

Methods

Method: version (CHALLENGE challenge)

automatically generated reader method

Source

handshake-protocol.lisp (file)

Method: (setf version) NEW-VALUE (CHALLENGE challenge)

automatically generated writer method

Source

handshake-protocol.lisp (file)

Method: version (NAME name)

automatically generated reader method

Source

handshake-protocol.lisp (file)

Method: (setf version) NEW-VALUE (NAME name)

automatically generated writer method

Source

handshake-protocol.lisp (file)

6.1.4 Conditions

Condition: already-listening-on-socket ()

This error is signaled when trying to listen on a socket when already listening on an existing socket.

Package

common-lisp-erlang-interface

Source

listen.lisp (file)

Direct superclasses

error (condition)

Direct methods

port (method)

Direct slots

Slot: port

Initargs

:port

Readers

port (generic function)

Condition: connection-closed-error ()

This error is signaled when trying to read from a socket stream that has been closed.

Package

common-lisp-erlang-interface

Source

handshake.lisp (file)

Direct superclasses

error (condition)

Condition: handshake-failed-error ()

This error is signaled if the handshake during connection to a remote node fails.

Package

common-lisp-erlang-interface

Source

handshake.lisp (file)

Direct superclasses

error (condition)

Direct methods

reason (method)

Direct slots

Slot: reason

Initargs

:reason

Readers

reason (generic function)

Condition: node-unreachable-error ()

This error is signaled when trying to connect to a node that is unreachable.

Package

common-lisp-erlang-interface

Source

remote-node.lisp (file)

Direct superclasses

error (condition)

Condition: not-listening-on-socket ()

This condition is signaled when trying to accept connections with a listening socket.

Package

common-lisp-erlang-interface

Source

listen.lisp (file)

Direct superclasses

error (condition)

Condition: try-again ()

This condition is signaled when trying to connect to a remote node that is busy.

Package

common-lisp-erlang-interface

Source

handshake.lisp (file)

Direct superclasses

condition (condition)

Direct methods

reason (method)

Direct slots

Slot: reason

Initargs

:reason

Readers

reason (generic function)

6.1.5 Classes

Class: challenge ()

Package

cleric-handshake-protocol

Source

handshake-protocol.lisp (file)

Direct superclasses

handshake-message (class)

Direct methods

• write-object (method)
• read-object (method)
• full-node-name (method)
• full-node-name (method)
• challenge (method)
• challenge (method)
• flags (method)
• flags (method)
• version (method)
• version (method)

Direct slots

Slot: version

Initargs

:version

Readers

version (generic function)

Writers

(setf version) (generic function)

Slot: flags

Initargs

:flags

Readers

flags (generic function)

Writers

(setf flags) (generic function)

Slot: challenge

Initargs

:challenge

Readers

challenge (generic function)

Writers

(setf challenge) (generic function)

Slot: full-node-name

Initargs

:full-node-name

Readers

full-node-name (generic function)

Writers

(setf full-node-name) (generic function)

Class: challenge-ack ()

Package

cleric-handshake-protocol

Source

handshake-protocol.lisp (file)

Direct superclasses

handshake-message (class)

Direct methods

• write-object (method)
• read-object (method)
• digest (method)
• digest (method)

Direct slots

Slot: digest

Initargs

:digest

Readers

digest (generic function)

Writers

(setf digest) (generic function)

Class: challenge-reply ()

Package

cleric-handshake-protocol

Source

handshake-protocol.lisp (file)

Direct superclasses

handshake-message (class)

Direct methods

• write-object (method)
• read-object (method)
• digest (method)
• digest (method)
• challenge (method)
• challenge (method)

Direct slots

Slot: challenge

Initargs

:challenge

Readers

challenge (generic function)

Writers

(setf challenge) (generic function)

Slot: digest

Initargs

:digest

Readers

digest (generic function)

Writers

(setf digest) (generic function)

Class: exit ()

EXIT Control Message.

Package

common-lisp-erlang-interface

Source

control-message.lisp (file)

Direct superclasses

control-message (class)

Direct subclasses

exit2 (class)

Direct methods

• encode-control-message (method)
• reason (method)
• to-pid (method)
• from-pid (method)

Direct slots

Slot: from-pid

Initargs

:from-pid

Readers

from-pid (generic function)

Slot: to-pid

Initargs

:to-pid

Readers

to-pid (generic function)

Slot: reason

Initargs

:reason

Readers

reason (generic function)

Class: exit2 ()

EXIT2 Control Message.

Package

common-lisp-erlang-interface

Source

control-message.lisp (file)

Direct superclasses

exit (class)

Direct methods

encode-control-message (method)

Class: group-leader ()

GROUP_LEADER Control Message.

Package

common-lisp-erlang-interface

Source

control-message.lisp (file)

Direct superclasses

control-message (class)

Direct methods

• encode-control-message (method)
• to-pid (method)
• from-pid (method)

Direct slots

Slot: from-pid

Initargs

:from-pid

Readers

from-pid (generic function)

Slot: to-pid

Initargs

:to-pid

Readers

to-pid (generic function)

Class: link ()

LINK Control Message.

Package

common-lisp-erlang-interface

Source

control-message.lisp (file)

Direct superclasses

control-message (class)

Direct methods

• encode-control-message (method)
• to-pid (method)
• from-pid (method)

Direct slots

Slot: from-pid

Initargs

:from-pid

Readers

from-pid (generic function)

Slot: to-pid

Initargs

:to-pid

Readers

to-pid (generic function)

Class: name ()

Package

cleric-handshake-protocol

Source

handshake-protocol.lisp (file)

Direct superclasses

handshake-message (class)

Direct methods

• write-object (method)
• read-object (method)
• full-node-name (method)
• full-node-name (method)
• flags (method)
• flags (method)
• version (method)
• version (method)

Direct slots

Slot: version

Initargs

:version

Readers

version (generic function)

Writers

(setf version) (generic function)

Slot: flags

Initargs

:flags

Readers

flags (generic function)

Writers

(setf flags) (generic function)

Slot: full-node-name

Initargs

:full-node-name

Readers

full-node-name (generic function)

Writers

(setf full-node-name) (generic function)

Class: node-link ()

NODE_LINK Control Message.

Package

common-lisp-erlang-interface

Source

control-message.lisp (file)

Direct superclasses

control-message (class)

Direct methods

encode-control-message (method)

Class: reg-send ()

REG_SEND Control Message.

Package

common-lisp-erlang-interface

Source

control-message.lisp (file)

Direct superclasses

control-message (class)

Direct methods

• encode-control-message (method)
• message (method)
• to-name (method)
• cookie (method)
• from-pid (method)

Direct slots

Slot: from-pid

Initargs

:from-pid

Readers

from-pid (generic function)

Slot: cookie

Initargs

:cookie

Initform

(quote common-lisp-erlang-interface::||)

Readers

cookie (generic function)

Slot: to-name

Initargs

:to-name

Readers

to-name (generic function)

Slot: message

Initargs

:message

Readers

message (generic function)

Class: remote-node ()

A representation of a remote node.

Package

common-lisp-erlang-interface

Source

remote-node.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• socket-stream (method)
• print-object (method)
• remote-node-host (method)
• remote-node-name (method)
• remote-node-port (method)
• remote-node-atom-cache (method)
• remote-node-socket (method)

Direct slots

Slot: socket

Initargs

:socket

Readers

remote-node-socket (generic function)

Slot: atom-cache

Initform

(common-lisp-erlang-interface::make-atom-cache)

Readers

remote-node-atom-cache (generic function)

Slot: port

Initargs

:port

Readers

remote-node-port (generic function)

Slot: node-type

Initargs

:node-type

Slot: protocol

Initargs

:protocol

Initform

0

Slot: highest-version

Initargs

:highest-version

Slot: lowest-version

Initargs

:lowest-version

Slot: name

The name of the remote node.

Initargs

:name

Readers

remote-node-name (generic function)

Slot: host

Initargs

:host

Readers

remote-node-host (generic function)

Slot: full-name

Initargs

:full-name

Slot: extra-field

Initargs

:extra-field

Initform

#()

Slot: group-leader

Initargs

:group-leader

Initform

(quote common-lisp-erlang-interface::|init|)

Class: send ()

SEND Control Message.

Package

common-lisp-erlang-interface

Source

control-message.lisp (file)

Direct superclasses

control-message (class)

Direct methods

• encode-control-message (method)
• message (method)
• to-pid (method)
• cookie (method)

Direct slots

Slot: cookie

Initargs

:cookie

Initform

(quote common-lisp-erlang-interface::||)

Readers

cookie (generic function)

Slot: to-pid

Initargs

:to-pid

Readers

to-pid (generic function)

Slot: message

Initargs

:message

Readers

message (generic function)

Class: status ()

Package

cleric-handshake-protocol

Source

handshake-protocol.lisp (file)

Direct superclasses

handshake-message (class)

Direct methods

• write-object (method)
• read-object (method)
• status (method)
• status (method)

Direct slots

Slot: status

Initargs

:status

Readers

status (generic function)

Writers

(setf status) (generic function)

Class: unlink ()

UNLINK Control Message.

Package

common-lisp-erlang-interface

Source

control-message.lisp (file)

Direct superclasses

control-message (class)

Direct methods

• encode-control-message (method)
• to-pid (method)
• from-pid (method)

Direct slots

Slot: from-pid

Initargs

:from-pid

Readers

from-pid (generic function)

Slot: to-pid

Initargs

:to-pid

Readers

to-pid (generic function)

6.2 Internal definitions

6.2.1 Constants

Constant: +cm-exit+

Package

common-lisp-erlang-interface

Source

control-message.lisp (file)

Constant: +cm-exit-tt+

Package

common-lisp-erlang-interface

Source

control-message.lisp (file)

Constant: +cm-exit2+

Package

common-lisp-erlang-interface

Source

control-message.lisp (file)

Constant: +cm-exit2-tt+

Package

common-lisp-erlang-interface

Source

control-message.lisp (file)

Constant: +cm-group-leader+

Package

common-lisp-erlang-interface

Source

control-message.lisp (file)

Constant: +cm-link+

Package

common-lisp-erlang-interface

Source

control-message.lisp (file)

Constant: +cm-node-link+

Package

common-lisp-erlang-interface

Source

control-message.lisp (file)

Constant: +cm-reg-send+

Package

common-lisp-erlang-interface

Source

control-message.lisp (file)

Constant: +cm-reg-send-tt+

Package

common-lisp-erlang-interface

Source

control-message.lisp (file)

Constant: +cm-send+

Package

common-lisp-erlang-interface

Source

control-message.lisp (file)

Constant: +cm-send-tt+

Package

common-lisp-erlang-interface

Source

control-message.lisp (file)

Constant: +cm-unlink+

Package

common-lisp-erlang-interface

Source

control-message.lisp (file)

Constant: +dflag-atom-cache+

Package

common-lisp-erlang-interface

Source

handshake.lisp (file)

Constant: +dflag-bit-binaries+

Package

common-lisp-erlang-interface

Source

handshake.lisp (file)

Constant: +dflag-dist-hdr-atom-cache+

Package

common-lisp-erlang-interface

Source

handshake.lisp (file)

Constant: +dflag-dist-monitor+

Package

common-lisp-erlang-interface

Source

handshake.lisp (file)

Constant: +dflag-dist-monitor-name+

Package

common-lisp-erlang-interface

Source

handshake.lisp (file)

Constant: +dflag-export-ptr-tag+

Package

common-lisp-erlang-interface

Source

handshake.lisp (file)

Constant: +dflag-extended-pids-ports+

Package

common-lisp-erlang-interface

Source

handshake.lisp (file)

Constant: +dflag-extended-references+

Package

common-lisp-erlang-interface

Source

handshake.lisp (file)

Constant: +dflag-fun-tags+

Package

common-lisp-erlang-interface

Source

handshake.lisp (file)

Constant: +dflag-hidden-atom-cache+

Package

common-lisp-erlang-interface

Source

handshake.lisp (file)

Constant: +dflag-new-floats+

Package

common-lisp-erlang-interface

Source

handshake.lisp (file)

Constant: +dflag-new-fun-tags+

Package

common-lisp-erlang-interface

Source

handshake.lisp (file)

Constant: +dflag-published+

Package

common-lisp-erlang-interface

Source

handshake.lisp (file)

Constant: +dflag-small-atom-tags+

Package

common-lisp-erlang-interface

Source

handshake.lisp (file)

Constant: +dflag-unicode-io+

Package

common-lisp-erlang-interface

Source

handshake.lisp (file)

Constant: +distribution-header-tag+

Package

common-lisp-erlang-interface

Source

distribution-header.lisp (file)

Constant: +pass-through+

Package

common-lisp-erlang-interface

Source

node-protocol.lisp (file)

Constant: +tock+

Package

common-lisp-erlang-interface

Source

node-protocol.lisp (file)

6.2.2 Special variables

Special Variable: *atom-cache*

An atom cache.

Package

common-lisp-erlang-interface

Source

atom-cache.lisp (file)

Special Variable: *listening-socket*

The listening socket. NIL if not listening.

Package

common-lisp-erlang-interface

Source

listen.lisp (file)

Special Variable: *pid-id-counter*

Package

common-lisp-erlang-interface

Source

local-node.lisp (file)

Special Variable: *reference-id-counter*

Package

common-lisp-erlang-interface

Source

local-node.lisp (file)

Special Variable: *remote-nodes*

Remote nodes connected to.

Package

common-lisp-erlang-interface

Source

remote-node.lisp (file)

Special Variable: *this-node*

The name and host for this node.

Package

common-lisp-erlang-interface

Source

local-node.lisp (file)

6.2.3 Functions

Function: accept-connect ()

Package

common-lisp-erlang-interface

Source

listen.lisp (file)

Function: add-cache-reference ATOM NEW-P S-INDEX INTERNAL-S-INDEX COLLECTION

Package

common-lisp-erlang-interface

Source

atom-cache-entries.lisp (file)

Function: atom-cache-add SYMBOL CACHE S-INDEX INTERNAL-S-INDEX

Package

common-lisp-erlang-interface

Source

atom-cache.lisp (file)

Function: atom-cache-add-new SYMBOL CACHE

Package

common-lisp-erlang-interface

Source

atom-cache.lisp (file)

Function: atom-cache-find-free CACHE

Package

common-lisp-erlang-interface

Source

atom-cache.lisp (file)

Function: atom-cache-get CACHE S-INDEX INTERNAL-S-INDEX

Package

common-lisp-erlang-interface

Source

atom-cache.lisp (file)

Function: atom-cache-location-of SYMBOL CACHE

Package

common-lisp-erlang-interface

Source

atom-cache.lisp (file)

Function: atom-cache-p OBJECT

Package

common-lisp-erlang-interface

Source

atom-cache.lisp (file)

Function: atom-cache-print-atoms CACHE &optional STREAM

Package

common-lisp-erlang-interface

Source

atom-cache.lisp (file)

Function: atom-cache-segments INSTANCE

Package

common-lisp-erlang-interface

Source

atom-cache.lisp (file)

Function: atom-length ATOM

Package

common-lisp-erlang-interface

Source

distribution-header.lisp (file)

Function: calculate-digest CHALLENGE COOKIE

Package

common-lisp-erlang-interface

Source

md5.lisp (file)

Function: capability-flags ()

Package

common-lisp-erlang-interface

Source

handshake.lisp (file)

Function: copy-atom-cache INSTANCE

Package

common-lisp-erlang-interface

Source

atom-cache.lisp (file)

Function: decode-atom-cache-ref FLAGS BYTES &optional LONG-ATOMS POS

Package

common-lisp-erlang-interface

Source

distribution-header.lisp (file)

Function: decode-control-message BYTES &key START VERSION-TAG

Decode a sequence of bytes to a Control Message.

Package

common-lisp-erlang-interface

Source

control-message.lisp (file)

Function: decode-distribution-header BYTES &optional POS

Package

common-lisp-erlang-interface

Source

distribution-header.lisp (file)

Function: decode-flags NUMBER-OF-REFS BYTES &optional POS

Package

common-lisp-erlang-interface

Source

distribution-header.lisp (file)

Function: encode-atom-cache-refs ENTRIES

Package

common-lisp-erlang-interface

Source

distribution-header.lisp (file)

Function: encode-flags HALF-BYTES

Package

common-lisp-erlang-interface

Source

distribution-header.lisp (file)

Function: equal-digests D1 D2

Package

common-lisp-erlang-interface

Source

handshake.lisp (file)

Function: find-cache-reference ATOM COLLECTION

Package

common-lisp-erlang-interface

Source

atom-cache-entries.lisp (file)

Function: find-connected-remote-node NODE-NAME

Package

common-lisp-erlang-interface

Source

remote-node.lisp (file)

Function: generate-challenge ()

Generate a random 32-bit unsigned integer.

Package

common-lisp-erlang-interface

Source

handshake.lisp (file)

Function: generate-new-pid-id ()

Package

common-lisp-erlang-interface

Source

local-node.lisp (file)

Function: generate-new-reference-id ()

Package

common-lisp-erlang-interface

Source

local-node.lisp (file)

Function: get-cache-reference REF COLLECTION

Package

common-lisp-erlang-interface

Source

atom-cache-entries.lisp (file)

Function: long-atom-p ATOM

Package

common-lisp-erlang-interface

Source

distribution-header.lisp (file)

Function: long-atoms-p ENTRIES

Package

common-lisp-erlang-interface

Source

distribution-header.lisp (file)

Function: make-atom-cache ()

Package

common-lisp-erlang-interface

Source

atom-cache.lisp (file)

Function: make-atom-cache-collector ATOM-CACHE &optional CACHE-REFERENCES

Package

common-lisp-erlang-interface

Source

atom-cache-entries.lisp (file)

Function: make-cache-reference-collection ()

Package

common-lisp-erlang-interface

Source

atom-cache-entries.lisp (file)

Function: make-control-message TUPLE

Package

common-lisp-erlang-interface

Source

control-message.lisp (file)

Function: make-distribution-header &optional CACHED-ATOMS

Package

common-lisp-erlang-interface

Source

distribution-header.lisp (file)

Function: make-remote-node NODE-INFO

Package

common-lisp-erlang-interface

Source

remote-node.lisp (file)

Function: perform-client-handshake STREAM COOKIE

Package

common-lisp-erlang-interface

Source

handshake.lisp (file)

Function: perform-server-handshake STREAM COOKIE

Package

common-lisp-erlang-interface

Source

handshake.lisp (file)

Function: print-atom-cache CACHE STREAM

Package

common-lisp-erlang-interface

Source

atom-cache.lisp (file)

Function: read-node-message STREAM

Package

common-lisp-erlang-interface

Source

node-protocol.lisp (file)

Function: register-connected-remote-node REMOTE-NODE

Package

common-lisp-erlang-interface

Source

remote-node.lisp (file)

Function: remote-node-sockets ()

Package

common-lisp-erlang-interface

Source

remote-node.lisp (file)

Function: write-node-message CONTROL-MESSAGE STREAM &key DISTRIBUTION-HEADER CACHE-ATOMS

Package

common-lisp-erlang-interface

Source

node-protocol.lisp (file)

6.2.4 Generic functions

Generic Function: cache-references OBJECT

Package

common-lisp-erlang-interface

Methods

Method: cache-references (ATOM-CACHE-COLLECTOR atom-cache-collector)

The collection of cache references.

Source

atom-cache-entries.lisp (file)

Generic Function: encode-control-message CONTROL-MESSAGE &key VERSION-TAG &allow-other-keys

Encodes the Control Message to a vector of bytes.

Package

common-lisp-erlang-interface

Source

control-message.lisp (file)

Methods

Method: encode-control-message (OBJECT exit2) &key &allow-other-keys

Method: encode-control-message (OBJECT group-leader) &key &allow-other-keys

Method: encode-control-message (OBJECT reg-send) &key &allow-other-keys

Method: encode-control-message (OBJECT node-link) &key &allow-other-keys

Method: encode-control-message (OBJECT unlink) &key &allow-other-keys

Method: encode-control-message (OBJECT exit) &key &allow-other-keys

Method: encode-control-message (OBJECT send) &key &allow-other-keys

Method: encode-control-message (OBJECT link) &key &allow-other-keys

Generic Function: message-length OBJECT

Generic Function: (setf message-length) NEW-VALUE OBJECT

Package

cleric-handshake-protocol

Methods

Method: message-length (HANDSHAKE-MESSAGE handshake-message)

automatically generated reader method

Source

handshake-protocol.lisp (file)

Method: (setf message-length) NEW-VALUE (HANDSHAKE-MESSAGE handshake-message)

automatically generated writer method

Source

handshake-protocol.lisp (file)

Generic Function: port CONDITION

Package

common-lisp-erlang-interface

Methods

Method: port (CONDITION already-listening-on-socket)

Source

listen.lisp (file)