The cl-flow Reference Manual

Table of Contents

The cl-flow Reference Manual

This is the cl-flow Reference Manual, version 1.0.0, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:05:24 2018 GMT+0.

1 Introduction

CL-FLOW

Library for asynchonous non-blocking concurrency in Common Lisp.

Documentation

Documentation at borodust.org

Tests

(ql:quickload :cl-flow/tests)
(5am:run! :cl-flow-suite)

2 Systems

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

2.1 cl-flow

Author

Pavel Korolev

Contact

dev@borodust.org

License

MIT

Description

Data-flow driven concurrency model for Common Lisp

Version

1.0.0

Dependencies

• alexandria
• defstar

Source

cl-flow.asd (file)

Components

• packages.lisp (file)
• utils.lisp (file)
• atomic.lisp (file)
• flow.lisp (file)

3 Files

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

3.1 Lisp

3.1.1 cl-flow.asd

Location

cl-flow.asd

Systems

cl-flow (system)

3.1.2 cl-flow/packages.lisp

Parent

cl-flow (system)

Location

packages.lisp

Packages

cl-flow

3.1.3 cl-flow/utils.lisp

Dependency

packages.lisp (file)

Parent

cl-flow (system)

Location

utils.lisp

Internal Definitions

+optimize-form+ (constant)

3.1.4 cl-flow/atomic.lisp

Dependency

utils.lisp (file)

Parent

cl-flow (system)

Location

atomic.lisp

Internal Definitions

• %atomic-decf (macro)
• %make-atomic-counter (function)
• atomic-counter (structure)
• atomic-counter-p (function)
• atomic-counter-value (function)
• (setf atomic-counter-value) (function)
• copy-atomic-counter (function)
• decrement-counter (function)
• make-atomic-counter (function)

3.1.5 cl-flow/flow.lisp

Dependency

atomic.lisp (file)

Parent

cl-flow (system)

Location

flow.lisp

Exported Definitions

• %> (macro)
• ->> (macro)
• >> (macro)
• asynchronously (macro)
• atomically (macro)
• concurrently (macro)
• continue-flow (function)
• dynamically (macro)
• interrupt-flow (function)
• run (function)
• serially (macro)
• ~> (macro)

Internal Definitions

• dispatch-parallel-flow (function)
• dispatch-serial-flow (function)
• flow-lambda (macro)
• invoke-atomically (function)
• invoke-dynamically (function)
• invoke-with-restarts (function)
• nop (function)
• parse-atomic-block-args (function)
• with-body-fu (macro)

4 Packages

Packages are listed by definition order.

4.1 cl-flow

Source

packages.lisp (file)

Nickname

flow

Use List

• defstar
• alexandria.0.dev
• common-lisp

Exported Definitions

• %> (macro)
• ->> (macro)
• >> (macro)
• asynchronously (macro)
• atomically (macro)
• concurrently (macro)
• continue-flow (function)
• dynamically (macro)
• interrupt-flow (function)
• run (function)
• serially (macro)
• ~> (macro)

Internal Definitions

• %atomic-decf (macro)
• %make-atomic-counter (function)
• +optimize-form+ (constant)
• atomic-counter (structure)
• atomic-counter-p (function)
• atomic-counter-value (function)
• (setf atomic-counter-value) (function)
• copy-atomic-counter (function)
• decrement-counter (function)
• dispatch-parallel-flow (function)
• dispatch-serial-flow (function)
• flow-lambda (macro)
• invoke-atomically (function)
• invoke-dynamically (function)
• invoke-with-restarts (function)
• make-atomic-counter (function)
• nop (function)
• parse-atomic-block-args (function)
• with-body-fu (macro)

5 Definitions

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

5.1 Exported definitions

5.1.1 Macros

Macro: %> LAMBDA-LIST &body BODY

See flow:asynchronously

Package

cl-flow

Source

flow.lisp (file)

Macro: ->> LAMBDA-LIST &body BODY

See flow:dynamically

Package

cl-flow

