The simple-flow-dispatcher Reference Manual

Table of Contents

The simple-flow-dispatcher Reference Manual

This is the simple-flow-dispatcher Reference Manual, version 1.0.0, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 12:34:39 2018 GMT+0.

1 Introduction

simple-flow-dispatcher

Simple implementation of a flow dispatcher for cl-flow library. Handles invariants correctly, but doesn't accept any additional parameters.

2 Systems

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

2.1 simple-flow-dispatcher

Author

Pavel Korolev

Contact

dev@borodust.org

License

MIT

Description

Reference implementation of a dispatcher for cl-flow library

Version

1.0.0

Dependencies

• alexandria
• cl-muth

Source

simple-flow-dispatcher.asd (file)

Components

• packages.lisp (file)
• atomic.lisp (file)
• dispatcher.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 simple-flow-dispatcher.asd

Location

simple-flow-dispatcher.asd

Systems

simple-flow-dispatcher (system)

3.1.2 simple-flow-dispatcher/packages.lisp

Parent

simple-flow-dispatcher (system)

Location

packages.lisp

Packages

simple-flow-dispatcher

3.1.3 simple-flow-dispatcher/atomic.lisp

Dependency

packages.lisp (file)

Parent

simple-flow-dispatcher (system)

Location

atomic.lisp

Internal Definitions

• %compare-and-swap (macro)
• +cas-sleep+ (constant)
• acquire-spin-lock (function)
• copy-spin-lock (function)
• make-spin-lock (function)
• release-spin-lock (function)
• spin-lock (structure)
• spin-lock-owned (function)
• (setf spin-lock-owned) (function)
• spin-lock-p (function)
• with-spin-lock-held (macro)

3.1.4 simple-flow-dispatcher/dispatcher.lisp

Dependency

atomic.lisp (file)

Parent

simple-flow-dispatcher (system)

Location

dispatcher.lisp

Exported Definitions

• free-simple-dispatcher (function)
• make-simple-dispatcher (function)

Internal Definitions

• clear-tagged-queue (function)
• dispatch-with (function)
• invoke-directly (function)
• peek-task (function)
• pop-task (function)
• push-task (function)
• simple-dispatcher (class)
• simple-dispatcher-instance-alive-p (function)
• tagged-queue (class)

4 Packages

Packages are listed by definition order.

4.1 simple-flow-dispatcher

Source

packages.lisp (file)

Use List

• alexandria.0.dev
• common-lisp

Exported Definitions

• free-simple-dispatcher (function)
• make-simple-dispatcher (function)

Internal Definitions

• %compare-and-swap (macro)
• *dispatcher* (special variable)
• +cas-sleep+ (constant)
• acquire-spin-lock (function)
• clear-tagged-queue (function)
• copy-spin-lock (function)
• dispatch-with (function)
• invoke-directly (function)
• make-spin-lock (function)
• peek-task (function)
• pop-task (function)
• push-task (function)
• release-spin-lock (function)
• simple-dispatcher (class)
• simple-dispatcher-instance-alive-p (function)
• spin-lock (structure)
• spin-lock-owned (function)
• (setf spin-lock-owned) (function)
• spin-lock-p (function)
• tagged-queue (class)
• with-spin-lock-held (macro)

5 Definitions

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

5.1 Exported definitions

5.1.1 Functions

Function: free-simple-dispatcher SIMPLE-DISPATCHER

Release resources acquired by the dispatcher

Package

simple-flow-dispatcher

Source

dispatcher.lisp (file)

Function: make-simple-dispatcher &key THREADS ERROR-HANDLER INVOKER

Makes simple thread-safe cl-flow dispatcher that can handle single invariants. For invariants to be considered the same they must be EQ. For example:

(-> :guarded ()
(do-some-work))

While this flow block is running other blocks with the same invariant (EQ to :guarded) will never be executed concurrently.

Package

simple-flow-dispatcher

Source

dispatcher.lisp (file)

5.2 Internal definitions

5.2.1 Constants

Constant: +cas-sleep+

Package

simple-flow-dispatcher

Source

atomic.lisp (file)

5.2.2 Special variables

Special Variable: *dispatcher*

Package

simple-flow-dispatcher

5.2.3 Macros

Macro: %compare-and-swap PLACE OLD NEW

Tries to atomically set a value of PLACE to be NEW if it was EQ to OLD, returning non-nil if successful.

Package

simple-flow-dispatcher

Source

atomic.lisp (file)

Macro: with-spin-lock-held (SPIN-LOCK) &body BODY

Package

simple-flow-dispatcher

Source

atomic.lisp (file)

5.2.4 Functions

Function: acquire-spin-lock SPIN-LOCK

Package

simple-flow-dispatcher

Source

atomic.lisp (file)

Function: clear-tagged-queue QUEUE

Package

simple-flow-dispatcher

Source

dispatcher.lisp (file)

Function: copy-spin-lock INSTANCE

Package

simple-flow-dispatcher

Source

atomic.lisp (file)

Function: dispatch-with DISPATCHER FN INVARIANT PRIORITY IGNORE-INVARIANT

Package

simple-flow-dispatcher

Source

dispatcher.lisp (file)

Function: invoke-directly FN

Package

simple-flow-dispatcher

Source

dispatcher.lisp (file)

Function: make-spin-lock &key (OWNED OWNED)

Package

simple-flow-dispatcher

Source

atomic.lisp (file)

Function: peek-task QUEUE TAG

Package

simple-flow-dispatcher

Source

dispatcher.lisp (file)

Function: pop-task QUEUE TAG

Package

simple-flow-dispatcher

Source

dispatcher.lisp (file)

Function: push-task QUEUE TAG TASK

Package

simple-flow-dispatcher

Source

dispatcher.lisp (file)

Function: release-spin-lock SPIN-LOCK

Package

simple-flow-dispatcher

Source

atomic.lisp (file)

Function: simple-dispatcher-instance-alive-p SIMPLE-DISPATCHER-INSTANCE

Package

simple-flow-dispatcher

Source

dispatcher.lisp (file)

Function: spin-lock-owned INSTANCE

Function: (setf spin-lock-owned) VALUE INSTANCE

Package

simple-flow-dispatcher

Source

atomic.lisp (file)

Function: spin-lock-p OBJECT

Package

simple-flow-dispatcher

Source

atomic.lisp (file)

5.2.5 Structures

Structure: spin-lock ()

Package

simple-flow-dispatcher

Source

atomic.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: owned

Readers

spin-lock-owned (function)

Writers

(setf spin-lock-owned) (function)

5.2.6 Classes

Class: simple-dispatcher ()

Package

simple-flow-dispatcher

Source

dispatcher.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

initialize-instance (method)

Direct slots

Slot: tasks

Initform

(make-instance (quote simple-flow-dispatcher::tagged-queue))

Slot: error-handler

Initargs

:error-handler

Slot: invoker

Initargs

:invoker

Initform

(error ":invoker missing")

Slot: pool

Class: tagged-queue ()

Package

simple-flow-dispatcher

Source

dispatcher.lisp (file)

Direct superclasses

standard-object (class)

Direct slots

Slot: lock

Initform

(simple-flow-dispatcher::make-spin-lock)

Slot: queue-table

Initform

(make-hash-table :test (quote eq))

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types