The cl-myriam Reference Manual

This is the cl-myriam Reference Manual, version 0.1.3, generated automatically by Declt version 4.0 beta 2 "William Riker" on Thu Sep 15 03:59:39 2022 GMT+0.

1 Introduction
2 Systems
- 2.1 cl-myriam
3 Modules
- 3.1 cl-myriam/src
4 Files
- 4.1 Lisp
5 Packages
- 5.1 myriam
6 Definitions
- 6.1 Public Interface
- 6.2 Internals
Appendix A Indexes

1 Introduction

cl-myriam

myriam is a simple attempt at implementing the actor model for secure, distributed programming. Feedback is very welcome!

This is a Common Lisp port of my myriam Chicken Scheme egg. It's already at feature parity with its Scheme sister, aside from the ability to send functions/closures (and obviously, no continuations either), and uses ZMQ instead of NNG for messaging, which means we can make use of CurveZMQ for easier encryption and (some) authentication.

The API is very much unstable at the moment.

Requirements

Myriam stands on the shoulders of giants.

libzmq built with libsodium.
Systems:
- bordeaux-threads
- cl-conspack
- lparallel
- pzmq
- serapeum
- str
- usocket
- sha3

Usage

cl-myriam is on Quicklisp, so you can load it with (ql:quickload :cl-myriam).

Otherwise, you can load the :cl-myriam system directly and require the :myriam package. Everything you need is in there.

Make sure to check the tests folder for examples.

`spawn`

(spawn &rest actions) -> (values string thread)

Spawn an actor and return its address and thread. If no actions are specified, the actor will only react to predefined actions.

`action`

(action name task &optional context) -> action

Create an action for an actor definition. name should be a keyword. task should be a function with any number of arguments (or no arguments). context should be either :sync, :async or :any and defaults to :async; it specifies the context in which a task can be executed, e.g. :sync tasks will be executed synchronously and it's what you'll want if you expect to get a value out of them.

`msg`

(msg head &rest body) -> message

Create a message to be sent to an actor. head should be a keyword corresponding to the name of a task defined in the target actor. Arguments in body, if any, will be passed to the task to be executed.

`send` and `send*`

(send address msg)

(send* address msg) -> (or * (values nil nil))

Send a message to an actor to be executed either in an asynchronous (send) or synchronous (send*) context. msg should correspond in context, task name and number of arguments with the target task.

About identities

Identities encapsulate encryption keys. A self-identity contains both a public and secret key, while a public-identity contains only a public key.

Actors are spawned with the self-identity inside *current-self-identity* (which means that many actors can share the same identity, if you want). Outgoing messages need *target-public-identity* to be set with a public-identity for encryption.

`make-self-identity`

(make-self-identity) -> self-identity

Make a self-identity with a keypair.

`self->public-identity`

(self->public-identity self-id) -> public-identity

Make a public-identity from the public key in self-id.

`with-self-identity`

(with-self-identity id &body body)

Execute body with *current-self-identity* set with self-identity id.

`with-target-identity`

(with-target-identity id &body body)

Execute body with *target-public-identity* set with public-identity id.

Messaging

`ping`

(send address (msg :ping))

Check if an actor is alive.

`stop`

(send address (msg :stop))

Stop an actor.

`store`

(send address (msg :store key datum))

Store datum into an actor's internal storage. key should be a keyword.

`fetch`

(send address (msg :fetch key))

Fetch a value from an actor's internal storage, or nil of there is no such value. key should be a keyword.

`self`

Dynamic variable useful for referring to an actor's self address.

`send-timeout`

Time to wait for a reply before killing the connection.

Authentication

By default, actors accept all incoming messages. You need to spawn an authenticator to filter out connections based on host and identities.

`spawn-authenticator`

(spawn-authenticator accept-p &optional name) -> (values bt:thread name)

Spawn an authenticator (a ZAP server). accept-p should be a predicate which takes an IP address and the public key of the authenticating client (as a byte vector); an incoming connection will be either accepted or rejected based on the result of accept-p. Name shoule be a unique string and it can be used for terminating the authenticator. You can only spawn a single authenticator per context, see below.

`kill authenticator`

(kill-authenticator name)

Kill the given authenticator.