Source

flow.lisp (file)

Macro: >> &rest FLOW

See flow:serially

Package

cl-flow

Source

flow.lisp (file)

Macro: asynchronously LAMBDA-LIST &body BODY

Splits current flow allowing manually managing its execution via #’continue-flow and #’interrupt-flow functions

Package

cl-flow

Source

flow.lisp (file)

Macro: atomically INVARIANT &body ARGS

Encloses atomic flow block of code that could be dispatched concurrently

Package

cl-flow

Source

flow.lisp (file)

Macro: concurrently &rest BODY

Executes child elements in parallel, returning a list of results for child blocks or flows in the same order they were specified

Package

cl-flow

Source

flow.lisp (file)

Macro: dynamically LAMBDA-LIST &body BODY

Generates new flow dynamically during parent flow execution. In other words, injects new dynamically created flow into a current one.

Package

cl-flow

Source

flow.lisp (file)

Macro: serially &rest FLOW

Executes child elements serially (but possibly in different threads) returning a value of the last atomic block or flow

Package

cl-flow

Source

flow.lisp (file)

Macro: ~> &rest BODY

See flow:concurrently

Package

cl-flow

Source

flow.lisp (file)

5.1.2 Functions

Function: continue-flow &optional VALUE

Invokes next flow block with provided value as an argument

Package

cl-flow

Source

flow.lisp (file)

Function: interrupt-flow CONDITION

Interrupts flow with provided condition

Package

cl-flow

Source

flow.lisp (file)

Function: run ()

Dispatcher must be a function with lambda-list congruent to (task invariant &key &allow-other-keys)

Package

cl-flow

Source

flow.lisp (file)

5.2 Internal definitions

5.2.1 Constants

Constant: +optimize-form+

Package

cl-flow

Source

utils.lisp (file)

5.2.2 Macros

Macro: %atomic-decf PLACE

Atomically decrement the value of PLACE. For CCL, SBCL, and LW, it should be an accessor form for a struct slot holding an integer.

Package

cl-flow

Source

atomic.lisp (file)

Macro: flow-lambda (DISPATCHER RESULT-CALLBACK ARG) &body BODY

Package

cl-flow

Source

flow.lisp (file)

Macro: with-body-fu (FU-NAME LAMBDA-LIST FU-BODY) &body BODY

Package

cl-flow

Source

flow.lisp (file)

5.2.3 Functions

Function: %make-atomic-counter VALUE

Package

cl-flow

Source

atomic.lisp (file)

Function: atomic-counter-p OBJECT

Package

cl-flow

Source

atomic.lisp (file)

Function: atomic-counter-value INSTANCE

Function: (setf atomic-counter-value) VALUE INSTANCE

Package

cl-flow

Source

atomic.lisp (file)

Function: copy-atomic-counter INSTANCE

Package

cl-flow

Source

atomic.lisp (file)

Function: decrement-counter COUNTER

Returns previous value

Package

cl-flow

Source

atomic.lisp (file)

Function: dispatch-parallel-flow ()

Package

cl-flow

Source

flow.lisp (file)

Function: dispatch-serial-flow ()

Package

cl-flow

Source

flow.lisp (file)

Function: invoke-atomically ()

Package

cl-flow

Source

flow.lisp (file)

Function: invoke-dynamically ()

Package

cl-flow

Source

flow.lisp (file)

Function: invoke-with-restarts ()

Package

cl-flow

Source

flow.lisp (file)

Function: make-atomic-counter &optional VALUE

Package

cl-flow

Source

atomic.lisp (file)

Function: nop ()

Package

cl-flow

Source

flow.lisp (file)

Function: parse-atomic-block-args ARGS

Package

cl-flow

Source

flow.lisp (file)

5.2.4 Structures

Structure: atomic-counter ()

Package

cl-flow

Source

atomic.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: value

Type

(unsigned-byte 64)

Initform

0

Readers

atomic-counter-value (function)

Writers

(setf atomic-counter-value) (function)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types