The eager-future Reference Manual

Table of Contents

The eager-future Reference Manual

This is the eager-future Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 13:21:30 2020 GMT+0.

1 Systems

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

1.1 eager-future

Dependency

bordeaux-threads

Source

eager-future.asd (file)

Components

• package.lisp (file)
• future.lisp (file)
• threads.lisp (file)
• eager-future.lisp (file)

2 Files

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

2.1 Lisp

2.1.1 eager-future.asd

Location

eager-future.asd

Systems

eager-future (system)

2.1.2 eager-future/package.lisp

Parent

eager-future (system)

Location

package.lisp

Packages

eager-future

2.1.3 eager-future/future.lisp

Dependency

package.lisp (file)

Parent

eager-future (system)

Location

future.lisp

Exported Definitions

• execution-error (method)
• execution-error (condition)
• execution-error-cause (method)
• future (class)
• ready-to-yield? (function)
• select (function)
• yield (function)

Internal Definitions

• done? (method)
• (setf done?) (method)
• make-task (function)
• values-yielded (method)
• wait-list (method)
• (setf wait-list) (method)

2.1.4 eager-future/threads.lisp

Dependency

future.lisp (file)

Parent

eager-future (system)

Location

threads.lisp

Exported Definitions

• *thread-pool* (special variable)
• fixed-fifo-thread-pool (class)
• thread-limit (method)
• (setf thread-limit) (method)
• thread-pool (class)

Internal Definitions

• assign-task (method)
• assign-task (method)
• assign-task (method)
• free-thread-counter (method)
• (setf free-thread-counter) (method)
• leader-notifier (method)
• new-worker-thread (function)
• tasks (method)
• (setf tasks) (method)
• threads (method)
• (setf threads) (method)

2.1.5 eager-future/eager-future.lisp

Dependency

threads.lisp (file)

Parent

eager-future (system)

Location

eager-future.lisp

Exported Definitions

• pcall (function)
• pexec (macro)
• plet (macro)

3 Packages

Packages are listed by definition order.

3.1 eager-future

Source

package.lisp (file)

Use List

• bordeaux-threads
• common-lisp

Exported Definitions

• *thread-pool* (special variable)
• execution-error (generic function)
• execution-error (method)
• execution-error (condition)
• execution-error-cause (generic function)
• execution-error-cause (method)
• fixed-fifo-thread-pool (class)
• future (class)
• pcall (function)
• pexec (macro)
• plet (macro)
• ready-to-yield? (function)
• select (function)
• thread-limit (generic function)
• thread-limit (method)
• (setf thread-limit) (method)
• (setf thread-limit) (generic function)
• thread-pool (class)
• yield (function)

Internal Definitions

• assign-task (generic function)
• assign-task (method)
• assign-task (method)
• assign-task (method)
• done? (generic function)
• done? (method)
• (setf done?) (method)
• (setf done?) (generic function)
• free-thread-counter (generic function)
• free-thread-counter (method)
• (setf free-thread-counter) (method)
• (setf free-thread-counter) (generic function)
• leader-notifier (generic function)
• leader-notifier (method)
• make-task (function)
• new-worker-thread (function)
• tasks (generic function)
• tasks (method)
• (setf tasks) (method)
• (setf tasks) (generic function)
• threads (generic function)
• threads (method)
• (setf threads) (method)
• (setf threads) (generic function)
• values-yielded (generic function)
• values-yielded (method)
• wait-list (generic function)
• wait-list (method)
• (setf wait-list) (method)
• (setf wait-list) (generic function)

4 Definitions

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

4.1 Exported definitions

4.1.1 Special variables

Special Variable: *thread-pool*

Package

eager-future

Source

threads.lisp (file)

4.1.2 Macros

Macro: pexec &body BODY

Package

eager-future

Source

eager-future.lisp (file)

Macro: plet (&rest BINDINGS) &body BODY

Package

eager-future

Source

eager-future.lisp (file)

4.1.3 Functions

Function: pcall THUNK

Package

eager-future

Source

eager-future.lisp (file)

Function: ready-to-yield? FUTURE

Package

eager-future

Source

future.lisp (file)

Function: select &rest FUTURES

Returns the first future that is ready to yield.

Package

eager-future

Source

future.lisp (file)

Function: yield FUTURE

Block until future is ready to yield. If the future yielded an error, it is re-raised as an EXECUTION-ERROR, otherwise the values yielded by the future are returned.

Package

eager-future

Source

future.lisp (file)

4.1.4 Generic functions

Generic Function: execution-error OBJECT

Package

eager-future

Methods

Method: execution-error (FUTURE future)

automatically generated reader method

Source

future.lisp (file)

Generic Function: execution-error-cause CONDITION

Package

eager-future

Methods

Method: execution-error-cause (CONDITION execution-error)

Source

future.lisp (file)

Generic Function: thread-limit OBJECT

Generic Function: (setf thread-limit) NEW-VALUE OBJECT

Package

eager-future

Methods

Method: thread-limit (THREAD-POOL thread-pool)

automatically generated reader method

Source

threads.lisp (file)

Method: (setf thread-limit) NEW-VALUE (THREAD-POOL thread-pool)

automatically generated writer method