`authenticator-alive-p`

(authenticator-alive-p name) -> boolean

Test if the authenticator with the given name is alive.

Contexts

Contexts allow you to separate actor groups with different authentication parameters. Without contexts, you're limited to one authenticator per application.

(defparameter a
  (myr:with-new-context
    (let ((authenticator (myr:spawn-authenticator
                          (lambda (ip key)
                            (declare (ignore key))
                            (string= ip "127.0.0.1")))))
      (declare (ignore authenticator))
      (myr:spawn))))

In this example, a will only accept connections from localhost.

`with-new-context`

(with-new-context &body forms)

Execute forms in a fresh context. Mostly used to spawn actors under an authenticator with specific parameters.

Utilities

`change-host`

(change-host address new-host) -> valid-address

Replace the host in address for new-host.

`all-actors`

(all-actors) -> list

Get a list of all local actors.

`stop-all-actors`

(stop-all-actors)

Stop all local actors.

Notes

Current limitations/caveats

Sending your own classes inside a message requires you to define the methods encode-object and decode-object. See https://github.com/conspack/cl-conspack#clos-and-general-objects for more details, it's easier than it sounds.
Synchronous messages block execution of an actor for the duration of the task.
No assumptions are made about identity distribution and service (actor) discovery mechanisms.

2 Systems

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

cl-myriam

2.1 `cl-myriam`

Simple actor model implementation for local and remote actors

Author

Ariela Wenner

License

3-clause BSD

Version

0.1.3

Dependencies

babel (system).
bordeaux-threads (system).
cl-conspack (system).
cl-ppcre (system).
lparallel (system).
pzmq (system).
serapeum (system).
str (system).
uuid (system).
usocket (system).
sha3 (system).

Source

cl-myriam.asd.

Child Components

package.lisp (file).
src (module).

3 Modules

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

cl-myriam/src

3.1 `cl-myriam/src`

Dependency

package.lisp (file).

Source

cl-myriam.asd.

Parent Component

cl-myriam (system).

Child Components

utils.lisp (file).
conditions.lisp (file).
address.lisp (file).
identity.lisp (file).
context.lisp (file).
authentication.lisp (file).
messaging.lisp (file).
action.lisp (file).
actors.lisp (file).

4 Files

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

Lisp

4.1.1 `cl-myriam/cl-myriam.asd`

Source: cl-myriam.asd.
Parent Component: cl-myriam (system).
ASDF Systems: cl-myriam.

4.1.2 `cl-myriam/package.lisp`

Source: cl-myriam.asd.
Parent Component: cl-myriam (system).
Packages: myriam.

4.1.3 `cl-myriam/src/utils.lisp`

Source

cl-myriam.asd.

Parent Component

src (module).

Public Interface

all-actors (function).
stop-all-actors (function).

Internals

kernel-setup (function).
string-uuid (function).
with-timeout (macro).

4.1.4 `cl-myriam/src/conditions.lisp`

Source

cl-myriam.asd.

Parent Component

src (module).

Internals

encryption-failed (condition).
invalid-message (condition).
self-identity-not-set (condition).
target-identity-not-set (condition).

4.1.5 `cl-myriam/src/address.lisp`

Source

cl-myriam.asd.

Parent Component

src (module).

Public Interface

change-host (function).

Internals

*address-scanner* (special variable).
address->binding (function).
address-p (function).
address-tokens (function).
make-address (function).
make-random-port (function).
valid-address (type).

4.1.6 `cl-myriam/src/identity.lisp`

Source

cl-myriam.asd.

Parent Component

src (module).

Public Interface

*current-self-identity* (special variable).
*target-public-identity* (special variable).
make-self-identity (function).
public-identity (class).
public-identity-hash (reader method).
(setf public-identity-hash) (writer method).
public-identity-key (reader method).
(setf public-identity-key) (writer method).
self->public-identity (function).
self-identity (class).
self-identity-hash (reader method).
(setf self-identity-hash) (writer method).
self-identity-public-key (reader method).
(setf self-identity-public-key) (writer method).
self-identity-secret-key (reader method).
(setf self-identity-secret-key) (writer method).
with-self-identity (macro).
with-target-identity (macro).

Internals

