commander/protocol

Table of Contents

System Information

Definition Index

• ORG.SHIRAKUMO.COMMANDER.PROTOCOL

  No documentation provided.

  • EXTERNAL SPECIAL-VARIABLE

    *PRINT-PRETENDING*

    Source

    Whether to print references as the object they stand in for.
    
    If this is bound to true, printing a reference will print the print
    representation of the object it stands for, rather than the actual
    reference syntax.
    
    See REFERENCE

  • EXTERNAL SPECIAL-VARIABLE

    *STANDARD-PORT*

    Source

    The default port used by Commander to communicate over: 4004

  • EXTERNAL CLASS

    VERSION

    Source

    Superclass for all marker classes that define a protocol version.
    
    See ID
    See SERIALIZE
    See DESERIALIZE

  • EXTERNAL STRUCTURE

    IDENTIFIER

    Source

    Representation of an identifier for an object.
    
    This is typically a symbol. Identifiers are used to represent symbols
    that may not have a package or may not be interned on a client system.
    In addition, an identifier also carries a context, in order to
    distinguish between the use-case of the name, such as a function,
    variable, setf function, class, etc.
    
    See MAKE-IDENTIFIER
    See IDENTIFIER
    See IDENTIFIER-PACKAGE
    See IDENTIFIER-NAME
    See IDENTIFIER-CONTEXT
    See IDENTIFIER-SYMBOL
    See DEREFERENCE
    See READ-REPRESENTATION

  • EXTERNAL STRUCTURE

    MESSAGE

    Source

    Base structure representation of a message type.
    
    Message types are "top-level" structures that peers can send to each
    other. The base message type only includes an ID, which must be unique
    only to the sender's context, such that the sender can distinguish a
    reply to that message from other replies that may be sent out of
    order.
    
    By default the message ID is automatically created based on an ID
    counter. You should only ever pass it explicitly if you know what
    you're doing.
    
    See WIREABLE (type)
    See MESSAGE-ID
    See MESSAGE-HANDLED-P
    See ID
    See DEFINE-MESSAGE

  • EXTERNAL STRUCTURE

    POINTER

    Source

    Representation of a remote object.
    
    A pointer is an encapsulation of a unique ID which is associated with
    a particular object resident on a peer. Pointers can be used to
    perform actions on objects on the peer.
    
    See POINTER-ID
    See ID
    See REF=
    See POINTER
    See MAKE-POINTER
    See WIREABLE (type)
    See READ-REPRESENTATION

  • EXTERNAL STRUCTURE

    REFERENCE

    Source

    Representation of a remote object including information on that object.
    
    This is a "thick" pointer to an object on a peer, and includes both
    the real object's type, as well as that object's printed
    representation, allowing the reference to appear as the object would
    on its home peer.
    
    See POINTER (type)
    See REFERENCE
    See DEREFERENCE
    See REFERENCE-PRINTED
    See REFERENCE-TYPE
    See SAFE-PRINT
    See MAKE-REFERENCE
    See CLEAR-REFERENCE
    See WITH-REFERENCES
    See READ-REPRESENTATION

  • EXTERNAL STRUCTURE

    WIREABLE

    Source

    Base structure for any extended object that can be put to the wire.
    
    See DEFINE-WIREABLE
    See WITH-FIELDS
    See SERIALIZE
    See DESERIALIZE
    See SLOTS
    See ENSURE-WIREABLE

  • EXTERNAL FUNCTION

    ACTIVATE-REPRESENTATION-SYNTAX

    • &OPTIONAL
    • READTABLE

    Source

    Installs the representation syntax in the readtable.
    
    See READ-REPRESENTATION

  • EXTERNAL FUNCTION

    CLEAR-REFERENCE

    • OBJECT

    Source

    Remove the reference of the given object.
    
    After this operation any POINTER to the object will return NIL when
    passed to DEREFERENCE.
    
    See POINTER (type)
    See DEREFERENCE

  • EXTERNAL FUNCTION

    DEREFERENCE

    • THING
    • &OPTIONAL
    • DEFAULT

    Source

    Return the object pointed to by the identifier/reference/pointer, if any.
    
    Returns DEFAULT if the THING does not back anything. This may be the
    case even if THING *used* to back something in the past, and the
    object has since been garbage collected or its reference manually
    cleared.
    
    THING can either be an INTEGER (designating the object's unique ID), a
    POINTER, an IDENTIFIER, or NIL. If THING is or resolves to NIL, then
    DEFAULT is returned instead.
    
    See POINTER (type)
    See IDENTIFIER (type)
    See ID
    See REFERENCE
    See CLEAR-REFERENCE

  • EXTERNAL FUNCTION

    DEREFERENCE-RECURSIVELY

    • THING
    • &KEY
    • ON-MISSING

    Source

    Recursively try to resolve references until there are no more left in the tree.
    
    This will only traverse conses and vectors, and will destructively
    modify the tree to replace references.
    
    ON-MISSING governs what happens if an object cannot be resolved and
    may be one of the following:
    
      (eql :IGNORE) --- Keeps the undereferenced object.
      (eql :ERROR)  --- Signals a continuable error with a USE-VALUE
                        restart.
      FUNCTION      --- A function to invoke with the unresolvable object
                        given as an argument. The result will be used to
                        replace the object.
      T             --- An object to use in place of the unresolvable one.
    
    Note that this will not modify the objects being dereferenced, meaning
    if an object references another structure which contains references,
    those references will not be replaced. This is done to ensure that we
    do not accidentally modify data that does not belong to us.
    
    See DEREFERENCE

  • EXTERNAL FUNCTION

    IDENTIFIER

    • SYMBOL
    • &OPTIONAL
    • CONTEXT

    Source

    Construct an identifier for the given symbol and context.
    
    The CONTEXT argument should be either NIL or a keyword symbol
    describing the context in which the name is to be understood. This can
    be technically anything, but useful standard context values are:
    
      :FUNCTION
      :VARIABLE
      :TYPE
      :SETF
      :PACKAGE
      :COMPILER-MACRO
      :METHOD-COMBINATION
    
    See IDENTIFIER (type)

  • EXTERNAL FUNCTION

    IDENTIFIER-CONTEXT

    • INSTANCE

    Source

    Accesses the context of the identifier as a keyword symbol.
    
    See IDENTIFIER
    See IDENTIFIER (type)

  • EXTERNAL FUNCTION

    IDENTIFIER-NAME

    • INSTANCE

    Source

    Accesses the name of the identifier as a string.
    
    See IDENTIFIER (type)

  • EXTERNAL FUNCTION

    IDENTIFIER-PACKAGE

    • INSTANCE

    Source

    Accesses the package name of the identifier as a string.
    
    See IDENTIFIER (type)

  • EXTERNAL FUNCTION

    IDENTIFIER-SYMBOL

    • IDENTIFIER
    • &KEY
    • IF-PACKAGE-DOES-NOT-EXIST
    • IF-DOES-NOT-EXIST

    Source

    Returns the symbol of the given identifier.
    
    If a symbol is passed, the symbol is returned.
    If an IDENTIFIER is passed, and no package with the IDENTIFIER-PACKAGE
    name exists, the behaviour depends on IF-PACKAGE-DOES-NOT-EXIST:
    
      :ERROR    --- An error is signalled
      :CREATE   --- A package with no :USEs is created with that name
      :REPLACE  --- The current *PACKAGE* is used
      NIL       --- NIL is returned
      a PACKAGE --- The given package is used
    
    Once a package has been resolved, and no symbol with the identifier's
    NAME is interned in the package, the behaviour depends on
    IF-DOES-NOT-EXIST:
    
      :ERROR    --- An error is signalled
      :CREATE   --- The name is interned into the package
      a SYMBOL  --- The given symbol is used
    
    The secondary return value is a boolean indicating whether the symbol
    was resolved or not.
    
    See IDENTIFIER (type)

  • EXTERNAL FUNCTION

    MAKE-IDENTIFIER

    • &KEY
    • PACKAGE
    • NAME
    • CONTEXT

    Source

    Construct an identifier instance.
    
    See IDENTIFIER
    See IDENTIFIER (type)

  • EXTERNAL FUNCTION

    MAKE-POINTER

    • &KEY
    • ID

    Source

    Create a new pointer with the given ID.
    
    See MAKE-POINTER-ID
    See POINTER
    See POINTER (type)

  • EXTERNAL FUNCTION

    MAKE-POINTER-ID

    • OBJECT

    Source

    Creates a new unique ID for the given object.
    
    The ID is returned and guaranteed to be unique on this peer. It will
    also be associated with the object to ensure it can be dereferenced.
    
    See POINTER (type)
    See REFERENCE
    See DEREFERENCE

  • EXTERNAL FUNCTION

    MAKE-REFERENCE

    • &KEY
    • ID
    • PRINTED
    • TYPE

    Source

    Create a reference object.
    
    Typically you will want to use the REFERENCE function instead.
    
    See REFERENCE (type)
    See REFERENCE

  • EXTERNAL FUNCTION

    MESSAGE-HANDLED-P

    • INSTANCE

    Source

    Accesses whether the message has been processed yet or not.
    
    See MESSAGE (type)

  • EXTERNAL FUNCTION

    (SETF MESSAGE-HANDLED-P)

    • VALUE
    • INSTANCE

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    MESSAGE-ID

    • INSTANCE

    Source

    Accesses the ID of the message, which must be an (UNSIGNED-BYTE 64).
    
    See MESSAGE (type)
    See ID

  • EXTERNAL FUNCTION

    POINTER

    • OBJECT

    Source

    Shorthand for creating a pointer reference.
    
    See POINTER (type)
    See REFERENCE

  • EXTERNAL FUNCTION

    POINTER-ID

    • INSTANCE

    Source

    Accesses the unique ID integer of the pointer.
    
    You should not set this unless you have a really good idea of what
    you're doing.
    
    See ID
    See POINTER (type)

  • EXTERNAL FUNCTION

    READ-REPRESENTATION

    • STREAM
    • &OPTIONAL
    • C
    • N

    Source

    Reads a representation from the given stream.
    
    The C and N arguments are ignored and are only there for interface
    compatibility with SET-DISPATCH-MACRO-CHARACTER.
    
    If the syntax is valid, an IDENTIFIER, POINTER, or REFERENCE instance is returned.
    If not, an error is signalled.
    
    This syntax is:
    
      REPRESENTATION ::= '#{' REFERENCE | POINTER | IDENTIFIER '}'
      REFERENCE      ::= TYPE '@' ID
      POINTER        ::= '@' ID
      IDENTIFIER     ::= TYPE
      TYPE           ::= (package-name? ':')? symbol-name
      ID             ::= integer
    
    Meaning the following are valid representations:
    
      #{FOO}         => IDENTIFIER
      #{:FOO}        => IDENTIFIER
      #{BAR:FOO}     => IDENTIFIER
      #{@1}          => POINTER
      #{FOO@1}       => REFERENCE
      #{:FOO@1}      => REFERENCE
      #{BAR:FOO@1}   => REFERENCE
    
    See IDENTIFIER (type)
    See REFERENCE (type)
    See POINTER (type)
    See READ-REPRESENTATION-FROM-STRING
    See ACTIVATE-REPRESENTATION-SYNTAX

  • EXTERNAL FUNCTION

    READ-REPRESENTATION-FROM-STRING

    • STRING
    • &KEY
    • START
    • END

    Source

    Convenience function to read a representation in its printed syntax from a string.
    
    See READ-REPRESENTATION

  • EXTERNAL FUNCTION

    REF=

    • POINTER
    • OBJECT

    Source

    Returns true if the given OBJECT is identified by the given POINTER.
    
    This also returns true if both objects are POINTERs with the same ID
    (and thus identify the same object).
    
    See POINTER (type)

  • EXTERNAL FUNCTION

    REFERENCE

    • OBJECT
    • &OPTIONAL
    • TYPE
    • &REST
    • ARGS

    Source

    Create a reference for the given object.
    
    The TYPE can either be REFERENCE (default), POINTER, or the name of a
    constructor function that should return a type of that name. Before
    any constructor is called, the unique ID for the given OBJECT is
    determined via MAKE-POINTER-ID, and then passed on to the constructor
    via the :ID initargs. Any extra ARGS are passed on after.
    
    For REFERENCEs you can customise the TYPE and PRINTED arguments if
    necessary via the respective initargs. If not passed, they are
    automatically determined from the OBJECT via TYPE-OF and SAFE-PRINT
    respectively.
    
    See SAFE-PRINT
    See REFERENCE (type)
    See POINTER (type)

  • EXTERNAL FUNCTION

    REFERENCE-PRINTED

    • INSTANCE

    Source

    Accesses the printed string representation of the referenced object.
    
    See REFERENCE (type)

  • EXTERNAL FUNCTION

    REFERENCE-TYPE

    • INSTANCE

    Source

    Accesses the type name of the referenced object as an identifier.
    
    See REFERENCE (type)
    See IDENTIFIER (type)

  • EXTERNAL FUNCTION

    SAFE-PRINT

    • OBJECT
    • &OPTIONAL
    • ERROR-STRING

    Source

    Returns a printed representation of the object.
    
    If an error occurs during printing, the ERROR-STRING is returned
    instead. Otherwise, the object's PRINC representation is returned.

  • EXTERNAL GENERIC-FUNCTION

    DESERIALIZE

    • VERSION
    • TYPE
    • SOURCE

    Source

    Deserializes an object of TYPE from SOURCE under the VERSION scheme.
    
    TYPE may either be the symbol T to designate "deserialize whichever
    object comes next" or an object which serves as a prototype for the
    type of object to deserialize.
    
    See SERIALIZE
    See VERSION (type)
    See WIREABLE (type)

  • EXTERNAL GENERIC-FUNCTION

    ENSURE-WIREABLE

    • THING
    • VERSION

    Source

    Try to turn THING into a WIREABLE type if possible.
    
    The return value must be a WIREABLE or another type that is supported
    directly by SERIALIZE for the given version of the protocol. By
    default, any object of a not already supported type is turned into one
    by use of REFERENCE.
    
    Users may add methods to this function to handle more specific
    transformations as appropriate.
    
    See WIREABLE (type)
    See SERIALIZE

  • EXTERNAL GENERIC-FUNCTION

    ID

    • VERSION

    Returns a unique identifier of the given object.
    
    See VERSION
    See MESSAGE
    See POINTER

  • EXTERNAL GENERIC-FUNCTION

    SERIALIZE

    • VERSION
    • WIREABLE
    • TARGET

    Source

    Serialize the WIREABLE to the TARGET under the VERSION scheme.
    
    VERSION must be a subclass of ... VERSION.
    WIREABLE must be either a WIREABLE instance, or one of the following
    base types that any encoding VERSION must support:
    
    - STRING
    - NUMBER
    - CHARACTER
    - KEYWORD
    - CONS
    - VECTOR
    
    Any encoding VERSION must support in the very least a binary STREAM as
    the TARGET, but may support other classes of targets.
    
    See DESERIALIZE
    See VERSION (type)
    See WIREABLE (type)

  • EXTERNAL GENERIC-FUNCTION

    SLOTS

    • WIREABLE

    Source

    Returns the slot definitions of the wireable type.
    
    Each slot is a list composed of the NAME, the TYPE, and the INITFORM.
    
    See WIREABLE (type)
    See DEFINE-WIREABLE

  • EXTERNAL MACRO

    DEFINE-MESSAGE

    • NAME
    • &OPTIONAL
    • SLOTS
    • &BODY
    • OPTIONS

    Source

    Shorthand macro to define a message type.
    
    Same as DEFINE-WIREABLE but pre-fills the superclass to be MESSAGE.
    
    See MESSAGE (type)
    See DEFINE-WIREABLE

  • EXTERNAL MACRO

    DEFINE-WIREABLE

    • NAME
    • SLOTS
    • &BODY
    • OPTIONS

    Source

    Macro to define a new wireable type.
    
    This does the following:
    - Define a struct inheriting from WIREABLE
    - Define a SLOTS method to return the given slots on the new type name
    - Define a constructor function
    
    SLOTS should be a list of slot definitions, of the following form:
    
      NAME | (NAME [TYPE [INITFORM]])
    
    If TYPE is not given, it is defaulted to T. If INITFORM is not given,
    the slot is initialized to NIL. If the TYPE is T, the constructor
    function will coerce the given argument via ENSURE-WIREABLE before
    stuffing it into the corresponding slot.
    
    OPTIONS can be alist entries that specify the following:
    - :SUPERCLASS a different superclass to use than WIREABLE
    - :CONSTRUCTOR a different name to use for the constructor function,
      or NIL if no constructor should be defined at all.
    
    See WIREABLE (type)
    See SLOTS

  • EXTERNAL MACRO

    WITH-FIELDS

    • SLOTS
    • VALUE
    • TYPE
    • &BODY
    • BODY

    Source

    Bind the values of a WIREABLE's slots.
    
    VALUE should be a WIREABLE instance. TYPE should be the type of the
    WIREABLE as a symbol. SLOTS should be a list of slot bindings, of the
    following format:
    
      VARIABLE-NAME | (VARIABLE-NAME SLOT-NAME)
    
    The SLOT-NAME may be either the exact symbol naming the slot of the
    wireable, or a string designator that identifies the slot purely by
    name. This means you can typically ignore the package of the wireable
    for purposes of binding its slots with this macro.
    
    See WIREABLE
    See SLOTS

  • EXTERNAL MACRO

    WITH-MESSAGE-CASE

    • VALUE
    • &KEY
    • ETYPECASE
    • &BODY
    • CASES

    Source

    Shorthand to combine TYPECASE with WITH-FIELDS
    
    See WITH-FIELDS

  • EXTERNAL MACRO

    WITH-REFERENCES

    • BINDINGS
    • &BODY
    • BODY

    Source

    Similar to LET but to bind references to objects.
    
    The references are automatically cleared on exit of the BODY.
    Every binding in BINDINGS must be a list of the variable name and the
    value to create a reference to.
    
    See CLEAR-REFERENCE
    See REFERENCE

  • EXTERNAL SOURCE-TRANSFORM

    IDENTIFIER-CONTEXT

    No documentation provided.
  • EXTERNAL SOURCE-TRANSFORM

    (SETF IDENTIFIER-CONTEXT)

    No documentation provided.
  • EXTERNAL SOURCE-TRANSFORM

    IDENTIFIER-NAME

    No documentation provided.
  • EXTERNAL SOURCE-TRANSFORM

    (SETF IDENTIFIER-NAME)

    No documentation provided.
  • EXTERNAL SOURCE-TRANSFORM

    IDENTIFIER-PACKAGE

    No documentation provided.
  • EXTERNAL SOURCE-TRANSFORM

    (SETF IDENTIFIER-PACKAGE)

    No documentation provided.
  • EXTERNAL SOURCE-TRANSFORM

    MESSAGE-HANDLED-P

    No documentation provided.
  • EXTERNAL SOURCE-TRANSFORM

    (SETF MESSAGE-HANDLED-P)

    No documentation provided.
  • EXTERNAL SOURCE-TRANSFORM

    MESSAGE-ID

    No documentation provided.
  • EXTERNAL SOURCE-TRANSFORM

    (SETF MESSAGE-ID)

    No documentation provided.
  • EXTERNAL SOURCE-TRANSFORM

    POINTER-ID

    No documentation provided.
  • EXTERNAL SOURCE-TRANSFORM

    (SETF POINTER-ID)

    No documentation provided.
  • EXTERNAL SOURCE-TRANSFORM

    REFERENCE-PRINTED

    No documentation provided.
  • EXTERNAL SOURCE-TRANSFORM

    (SETF REFERENCE-PRINTED)

    No documentation provided.
  • EXTERNAL SOURCE-TRANSFORM

    REFERENCE-TYPE

    No documentation provided.
  • EXTERNAL SOURCE-TRANSFORM

    (SETF REFERENCE-TYPE)

    No documentation provided.

• ORG.SHIRAKUMO.COMMANDER.PROTOCOL.V1

  No documentation provided.

  • EXTERNAL CLASS

    V1

    Source

    The first version of the Commander protocol.
    
    See ORG.SHIRAKUMO.COMMANDER.PROTOCOL:VERSION

  • EXTERNAL STRUCTURE

    ABORT

    Source

    Requests to abort the execution of the command with the specified ID.
    
    Has the following slots:
      TARGET-ID
    
    This message can only be sent from a client to a server.
    
    See ORG.SHIRAKUMO.COMMANDER.PROTOCOL:MESSAGE

  • EXTERNAL STRUCTURE

    ADVANCE-TO-COLUMN

    Source

    Requests the client to move the cursor to the given column.
    
    Has the following slots:
      COLUMN
    
    See STREAM-MESSAGE

  • EXTERNAL STRUCTURE

    ARGLIST

    Source

    No documentation provided.
  • EXTERNAL STRUCTURE

    CLEAR-INPUT

    Source

    Requests the client to clear all remaining input from the stream.
    
    See STREAM-MESSAGE

  • EXTERNAL STRUCTURE

    CLEAR-OUTPUT

    Source

    Requests the client to clear all output from the stream.
    
    See STREAM-MESSAGE

  • EXTERNAL STRUCTURE

    CLOSE

    Source

    Notifies the client that the given stream has closed.
    
    See STREAM-MESSAGE

  • EXTERNAL STRUCTURE

    CLOSE-REPL

    Source

    No documentation provided.
  • EXTERNAL STRUCTURE

    COMPILE

    Source

    Requests the compilation of a snippet.
    
    Has the following slots:
      FILE
      PACKAGE
    
    This message can only be sent from a client to a server.
    
    See THREAD-MESSAGE

  • EXTERNAL STRUCTURE

    COMPILE-RESULT

    Source

    No documentation provided.
  • EXTERNAL STRUCTURE

    COMPILER-NOTE

    Source

    No documentation provided.
  • EXTERNAL STRUCTURE

    CONNECT

    Source

    Message sent by either peer at the start of the connection.
    
    Has the following slots:
      NAME
      VERSION
      LISP-TYPE
      LISP-VERSION
    
    This message can be sent by any peer.
    
    See ORG.SHIRAKUMO.COMMANDER.PROTOCOL:MESSAGE

  • EXTERNAL STRUCTURE

    DEFINITION

    Source

    No documentation provided.
  • EXTERNAL STRUCTURE

    DEFINITIONS

    Source

    Requests a list of definitions associated with the given reference.
    
    Has the following slots:
      NAME
    
    This message can only be sent from a client to a server.
    
    See ORG.SHIRAKUMO.COMMANDER.PROTOCOL:MESSAGE

  • EXTERNAL STRUCTURE

    DISCONNECT

    Source

    Message sent by either peer at the end of the connection.
    
    This message can be sent by any peer.
    
    See ORG.SHIRAKUMO.COMMANDER.PROTOCOL:MESSAGE

  • EXTERNAL STRUCTURE

    EVAL

    Source

    Requests the evaluation of a Lisp form.
    
    Has the following slots:
      FORM
      PACKAGE
    
    This message can be sent by any peer.
    
    See THREAD-MESSAGE

  • EXTERNAL STRUCTURE

    EVAL-IN-FRAME

    Source

    Requests to evaluate a Lisp form in the given stack frame.
    
    Has the following slots:
      FRAME
    
    This message can only be sent from a client to a server.
    
    See EVAL

  • EXTERNAL STRUCTURE

    EXIT-DEBUGGER

    Source

    No documentation provided.
  • EXTERNAL STRUCTURE

    FAILURE

    Source

    Indicates the command has failed to execute correctly.
    
    Has the following slots:
      MESSAGE
    
    See REPLY

  • EXTERNAL STRUCTURE

    FINISH-OUTPUT

    Source

    Requests the client to flush all output on the stream and wait until it is done before returning.
    
    See STREAM-MESSAGE

  • EXTERNAL STRUCTURE

    FORCE-OUTPUT

    Source

    Requests the client to flush all output on the stream immediately.
    
    See STREAM-MESSAGE

  • EXTERNAL STRUCTURE

    FRAME

    Source

    Representation of a stack frame.
    
    Has the following slots:
      INDEX
      CALL
      ARGUMENTS
      LOCALS
      SOURCE-FILE
      SOURCE-LINE
      SOURCE-FORM
    
    See ORG.SHIRAKUMO.COMMANDER.PROTOCOL:POINTER

  • EXTERNAL STRUCTURE

    FRESH-LINE

    Source

    Requests the client to write a newline to the stream if the stream is not at the start of a line already.
    
    See STREAM-MESSAGE

  • EXTERNAL STRUCTURE

    INDENTATION-RULE

    Source

    Notifies the client that an indentation rule has been defined.
    
    Has the following slots:
      NAME
      RULE
    
    This message can only be sent from the server to a client.
    
    See ORG.SHIRAKUMO.COMMANDER.PROTOCOL:MESSAGE

  • EXTERNAL STRUCTURE

    INVOKE-DEBUGGER

    Source

    Notifies the client that the server has entered a debugger.
    
    Has the following slots:
      CONDITION
      REPORT
      THREAD
    
    This message can only be sent from the server to a client.
    
    See ORG.SHIRAKUMO.COMMANDER.PROTOCOL:MESSAGE

  • EXTERNAL STRUCTURE

    INVOKE-EDITOR

    Source

    Notifies the client that the user requested to edit the given thing.
    
    Has the following slots:
      THING
    
    This message can only be sent from the server to a client.
    
    See ORG.SHIRAKUMO.COMMANDER.PROTOCOL:MESSAGE

  • EXTERNAL STRUCTURE

    INVOKE-INSPECTOR

    Source

    Notifies the client that the user requested to inspect the given thing.
    
    Has the following slots:
      THING
    
    This message can only be sent from the server to a client.
    
    See ORG.SHIRAKUMO.COMMANDER.PROTOCOL:MESSAGE

  • EXTERNAL STRUCTURE

    INVOKE-RESTART

    Source

    Requests to invoke the given restart.
    
    Has the following slots:
      RESTART
      VALUES
    
    This message can only be sent from a client to a server.
    
    See THREAD-MESSAGE

  • EXTERNAL STRUCTURE

    LINE-COLUMN

    Source

    Requests the client to return the current column position of the stream.
    
    See STREAM-MESSAGE

  • EXTERNAL STRUCTURE

    LINE-LENGTH

    Source

    No documentation provided.
  • EXTERNAL STRUCTURE

    LISTEN

    Source

    Requests the client to return true if there are characters to read on the stream.
    
    See STREAM-MESSAGE

  • EXTERNAL STRUCTURE

    MAKE-REPL

    Source

    Requests the server to allocate a new REPL.
    
    Has the following slots:
      NAME
    
    This message can only be sent from a client to a server.
    
    See ORG.SHIRAKUMO.COMMANDER.PROTOCOL:MESSAGE

  • EXTERNAL STRUCTURE

    NEW-STREAM

    Source

    Notifies the client of a new stream that was allocated on the server.
    
    Has the following slots:
      STREAM
      PURPOSE
    
    This message can only be sent from the server to a client.
    
    See ORG.SHIRAKUMO.COMMANDER.PROTOCOL:MESSAGE

  • EXTERNAL STRUCTURE

    OK

    Source

    Indicates the command succeeded.
    
    See REPLY

  • EXTERNAL STRUCTURE

    PEEK-CHAR

    Source

    Requests the client to return the next available character on the stream, if any.
    
    See STREAM-MESSAGE

  • EXTERNAL STRUCTURE

    PING

    Source

    Message to keep the connection alive.
    
    This message can be sent by any peer.
    
    See ORG.SHIRAKUMO.COMMANDER.PROTOCOL:MESSAGE

  • EXTERNAL STRUCTURE

    QUIT

    Source

    Requests the server to stop and exit entirely.
    
    This message can only be sent from a client to a server.
    
    See ORG.SHIRAKUMO.COMMANDER.PROTOCOL:MESSAGE

  • EXTERNAL STRUCTURE

    READ-CHAR

    Source

    Requests the client to read a character from the stream.
    
    See STREAM-MESSAGE

  • EXTERNAL STRUCTURE

    READ-CHAR-NO-HANG

    Source

    Requests the client to read a character or return NIL on hang.
    
    See STREAM-MESSAGE

  • EXTERNAL STRUCTURE

    READ-LINE

    Source

    Requests the client to read a line from the stream.
    
    See STREAM-MESSAGE

  • EXTERNAL STRUCTURE

    READ-SEQUENCE

    Source

    No documentation provided.
  • EXTERNAL STRUCTURE

    REPLY

    Source

    Representation of a response to a command.
    
    Has the following slots:
      REPLY-TO
    
    See ORG.SHIRAKUMO.COMMANDER.PROTOCOL:MESSAGE

  • EXTERNAL STRUCTURE

    RESTART

    Source

    Representation of a restart.
    
    Has the following slots:
      NAME
      REPORT
    
    See ORG.SHIRAKUMO.COMMANDER.PROTOCOL:POINTER

  • EXTERNAL STRUCTURE

    RESTART-FRAME

    Source

    Requests to restart the given stack frame.
    
    Has the following slots:
      FRAME
    
    This message can only be sent from a client to a server.
    
    See THREAD-MESSAGE

  • EXTERNAL STRUCTURE

    RESTARTS

    Source

    Requests a list of currently active restarts.
    
    This message can only be sent from a client to a server.
    
    See THREAD-MESSAGE

  • EXTERNAL STRUCTURE

    RETURN

    Source

    Indicates the command executed correctly and provided return values.
    
    Has the following slots:
      VALUES
    
    See OK

  • EXTERNAL STRUCTURE

    RETURN-FROM-FRAME

    Source

    Requests to return specific values from the given stack frame.
    
    Has the following slots:
      FRAME
      VALUES
    
    This message can only be sent from a client to a server.
    
    See thread-message

  • EXTERNAL STRUCTURE

    SOURCE-LOCATION

    Source

    No documentation provided.
  • EXTERNAL STRUCTURE

    STACK

    Source

    Requests a list of currently active stack frames.
    
    Has the following slots:
      START
      END
    
    This message can only be sent from a client to a server.
    
    See THREAD-MESSAGE

  • EXTERNAL STRUCTURE

    START-LINE-P

    Source

    Requests the client to return whether the stream is at the start of a line or not.
    
    See STREAM-MESSAGE

  • EXTERNAL STRUCTURE

    STOP

    Source

    Requests the server to stop, disconnect everything, and cease accepting new connections.
    
    Unlike QUIT, the server process should not exit, however.  
    
    This message can only be sent from a client to a server.
    
    See ORG.SHIRAKUMO.COMMANDER.PROTOCOL:MESSAGE

  • EXTERNAL STRUCTURE

    STREAM-KIND

    Source

    No documentation provided.
  • EXTERNAL STRUCTURE

    STREAM-MESSAGE

    Source

    Representation of a message dealing with a stream.
    
    Has the following slots:
      STREAM
    
    Messages of this type can only be sent from the server to a client.
    
    See ORG.SHIRAKUMO.COMMANDER.PROTOCOL:MESSAGE

  • EXTERNAL STRUCTURE

    TERPRI

    Source

    Requests the client to write a newline to the stream.
    
    See STREAM-MESSAGE

  • EXTERNAL STRUCTURE

    THREAD

    Source

    Representation of a thread.
    
    Has the following slots:
      TID
      ALIVE-P
      NAME
    
    See ORG.SHIRAKUMO.COMMANDER.PROTOCOL:POINTER

  • EXTERNAL STRUCTURE

    THREAD-MESSAGE

    Source

    Representation of any message specific to a thread.
    
    Has the following slots:
      THREAD
    
    See ORG.SHIRAKUMO.COMMANDER.PROTOCOL:MESSAGE

  • EXTERNAL STRUCTURE

    THREADS

    Source

    Requests a list of currently active threads
    
    This message can only be sent from a client to a server.
    
    See ORG.SHIRAKUMO.COMMANDER.PROTOCOL:MESSAGE

  • EXTERNAL STRUCTURE

    UNREAD-CHAR

    Source

    Requests the client to unread the given char from the stream.
    
    Has the following slots:
      CHARACTER
    
    See STREAM-MESSAGE

  • EXTERNAL STRUCTURE

    WRITE-CHAR

    Source

    Requests the client to write the given character to the stream.
    
    Has the following slots:
      CHARACTER
    
    See STREAM-MESSAGE

  • EXTERNAL STRUCTURE

    WRITE-STRING

    Source

    Requests the client to write the given string to the stream.
    
    Has the following slots:
      STRING
    
    See STREAM-MESSAGE

  • EXTERNAL FUNCTION

    ABORT

    • &KEY
    • ID
    • TARGET-ID

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    ADVANCE-TO-COLUMN

    • &KEY
    • ID
    • STREAM
    • COLUMN

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    ARGLIST

    • &KEY
    • ID
    • THING

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    CLEAR-INPUT

    • &KEY
    • ID
    • STREAM

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    CLEAR-OUTPUT

    • &KEY
    • ID
    • STREAM

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    CLOSE

    • &KEY
    • ID
    • STREAM

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    CLOSE-REPL

    • &KEY
    • ID
    • NAME

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    COMPILE

    • &KEY
    • ID
    • CONTENTS
    • FILE
    • POSITION
    • PACKAGE

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    COMPILE-RESULT

    • &KEY
    • FAILED-P
    • FASL-TRUENAME
    • TIME-TAKEN
    • COMPILER-NOTES

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    COMPILER-NOTE

    • &KEY
    • MESSAGE
    • KIND
    • CONTEXT
    • LOCATION

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    CONNECT

    • &KEY
    • ID
    • NAME
    • VERSION
    • LISP-TYPE
    • LISP-VERSION

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    DEFINITION

    • &KEY
    • ID
    • IDENTIFIER
    • DOCUMENTATION
    • LOCATION

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    DEFINITIONS

    • &KEY
    • ID
    • THING
    • TYPE

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    DISCONNECT

    • &KEY
    • ID

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    EVAL

    • &KEY
    • ID
    • THREAD
    • FORM
    • PACKAGE

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    EVAL-IN-FRAME

    • &KEY
    • ID
    • THREAD
    • FORM
    • PACKAGE
    • FRAME

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    EXIT-DEBUGGER

    • &KEY
    • ID
    • THREAD
    • CONDITION

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    FAILURE

    • &KEY
    • ID
    • REPLY-TO
    • MESSAGE

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    FINISH-OUTPUT

    • &KEY
    • ID
    • STREAM

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    FORCE-OUTPUT

    • &KEY
    • ID
    • STREAM

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    FRAME

    • &KEY
    • ID
    • INDEX
    • CALL
    • ARGUMENTS
    • LOCALS
    • LOCATION

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    FRESH-LINE

    • &KEY
    • ID
    • STREAM

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    INDENTATION-RULE

    • &KEY
    • ID
    • NAME
    • RULE

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    INVOKE-DEBUGGER

    • &KEY
    • ID
    • CONDITION
    • REPORT
    • THREAD
    • LEVEL

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    INVOKE-EDITOR

    • &KEY
    • ID
    • FILE
    • POSITION

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    INVOKE-INSPECTOR

    • &KEY
    • ID
    • THING

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    INVOKE-RESTART

    • &KEY
    • ID
    • THREAD
    • RESTART
    • VALUES

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    LINE-COLUMN

    • &KEY
    • ID
    • STREAM

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    LINE-LENGTH

    • &KEY
    • ID
    • STREAM

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    LISTEN

    • &KEY
    • ID
    • STREAM

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    MAKE-REPL

    • &KEY
    • ID
    • NAME

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    NEW-STREAM

    • &KEY
    • ID
    • STREAM
    • PURPOSE

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    OK

    • &KEY
    • ID
    • REPLY-TO

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    PEEK-CHAR

    • &KEY
    • ID
    • STREAM

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    PING

    • &KEY
    • ID

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    QUIT

    • &KEY
    • ID

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    READ-CHAR

    • &KEY
    • ID
    • STREAM

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    READ-CHAR-NO-HANG

    • &KEY
    • ID
    • STREAM

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    READ-LINE

    • &KEY
    • ID
    • STREAM

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    READ-SEQUENCE

    • &KEY
    • ID
    • STREAM
    • LENGTH

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    REPLY

    • &KEY
    • ID
    • REPLY-TO

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    RESTART

    • &KEY
    • ID
    • NAME
    • REPORT

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    RESTART-FRAME

    • &KEY
    • ID
    • THREAD
    • FRAME

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    RESTARTS

    • &KEY
    • ID
    • THREAD

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    RETURN

    • &KEY
    • ID
    • REPLY-TO
    • VALUES

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    RETURN-FROM-FRAME

    • &KEY
    • ID
    • THREAD
    • FRAME
    • VALUES

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    SOURCE-LOCATION

    • &KEY
    • NAMESTRING
    • LINE
    • COLUMN
    • POSITION
    • PATH
    • OFFSET
    • FORM

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    STACK

    • &KEY
    • ID
    • THREAD
    • START
    • END

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    START-LINE-P

    • &KEY
    • ID
    • STREAM

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    STOP

    • &KEY
    • ID

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    STREAM-KIND

    • &KEY
    • ID
    • STREAM

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    STREAM-MESSAGE

    • &KEY
    • ID
    • STREAM

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    TERPRI

    • &KEY
    • ID
    • STREAM

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    THREAD

    • &KEY
    • ID
    • TID
    • ALIVE-P
    • NAME

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    THREAD-MESSAGE

    • &KEY
    • ID
    • THREAD

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    THREADS

    • &KEY
    • ID

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    UNREAD-CHAR

    • &KEY
    • ID
    • STREAM
    • CHARACTER

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    WRITE-CHAR

    • &KEY
    • ID
    • STREAM
    • CHARACTER

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    WRITE-STRING

    • &KEY
    • ID
    • STREAM
    • STRING

    Source

    No documentation provided.