cl-epmd

API Reference

epmd

Erlang Port Mapper Daemon client

EPMD-PROTOCOL

EPMD network protocol functions.
  • Class EPMD-REQUEST
    SIZE   Accessor: SIZE
    TAG   Accessor: TAG
  • Function READ-REQUEST (stream)
  • Function WRITE-MESSAGE (stream message)
  • Class ALIVE2-REQUEST  (EPMD-REQUEST)
    PORT   Accessor: PORT
    NODE-TYPE   Accessor: NODE-TYPE
    PROTOCOL   Accessor: PROTOCOL
    HIGHEST-VERSION   Accessor: HIGHEST-VERSION
    LOWEST-VERSION   Accessor: LOWEST-VERSION
    NAME-LENGTH   Accessor: NAME-LENGTH
    NAME   Accessor: NAME
    EXTRA-LENGTH   Accessor: EXTRA-LENGTH
    EXTRA   Accessor: EXTRA
  • Function MAKE-ALIVE2-REQUEST (node-name node-port &key (node-type +node-type-hidden+) (protocol +node-protocol-tcpip4+) (highest-version 5) (lowest-version 5) (extra ""))
  • Class ALIVE2-RESPONSE
    TAG   Accessor: TAG
    RESULT   Accessor: RESULT
    CREATION   Accessor: CREATION
  • Function READ-ALIVE2-RESPONSE (stream)
  • Function MAKE-ALIVE2-RESPONSE (result &optional (creation 0))
  • Class PORT-PLEASE2-REQUEST  (EPMD-REQUEST)
    NODE-NAME   Accessor: NODE-NAME
  • Function MAKE-PORT-PLEASE2-REQUEST (node-name)
  • Class PORT2-RESPONSE
    TAG   Accessor: TAG
    RESULT   Accessor: RESULT
  • Class PORT2-NODE-INFO-RESPONSE  (PORT2-RESPONSE)
    PORT   Accessor: PORT
    NODE-TYPE   Accessor: NODE-TYPE
    PROTOCOL   Accessor: PROTOCOL
    HIGHEST-VERSION   Accessor: HIGHEST-VERSION
    LOWEST-VERSION   Accessor: LOWEST-VERSION
    NAME-LENGTH   Accessor: NAME-LENGTH
    NAME   Accessor: NAME
    EXTRA-LENGTH   Accessor: EXTRA-LENGTH
    EXTRA   Accessor: EXTRA
  • Class PORT2-NULL-RESPONSE  (PORT2-RESPONSE)
    No slots.
  • Function READ-PORT2-RESPONSE (stream)
  • Function MAKE-PORT2-NULL-RESPONSE (&optional (result 1))
  • Function MAKE-PORT2-NODE-INFO-RESPONSE (node-name node-port &key (node-type +node-type-erlang+) (protocol +node-protocol-tcpip4+) (highest-version 5) (lowest-version 5) (extra ""))
  • Class NAMES-REQUEST  (EPMD-REQUEST)
    No slots.
  • Function MAKE-NAMES-REQUEST
  • Class NAMES-RESPONSE
    EPMD-PORT-NUMBER   Accessor: EPMD-PORT-NUMBER
    NODE-INFO   Accessor: NODE-INFO
  • Function READ-NAMES-RESPONSE (stream)
  • Function MAKE-NAMES-RESPONSE (port node-info)
  • Class DUMP-REQUEST  (EPMD-REQUEST)
    No slots.
  • Function MAKE-DUMP-REQUEST
  • Class DUMP-RESPONSE
    EPMD-PORT-NUMBER   Accessor: EPMD-PORT-NUMBER
    NODE-INFO   Accessor: NODE-INFO
  • Function READ-DUMP-RESPONSE (stream)
  • Function MAKE-DUMP-RESPONSE (port node-info)
  • Class KILL-REQUEST  (EPMD-REQUEST)
    No slots.
  • Function MAKE-KILL-REQUEST
  • Class KILL-RESPONSE
    OK-STRING   Accessor: OK-STRING
  • Function READ-KILL-RESPONSE (stream)
  • Function MAKE-KILL-RESPONSE
  • Class STOP-REQUEST  (EPMD-REQUEST)
    NODE-NAME   Accessor: NODE-NAME
  • Function MAKE-STOP-REQUEST (node-name)
  • Class STOP-RESPONSE
    OK-STRING   Accessor: OK-STRING
  • Class STOP-OK-RESPONSE  (STOP-RESPONSE)
    No slots.
  • Class STOP-NOT-OK-RESPONSE  (STOP-RESPONSE)
    No slots.
  • Function READ-STOP-RESPONSE (stream)
  • Function MAKE-STOP-OK-RESPONSE
  • Function MAKE-STOP-NOT-OK-RESPONSE
  • Class NODE-INFO
    NAME   Reader: NODE-NAME
    HOST   Reader: NODE-HOST
    PORT   Reader: NODE-PORT
    NODE-TYPE   Reader: NODE-TYPE
    PROTOCOL   Reader: NODE-PROTOCOL
    HIGHEST-VERSION   Reader: NODE-HIGHEST-VERSION
    LOWEST-VERSION   Reader: NODE-LOWEST-VERSION
    EXTRA-FIELD   Reader: NODE-EXTRA-FIELD

EPMD-COMMON

  • Variable +PORT+
    4369
    The default TCP port the EPMD listens on.

EPMD-CLIENT

EPMD (Erlang Port Mapper Daemon) client.
  • Class EPMD-CONNECTION
    An open connection to an EPMD server held as long as the node is published on that EPMD.
    SOCKET   Reader: EPMD-CONNECTION-SOCKET
    CREATION
    NODE-NAME   Reader: PUBLISHED-NODE-NAME
    NODE-PORT   Reader: PUBLISHED-NODE-PORT
  • Function PUBLISH (node-name listening-port)
  • Function PUBLISHED-P (epmd-connection)
  • Function UNPUBLISH (epmd-connection)
  • Function LOOKUP-NODE (node-name &optional (host "localhost"))
    Query the EPMD about a node. Returns a REMOTE-NODE object that represents the node.
  • Function PRINT-ALL-REGISTERED-NODES (&optional (host "localhost") (stream t))
    Query the EPMD about all registered nodes and print the information.
  • Condition HOST-UNKNOWN-ERROR  (ERROR)
    This error is signaled if the hostname for EPMD is unresolvable.
  • Condition UNREACHABLE-ERROR  (ERROR)
    This error is signaled when the EPMD is unreachable.

Also exports

  • EPMD-PROTOCOL:NODE-EXTRA-FIELD
  • EPMD-PROTOCOL:NODE-NAME
  • EPMD-PROTOCOL:NODE-INFO
  • EPMD-PROTOCOL:NODE-TYPE
  • EPMD-PROTOCOL:NODE-HOST
  • EPMD-PROTOCOL:NODE-HIGHEST-VERSION
  • EPMD-PROTOCOL:NODE-LOWEST-VERSION

EPMD-SERVER

EPMD server.
  • Function START (host)

epmd-test

Unit-tests for cl-epmd.

EPMD-TEST

Unit tests for the EPMD functions.
  • Function RUN-ALL-TESTS