*trust-store* (special variable).
*trust-store-lock* (special variable).
hash-blob (function).
make-public-identity (function).
store-public-identity (function).

4.1.7 `cl-myriam/src/context.lisp`

Source: cl-myriam.asd.
Parent Component: src (module).
Public Interface: with-new-context (macro).
Internals: *context* (special variable).

4.1.8 `cl-myriam/src/authentication.lisp`

Source

cl-myriam.asd.

Parent Component

src (module).

Public Interface

authenticator-alive-p (function).
kill-authenticator (function).
spawn-authenticator (function).

Internals

authenticator-thread (function).
receive-and-process-auth-request (function).

4.1.9 `cl-myriam/src/messaging.lisp`

Source

cl-myriam.asd.

Parent Component

src (module).

Public Interface

*send-timeout* (special variable).
encode-object (method).
msg (function).
send (function).
send* (function).

Internals

message (class).
message-body (reader method).
(setf message-body) (writer method).
message-context (reader method).
(setf message-context) (writer method).
message-context-p (function).
message-context-t (type).
message-head (reader method).
(setf message-head) (writer method).
post (function).

4.1.10 `cl-myriam/src/action.lisp`

Source

cl-myriam.asd.

Parent Component

src (module).

Public Interface

action (function).
action (class).

Internals

action-context (reader method).
(setf action-context) (writer method).
action-context-p (function).
action-context-t (type).
action-name (reader method).
(setf action-name) (writer method).
action-task (reader method).
(setf action-task) (writer method).

4.1.11 `cl-myriam/src/actors.lisp`

Source

cl-myriam.asd.

Parent Component

src (module).

Public Interface

*print-internal-actor-error-messages* (special variable).
*self* (special variable).
spawn (function).

Internals

*actions* (special variable).
*storage* (special variable).
*storage-lock* (special variable).
actor-loop (function).
fetch-value* (function).
message-handle (function).
store-value* (function).
valid-message-p (function).
valid-predefined-message-p (function).
with-actor-parameters (macro).
wrap-task (function).

5 Packages

Packages are listed by definition order.

myriam

5.1 `myriam`

Source

package.lisp.

Nickname

myr

Use List

common-lisp.

Public Interface

*current-self-identity* (special variable).
*print-internal-actor-error-messages* (special variable).
*self* (special variable).
*send-timeout* (special variable).
*target-public-identity* (special variable).
action (function).
action (class).
all-actors (function).
authenticator-alive-p (function).
change-host (function).
kill-authenticator (function).
make-self-identity (function).
msg (function).
public-identity (class).
public-identity-hash (generic reader).
(setf public-identity-hash) (generic writer).
public-identity-key (generic reader).
(setf public-identity-key) (generic writer).
self->public-identity (function).
self-identity (class).
self-identity-hash (generic reader).
(setf self-identity-hash) (generic writer).
self-identity-public-key (generic reader).
(setf self-identity-public-key) (generic writer).
self-identity-secret-key (generic reader).
(setf self-identity-secret-key) (generic writer).
send (function).
send* (function).
spawn (function).
spawn-authenticator (function).
stop-all-actors (function).
with-new-context (macro).
with-self-identity (macro).
with-target-identity (macro).

Internals

*actions* (special variable).
*address-scanner* (special variable).
*context* (special variable).
*storage* (special variable).
*storage-lock* (special variable).
*trust-store* (special variable).
*trust-store-lock* (special variable).
action-context (generic reader).
(setf action-context) (generic writer).
action-context-p (function).
action-context-t (type).
action-name (generic reader).
(setf action-name) (generic writer).
action-task (generic reader).
(setf action-task) (generic writer).
actor-loop (function).
address->binding (function).
address-p (function).
address-tokens (function).
authenticator-thread (function).
encryption-failed (condition).
fetch-value* (function).
hash-blob (function).
invalid-message (condition).
kernel-setup (function).
make-address (function).
make-public-identity (function).
make-random-port (function).
message (class).
message-body (generic reader).
(setf message-body) (generic writer).
message-context (generic reader).
(setf message-context) (generic writer).
message-context-p (function).
message-context-t (type).
message-handle (function).
message-head (generic reader).
(setf message-head) (generic writer).
post (function).
receive-and-process-auth-request (function).
self-identity-not-set (condition).
store-public-identity (function).
store-value* (function).
string-uuid (function).
target-identity-not-set (condition).
valid-address (type).
valid-message-p (function).
valid-predefined-message-p (function).
with-actor-parameters (macro).
with-timeout (macro).
wrap-task (function).

