The cl-actors Reference Manual

3.1.1 cl-actors/cl-actors.asd

Source

cl-actors.asd.

Parent Component

cl-actors (system).

ASDF Systems

cl-actors.

Packages

cl-actors-asd.

3.1.2 cl-actors/package.lisp

Source

cl-actors.asd.

Parent Component

cl-actors (system).

Packages

cl-actors.

3.1.3 cl-actors/actors.lisp

Dependency

package.lisp (file).

Source

cl-actors.asd.

Parent Component

cl-actors (system).

Public Interface

• behav (macro).
• defactor (macro).
• initialize-instance (method).
• (setf lock) (writer method).
• lock (reader method).
• printer (function).
• send (method).
• stop-actor (method).

Internals

• actor (class).
• behavior (reader method).
• (setf behavior) (writer method).
• curry (function).
• cv (reader method).
• (setf cv) (writer method).
• get-thread (method).
• if-single (function).
• main (method).
• make-actor (function).
• messages (reader method).
• (setf messages) (writer method).
• name (reader method).
• (setf name) (writer method).
• pr (function).
• sink (function).

5.1.1 Macros

Macro: behav (state vars &body body) ¶

Package

cl-actors.

Source

actors.lisp.

Macro: defactor (name state vars &body body) ¶

Package

cl-actors.

Source

actors.lisp.

5.1.2 Ordinary functions

Function: printer (&key self) ¶

Package

cl-actors.

Source

actors.lisp.

5.1.3 Generic functions

Generic Function: send (self &rest message) ¶

Package

cl-actors.

Methods

Method: send ((self actor) &rest message) ¶

Creates a message sending thread which
1. Holds lock to the message (queue)
2. Appends messages (queue) with incoming message 3. Releases lock
4. Notifies the waiting thread that there is a message

Source

actors.lisp.

Generic Function: stop-actor (self) ¶

Package

cl-actors.

Methods

Method: stop-actor ((self actor)) ¶

Stops the actor thread

Source

actors.lisp.

5.1.4 Standalone methods

Method: initialize-instance :after ((self actor) &key) ¶

Uses the main functiona name to create a thread

Source

actors.lisp.

Writer Method: (setf lock) ((actor actor)) ¶

The lock is used when adding a message to the message queue

Package

bordeaux-threads.

Source

actors.lisp.

Target Slot

lock.

Reader Method: lock ((actor actor)) ¶

The lock is used when adding a message to the message queue

Package

bordeaux-threads.

Source

actors.lisp.

Target Slot

lock.

5.2.1 Ordinary functions

Function: curry (f &rest args) ¶

Package

cl-actors.

Source

actors.lisp.

Function: if-single (x) ¶

Package

cl-actors.

Source

actors.lisp.

Function: make-actor (behav name) ¶

Package

cl-actors.

Source

actors.lisp.

Function: pr (x) ¶

Package

cl-actors.

Source

actors.lisp.

Function: sink (&rest args) ¶

Package

cl-actors.

Source

actors.lisp.

5.2.2 Generic functions

Generic Reader: behavior (object) ¶

Generic Writer: (setf behavior) (object) ¶

Package

cl-actors.

Methods

Reader Method: behavior ((actor actor)) ¶

Writer Method: (setf behavior) ((actor actor)) ¶

Behavior

Source

actors.lisp.

Target Slot

behavior.

Generic Reader: cv (object) ¶

Generic Writer: (setf cv) (object) ¶

Package

cl-actors.

Methods

Reader Method: cv ((actor actor)) ¶

Writer Method: (setf cv) ((actor actor)) ¶

conditional variable used by the thread

Source

actors.lisp.

Target Slot

cv.

Generic Function: get-thread (self) ¶

Package

cl-actors.

Methods

Method: get-thread ((self actor)) ¶

Returns the handle of a thread

Source

actors.lisp.

Generic Function: main (self) ¶

Package

cl-actors.

Methods

Method: main ((self actor)) ¶

Source

actors.lisp.

Generic Reader: messages (object) ¶

Generic Writer: (setf messages) (object) ¶

Package

cl-actors.

Methods

Reader Method: messages ((actor actor)) ¶

Writer Method: (setf messages) ((actor actor)) ¶

Message stream sent to actor

Source

actors.lisp.

Target Slot

messages.

Generic Reader: name (object) ¶

Generic Writer: (setf name) (object) ¶

Package

cl-actors.

Methods

Reader Method: name ((actor actor)) ¶

Writer Method: (setf name) ((actor actor)) ¶

Hold the name of actor

Source

actors.lisp.

Target Slot

name.

5.2.3 Classes

Class: actor ¶

Package

cl-actors.

Source

actors.lisp.

Direct methods

• (setf behavior).
• behavior.
• (setf cv).
• cv.
• get-thread.
• initialize-instance.
• (setf lock).
• lock.
• main.
• (setf messages).
• messages.
• (setf name).
• name.
• send.
• stop-actor.

Direct slots

Slot: name ¶

Hold the name of actor

Initform

(error ":name must be specified")

Initargs

:name

Readers

name.

Writers

(setf name).

Slot: behavior ¶

Behavior

Initform

(error ":behav must be specified")

Initargs

:behavior

Readers

behavior.

Writers

(setf behavior).

Slot: messages ¶

Message stream sent to actor

Initform

(quote nil)

Readers

messages.

Writers

(setf messages).

Slot: lock ¶

The lock is used when adding a message to the message queue

Package

bordeaux-threads.

Initform

(bordeaux-threads:make-lock)

Readers

lock.

Writers

(setf lock).

Slot: cv ¶

conditional variable used by the thread

Initform

(bordeaux-threads:make-condition-variable)

Initargs

:cv

Readers

cv.

Writers

(setf cv).

Slot: thread ¶

Package

bordeaux-threads.