Source

threads.lisp (file)

4.1.5 Conditions

Condition: execution-error ()

Package

eager-future

Source

future.lisp (file)

Direct superclasses

error (condition)

Direct methods

• print-object (method)
• execution-error-cause (method)

Direct slots

Slot: cause

Initargs

:cause

Readers

execution-error-cause (generic function)

4.1.6 Classes

Class: fixed-fifo-thread-pool ()

Package

eager-future

Source

threads.lisp (file)

Direct superclasses

thread-pool (class)

Direct methods

assign-task (method)

Class: future ()

Package

eager-future

Source

future.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• wait-list (method)
• wait-list (method)
• values-yielded (method)
• execution-error (method)
• done? (method)
• done? (method)
• lock (method)

Direct slots

Slot: lock

Initform

(bordeaux-threads:make-lock "future lock")

Readers

lock (generic function)

Slot: done?

Readers

done? (generic function)

Writers

(setf done?) (generic function)

Slot: execution-error

Readers

execution-error (generic function)

Slot: values-yielded

Readers

values-yielded (generic function)

Slot: wait-list

Readers

wait-list (generic function)

Writers

(setf wait-list) (generic function)

Class: thread-pool ()

Package

eager-future

Source

threads.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

fixed-fifo-thread-pool (class)

Direct methods

• assign-task (method)
• assign-task (method)
• tasks (method)
• tasks (method)
• leader-notifier (method)
• lock (method)
• thread-limit (method)
• thread-limit (method)
• free-thread-counter (method)
• free-thread-counter (method)
• threads (method)
• threads (method)

Direct slots

Slot: threads

Readers

threads (generic function)

Writers

(setf threads) (generic function)

Slot: free-thread-counter

Initform

0

Readers

free-thread-counter (generic function)

Writers

(setf free-thread-counter) (generic function)

Slot: thread-limit

Readers

thread-limit (generic function)

Writers

(setf thread-limit) (generic function)

Slot: lock

Initform

(bordeaux-threads:make-lock "thread pool lock")

Readers

lock (generic function)

Slot: leader-notifier

Initform

(bordeaux-threads:make-condition-variable)

Readers

leader-notifier (generic function)

Slot: tasks

Readers

tasks (generic function)

Writers

(setf tasks) (generic function)

4.2 Internal definitions

4.2.1 Functions

Function: make-task THUNK FUTURE

Package

eager-future

Source

future.lisp (file)

Function: new-worker-thread THREAD-POOL TASK

Package

eager-future

Source

threads.lisp (file)

4.2.2 Generic functions

Generic Function: assign-task TASK THREAD-POOL

Package

eager-future

Methods

Method: assign-task TASK (THREAD-POOL fixed-fifo-thread-pool)

Source

threads.lisp (file)

Method: assign-task TASK (THREAD-POOL thread-pool)

Source

threads.lisp (file)

Method: assign-task TASK (THREAD-POOL thread-pool) around

Source

threads.lisp (file)

Generic Function: done? OBJECT

Generic Function: (setf done?) NEW-VALUE OBJECT

Package

eager-future

Methods

Method: done? (FUTURE future)

automatically generated reader method

Source

future.lisp (file)

Method: (setf done?) NEW-VALUE (FUTURE future)

automatically generated writer method

Source

future.lisp (file)

Generic Function: free-thread-counter OBJECT

Generic Function: (setf free-thread-counter) NEW-VALUE OBJECT

Package

eager-future

Methods

Method: free-thread-counter (THREAD-POOL thread-pool)

automatically generated reader method

Source

threads.lisp (file)

Method: (setf free-thread-counter) NEW-VALUE (THREAD-POOL thread-pool)

automatically generated writer method

Source

threads.lisp (file)

Generic Function: leader-notifier OBJECT

Package

eager-future

Methods

Method: leader-notifier (THREAD-POOL thread-pool)

automatically generated reader method

Source

threads.lisp (file)

Generic Function: tasks OBJECT

Generic Function: (setf tasks) NEW-VALUE OBJECT

Package

eager-future

Methods

Method: tasks (THREAD-POOL thread-pool)

automatically generated reader method

Source

threads.lisp (file)

Method: (setf tasks) NEW-VALUE (THREAD-POOL thread-pool)

automatically generated writer method

Source

threads.lisp (file)

Generic Function: threads OBJECT

Generic Function: (setf threads) NEW-VALUE OBJECT

Package

eager-future

Methods

Method: threads (THREAD-POOL thread-pool)

automatically generated reader method

Source

threads.lisp (file)

Method: (setf threads) NEW-VALUE (THREAD-POOL thread-pool)

automatically generated writer method

Source

threads.lisp (file)

Generic Function: values-yielded OBJECT

Package

eager-future

Methods

Method: values-yielded (FUTURE future)

automatically generated reader method

Source

future.lisp (file)

Generic Function: wait-list OBJECT

Generic Function: (setf wait-list) NEW-VALUE OBJECT

Package

eager-future

Methods

Method: wait-list (FUTURE future)

automatically generated reader method

Source

future.lisp (file)

Method: (setf wait-list) NEW-VALUE (FUTURE future)

automatically generated writer method

Source

future.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types