6 Definitions

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

Public Interface
Internals

6.1 Public Interface

Special variables
Macros
Ordinary functions
Generic functions
Standalone methods
Classes

6.1.1 Special variables

Special Variable: *current-self-identity* ¶

Package: myriam.
Source: identity.lisp.

Special Variable: *print-internal-actor-error-messages* ¶

if not nil, print error messages when they occur inside an actor

Package: myriam.
Source: actors.lisp.

Special Variable: *self* ¶

Package: myriam.
Source: actors.lisp.

Special Variable: *send-timeout* ¶

Package: myriam.
Source: messaging.lisp.

Special Variable: *target-public-identity* ¶

Package: myriam.
Source: identity.lisp.

6.1.2 Macros

Macro: with-new-context (&body body) ¶

Package: myriam.
Source: context.lisp.

Macro: with-self-identity (self-id &rest body) ¶

Package: myriam.
Source: identity.lisp.

Macro: with-target-identity (id &rest body) ¶

Package: myriam.
Source: identity.lisp.

6.1.3 Ordinary functions

Function: action (name task &optional context) ¶

helper to make an instance of an action

Package: myriam.
Source: action.lisp.

Function: all-actors () ¶

Package: myriam.
Source: utils.lisp.

Function: authenticator-alive-p (name) ¶

Package: myriam.
Source: authentication.lisp.

Function: change-host (address new-host) ¶

Package: myriam.
Source: address.lisp.

Function: kill-authenticator (name) ¶

Package: myriam.
Source: authentication.lisp.

Function: make-self-identity () ¶

Package: myriam.
Source: identity.lisp.

Function: msg (head &rest body) ¶

Build a message. head should be a keyword symbol

Package: myriam.
Source: messaging.lisp.

Function: self->public-identity (self-id) ¶

Package: myriam.
Source: identity.lisp.

Function: send (actor msg) ¶

send a message to an actor to perform an asychronous task

Package: myriam.
Source: messaging.lisp.

Function: send* (actor msg) ¶

send a message to an actor to perform a synchronous task and get a result

Package: myriam.
Source: messaging.lisp.

Function: spawn (&rest actions) ¶

spawn an actor, return its address and running thread

Package: myriam.
Source: actors.lisp.

Function: spawn-authenticator (accept-p &optional name) ¶

Spawn an authenticator that will use accept-p (which should be a predicate that takes an IP address and a public key as a byte vector) to either accept or reject incoming connections. Name, if given, should be a unique string.

Package: myriam.
Source: authentication.lisp.

Function: stop-all-actors () ¶

Package: myriam.
Source: utils.lisp.

6.1.4 Generic functions

Generic Reader: public-identity-hash (object) ¶

Package

	Index Entry	Section

