This is the cl-myriam Reference Manual, version 0.1.3, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 15:29:31 2024 GMT+0.
cl-myriam/cl-myriam.asdcl-myriam/package.lispcl-myriam/src/utils.lispcl-myriam/src/conditions.lispcl-myriam/src/address.lispcl-myriam/src/identity.lispcl-myriam/src/context.lispcl-myriam/src/authentication.lispcl-myriam/src/messaging.lispcl-myriam/src/action.lispcl-myriam/src/actors.lispThe main system appears first, followed by any subsystem dependency.
cl-myriamSimple actor model implementation for local and remote actors
Ariela Wenner
3-clause BSD
0.1.3
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).
package.lisp (file).
src (module).
Modules are listed depth-first from the system components tree.
cl-myriam/srcpackage.lisp (file).
cl-myriam (system).
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).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-myriam/cl-myriam.asdcl-myriam/package.lispcl-myriam/src/utils.lispcl-myriam/src/conditions.lispcl-myriam/src/address.lispcl-myriam/src/identity.lispcl-myriam/src/context.lispcl-myriam/src/authentication.lispcl-myriam/src/messaging.lispcl-myriam/src/action.lispcl-myriam/src/actors.lispcl-myriam/src/utils.lispsrc (module).
all-actors (function).
stop-all-actors (function).
kernel-setup (function).
string-uuid (function).
with-timeout (macro).
cl-myriam/src/conditions.lispsrc (module).
encryption-failed (condition).
invalid-message (condition).
self-identity-not-set (condition).
target-identity-not-set (condition).
cl-myriam/src/address.lispsrc (module).
change-host (function).
*address-scanner* (special variable).
address->binding (function).
address-p (function).
address-tokens (function).
make-address (function).
make-random-port (function).
valid-address (type).
cl-myriam/src/identity.lispsrc (module).
*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).
*trust-store* (special variable).
*trust-store-lock* (special variable).
hash-blob (function).
make-public-identity (function).
store-public-identity (function).
cl-myriam/src/context.lispsrc (module).
with-new-context (macro).
*context* (special variable).
cl-myriam/src/authentication.lispsrc (module).
authenticator-alive-p (function).
kill-authenticator (function).
spawn-authenticator (function).
authenticator-thread (function).
receive-and-process-auth-request (function).
cl-myriam/src/messaging.lispsrc (module).
*send-timeout* (special variable).
decode-object-initialize (method).
encode-object (method).
msg (function).
send (function).
send* (function).
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).
cl-myriam/src/action.lispsrc (module).
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).
cl-myriam/src/actors.lispsrc (module).
*print-internal-actor-error-messages* (special variable).
*self* (special variable).
spawn (function).
*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).
Packages are listed by definition order.
myriammyr
common-lisp.
*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).
*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).
Definitions are sorted by export status, category, package, and then by lexicographic order.
if not nil, print error messages when they occur inside an actor
helper to make an instance of an action
Build a message. head should be a keyword symbol
send a message to an actor to perform an asychronous task
send a message to an actor to perform a synchronous task and get a result
spawn an actor, return its address and running thread
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.
public-identity)) ¶automatically generated reader method
hash.
public-identity)) ¶automatically generated writer method
hash.
public-identity)) ¶automatically generated reader method
public-identity)) ¶automatically generated writer method
self-identity)) ¶automatically generated reader method
hash.
self-identity)) ¶automatically generated writer method
hash.
self-identity)) ¶automatically generated reader method
self-identity)) ¶automatically generated writer method
self-identity)) ¶automatically generated reader method
self-identity)) ¶automatically generated writer method
message) class alist &key &allow-other-keys) ¶conspack.
send a message to an actor
check if this is a valid message in the correct context
check if this is a predefined message with the correct context - we conly care about :fetch for now
wrap task according to its context
Could not encrypt message with keys from our trust store.
error.
An invalid message received/attemped to be sent.
error.
Self identity has not been set.
error.
Target identity has not been set.
error.
| Jump to: | (
A C D E F G H K M P R S V W |
|---|
| Jump to: | (
A C D E F G H K M P R S V W |
|---|
| Jump to: | *
B C H N P S T |
|---|
| Jump to: | *
B C H N P S T |
|---|
| Jump to: | A C E F I M P S T U V |
|---|
| Jump to: | A C E F I M P S T U V |
|---|