(
	`(setf action-context)`:	Private generic functions
	`(setf action-context)`:	Private generic functions
	`(setf action-name)`:	Private generic functions
	`(setf action-name)`:	Private generic functions
	`(setf action-task)`:	Private generic functions
	`(setf action-task)`:	Private generic functions
	`(setf message-body)`:	Private generic functions
	`(setf message-body)`:	Private generic functions
	`(setf message-context)`:	Private generic functions
	`(setf message-context)`:	Private generic functions
	`(setf message-head)`:	Private generic functions
	`(setf message-head)`:	Private generic functions
	`(setf public-identity-hash)`:	Public generic functions
	`(setf public-identity-hash)`:	Public generic functions
	`(setf public-identity-key)`:	Public generic functions
	`(setf public-identity-key)`:	Public generic functions
	`(setf self-identity-hash)`:	Public generic functions
	`(setf self-identity-hash)`:	Public generic functions
	`(setf self-identity-public-key)`:	Public generic functions
	`(setf self-identity-public-key)`:	Public generic functions
	`(setf self-identity-secret-key)`:	Public generic functions
	`(setf self-identity-secret-key)`:	Public generic functions

A
	`action`:	Public ordinary functions
	`action-context`:	Private generic functions
	`action-context`:	Private generic functions
	`action-context-p`:	Private ordinary functions
	`action-name`:	Private generic functions
	`action-name`:	Private generic functions
	`action-task`:	Private generic functions
	`action-task`:	Private generic functions
	`actor-loop`:	Private ordinary functions
	`address->binding`:	Private ordinary functions
	`address-p`:	Private ordinary functions
	`address-tokens`:	Private ordinary functions
	`all-actors`:	Public ordinary functions
	`authenticator-alive-p`:	Public ordinary functions
	`authenticator-thread`:	Private ordinary functions

C
	`change-host`:	Public ordinary functions

E
	`encode-object`:	Public standalone methods

F
	`fetch-value*`:	Private ordinary functions
	`Function, action`:	Public ordinary functions
	`Function, action-context-p`:	Private ordinary functions
	`Function, actor-loop`:	Private ordinary functions
	`Function, address->binding`:	Private ordinary functions
	`Function, address-p`:	Private ordinary functions
	`Function, address-tokens`:	Private ordinary functions
	`Function, all-actors`:	Public ordinary functions
	`Function, authenticator-alive-p`:	Public ordinary functions
	`Function, authenticator-thread`:	Private ordinary functions
	`Function, change-host`:	Public ordinary functions
	`Function, fetch-value*`:	Private ordinary functions
	`Function, hash-blob`:	Private ordinary functions
	`Function, kernel-setup`:	Private ordinary functions
	`Function, kill-authenticator`:	Public ordinary functions
	`Function, make-address`:	Private ordinary functions
	`Function, make-public-identity`:	Private ordinary functions
	`Function, make-random-port`:	Private ordinary functions
	`Function, make-self-identity`:	Public ordinary functions
	`Function, message-context-p`:	Private ordinary functions
	`Function, message-handle`:	Private ordinary functions
	`Function, msg`:	Public ordinary functions
	`Function, post`:	Private ordinary functions
	`Function, receive-and-process-auth-request`:	Private ordinary functions
	`Function, self->public-identity`:	Public ordinary functions
	`Function, send`:	Public ordinary functions
	`Function, send*`:	Public ordinary functions
	`Function, spawn`:	Public ordinary functions
	`Function, spawn-authenticator`:	Public ordinary functions
	`Function, stop-all-actors`:	Public ordinary functions
	`Function, store-public-identity`:	Private ordinary functions
	`Function, store-value*`:	Private ordinary functions
	`Function, string-uuid`:	Private ordinary functions
	`Function, valid-message-p`:	Private ordinary functions
	`Function, valid-predefined-message-p`:	Private ordinary functions
	`Function, wrap-task`:	Private ordinary functions

G
	`Generic Function, (setf action-context)`:	Private generic functions
	`Generic Function, (setf action-name)`:	Private generic functions
	`Generic Function, (setf action-task)`:	Private generic functions
	`Generic Function, (setf message-body)`:	Private generic functions
	`Generic Function, (setf message-context)`:	Private generic functions
	`Generic Function, (setf message-head)`:	Private generic functions
	`Generic Function, (setf public-identity-hash)`:	Public generic functions
	`Generic Function, (setf public-identity-key)`:	Public generic functions
	`Generic Function, (setf self-identity-hash)`:	Public generic functions
	`Generic Function, (setf self-identity-public-key)`:	Public generic functions
	`Generic Function, (setf self-identity-secret-key)`:	Public generic functions
	`Generic Function, action-context`:	Private generic functions
	`Generic Function, action-name`:	Private generic functions
	`Generic Function, action-task`:	Private generic functions
	`Generic Function, message-body`:	Private generic functions
	`Generic Function, message-context`:	Private generic functions
	`Generic Function, message-head`:	Private generic functions
	`Generic Function, public-identity-hash`:	Public generic functions
	`Generic Function, public-identity-key`:	Public generic functions
	`Generic Function, self-identity-hash`:	Public generic functions
	`Generic Function, self-identity-public-key`:	Public generic functions
	`Generic Function, self-identity-secret-key`:	Public generic functions

H
	`hash-blob`:	Private ordinary functions

K
	`kernel-setup`:	Private ordinary functions
	`kill-authenticator`:	Public ordinary functions

M
	`Macro, with-actor-parameters`:	Private macros
	`Macro, with-new-context`:	Public macros
	`Macro, with-self-identity`:	Public macros
	`Macro, with-target-identity`:	Public macros
	`Macro, with-timeout`:	Private macros
	`make-address`:	Private ordinary functions
	`make-public-identity`:	Private ordinary functions
	`make-random-port`:	Private ordinary functions
	`make-self-identity`:	Public ordinary functions
	`message-body`:	Private generic functions
	`message-body`:	Private generic functions
	`message-context`:	Private generic functions
	`message-context`:	Private generic functions
	`message-context-p`:	Private ordinary functions
	`message-handle`:	Private ordinary functions
	`message-head`:	Private generic functions
	`message-head`:	Private generic functions
	`Method, (setf action-context)`:	Private generic functions
	`Method, (setf action-name)`:	Private generic functions
	`Method, (setf action-task)`:	Private generic functions
	`Method, (setf message-body)`:	Private generic functions
	`Method, (setf message-context)`:	Private generic functions
	`Method, (setf message-head)`:	Private generic functions
	`Method, (setf public-identity-hash)`:	Public generic functions
	`Method, (setf public-identity-key)`:	Public generic functions
	`Method, (setf self-identity-hash)`:	Public generic functions
	`Method, (setf self-identity-public-key)`:	Public generic functions
	`Method, (setf self-identity-secret-key)`:	Public generic functions
	`Method, action-context`:	Private generic functions
	`Method, action-name`:	Private generic functions
	`Method, action-task`:	Private generic functions
	`Method, encode-object`:	Public standalone methods
	`Method, message-body`:	Private generic functions
	`Method, message-context`:	Private generic functions
	`Method, message-head`:	Private generic functions
	`Method, public-identity-hash`:	Public generic functions
	`Method, public-identity-key`:	Public generic functions
	`Method, self-identity-hash`:	Public generic functions
	`Method, self-identity-public-key`:	Public generic functions
	`Method, self-identity-secret-key`:	Public generic functions
	`msg`:	Public ordinary functions

P
	`post`:	Private ordinary functions
	`public-identity-hash`:	Public generic functions
	`public-identity-hash`:	Public generic functions
	`public-identity-key`:	Public generic functions
	`public-identity-key`:	Public generic functions

R
	`receive-and-process-auth-request`:	Private ordinary functions

S
	`self->public-identity`:	Public ordinary functions
	`self-identity-hash`:	Public generic functions
	`self-identity-hash`:	Public generic functions
	`self-identity-public-key`:	Public generic functions
	`self-identity-public-key`:	Public generic functions
	`self-identity-secret-key`:	Public generic functions
	`self-identity-secret-key`:	Public generic functions
	`send`:	Public ordinary functions
	`send*`:	Public ordinary functions
	`spawn`:	Public ordinary functions
	`spawn-authenticator`:	Public ordinary functions
	`stop-all-actors`:	Public ordinary functions
	`store-public-identity`:	Private ordinary functions
	`store-value*`:	Private ordinary functions
	`string-uuid`:	Private ordinary functions

V
	`valid-message-p`:	Private ordinary functions
	`valid-predefined-message-p`:	Private ordinary functions

W
	`with-actor-parameters`:	Private macros
	`with-new-context`:	Public macros
	`with-self-identity`:	Public macros
	`with-target-identity`:	Public macros
	`with-timeout`:	Private macros
	`wrap-task`:	Private ordinary functions

	Index Entry	Section

*
	`actions`:	Private special variables
	`address-scanner`:	Private special variables
	`context`:	Private special variables
	`current-self-identity`:	Public special variables
	`print-internal-actor-error-messages`:	Public special variables
	`self`:	Public special variables
	`send-timeout`:	Public special variables
	`storage`:	Private special variables
	`storage-lock`:	Private special variables
	`target-public-identity`:	Public special variables
	`trust-store`:	Private special variables
	`trust-store-lock`:	Private special variables

B
	`body`:	Private classes

C
	`context`:	Public classes
	`context`:	Private classes

H
	`hash`:	Public classes
	`hash`:	Public classes
	`head`:	Private classes

N
	`name`:	Public classes

P
	`public-key`:	Public classes
	`public-key`:	Public classes

S
	`secret-key`:	Public classes
	`Slot, body`:	Private classes
	`Slot, context`:	Public classes
	`Slot, context`:	Private classes
	`Slot, hash`:	Public classes
	`Slot, hash`:	Public classes
	`Slot, head`:	Private classes
	`Slot, name`:	Public classes
	`Slot, public-key`:	Public classes
	`Slot, public-key`:	Public classes
	`Slot, secret-key`:	Public classes
	`Slot, task`:	Public classes
	`Special Variable, actions`:	Private special variables
	`Special Variable, address-scanner`:	Private special variables
	`Special Variable, context`:	Private special variables
	`Special Variable, current-self-identity`:	Public special variables
	`Special Variable, print-internal-actor-error-messages`:	Public special variables
	`Special Variable, self`:	Public special variables
	`Special Variable, send-timeout`:	Public special variables
	`Special Variable, storage`:	Private special variables
	`Special Variable, storage-lock`:	Private special variables
	`Special Variable, target-public-identity`:	Public special variables
	`Special Variable, trust-store`:	Private special variables
	`Special Variable, trust-store-lock`:	Private special variables

T
	`task`:	Public classes

The cl-myriam Reference Manual

The cl-myriam Reference Manual

Table of Contents

1 Introduction

cl-myriam

Requirements

Usage

spawn

action

msg

send and send*

About identities

make-self-identity

self->public-identity

with-self-identity

with-target-identity

Messaging

ping

stop

store

fetch

*self*

*send-timeout*

Authentication

spawn-authenticator

kill authenticator

authenticator-alive-p

Contexts

with-new-context

Utilities

change-host

all-actors

stop-all-actors

Notes

Current limitations/caveats

2 Systems

2.1 cl-myriam

3 Modules

3.1 cl-myriam/src

4 Files

4.1 Lisp

4.1.1 cl-myriam/cl-myriam.asd

4.1.2 cl-myriam/package.lisp

4.1.3 cl-myriam/src/utils.lisp

4.1.4 cl-myriam/src/conditions.lisp

4.1.5 cl-myriam/src/address.lisp

4.1.6 cl-myriam/src/identity.lisp

4.1.7 cl-myriam/src/context.lisp

4.1.8 cl-myriam/src/authentication.lisp

4.1.9 cl-myriam/src/messaging.lisp

4.1.10 cl-myriam/src/action.lisp

4.1.11 cl-myriam/src/actors.lisp

5 Packages

5.1 myriam

6 Definitions

6.1 Public Interface

6.1.1 Special variables

6.1.2 Macros

6.1.3 Ordinary functions

6.1.4 Generic functions

6.1.5 Standalone methods

6.1.6 Classes

6.2 Internals

6.2.1 Special variables

6.2.2 Macros

6.2.3 Ordinary functions

6.2.4 Generic functions

6.2.5 Conditions

6.2.6 Classes

6.2.7 Types

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

`spawn`

`action`

`msg`

`send` and `send*`

`make-self-identity`

`self->public-identity`

`with-self-identity`

`with-target-identity`

`ping`

`stop`

`store`

`fetch`

`self`

`send-timeout`

`spawn-authenticator`

`kill authenticator`

`authenticator-alive-p`

`with-new-context`

`change-host`

`all-actors`

`stop-all-actors`

2.1 `cl-myriam`

3.1 `cl-myriam/src`

4.1.1 `cl-myriam/cl-myriam.asd`

4.1.2 `cl-myriam/package.lisp`

4.1.3 `cl-myriam/src/utils.lisp`

4.1.4 `cl-myriam/src/conditions.lisp`

4.1.5 `cl-myriam/src/address.lisp`

4.1.6 `cl-myriam/src/identity.lisp`

4.1.7 `cl-myriam/src/context.lisp`

4.1.8 `cl-myriam/src/authentication.lisp`

4.1.9 `cl-myriam/src/messaging.lisp`

4.1.10 `cl-myriam/src/action.lisp`

4.1.11 `cl-myriam/src/actors.lisp`

5.1 `myriam`