The simple-flow-dispatcher Reference Manual

This is the simple-flow-dispatcher Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Aug 15 05:51:22 2022 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.

simple-flow-dispatcher

2.1 `simple-flow-dispatcher`

Reference implementation of a dispatcher for cl-flow library

Author

Pavel Korolev

Contact

dev@borodust.org

License

MIT

Version

1.0.0

Dependencies

alexandria (system).
cl-muth (system).
bodge-queue (system).

Source

simple-flow-dispatcher.asd.

Child Components

packages.lisp (file).
dispatcher.lisp (file).

3 Files

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

Lisp

3.1.3 `simple-flow-dispatcher/dispatcher.lisp`

Dependency

packages.lisp (file).

Source

simple-flow-dispatcher.asd.

Parent Component

simple-flow-dispatcher (system).

Public Interface

free-simple-dispatcher (function).
initialize-instance (method).
make-simple-dispatcher (function).

Internals

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.

simple-flow-dispatcher

4.1 `simple-flow-dispatcher`

Source

packages.lisp.

Use List

alexandria.
bodge-queue.
common-lisp.

Public Interface

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

Internals

*dispatcher* (special variable).
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).

5 Definitions

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

Public Interface
Internals

5.1.1 Ordinary functions

Function: free-simple-dispatcher (simple-dispatcher) ¶

Release resources acquired by the dispatcher

Package: simple-flow-dispatcher.
Source: dispatcher.lisp.

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.

5.1.2 Standalone methods

Method: initialize-instance :after ((this simple-dispatcher) &key threads) ¶

Source: dispatcher.lisp.

5.2 Internals

Special variables
Ordinary functions
Classes

5.2.1 Special variables

Special Variable: *dispatcher* ¶

Package: simple-flow-dispatcher.

5.2.2 Ordinary functions

Function: clear-tagged-queue (queue) ¶

Package: simple-flow-dispatcher.
Source: dispatcher.lisp.

Function: dispatch-with (dispatcher fn invariant priority ignore-invariant) ¶

Package: simple-flow-dispatcher.
Source: dispatcher.lisp.

Function: invoke-directly (fn) ¶

Package: simple-flow-dispatcher.
Source: dispatcher.lisp.

Function: peek-task (queue tag) ¶

Package: simple-flow-dispatcher.
Source: dispatcher.lisp.

Function: pop-task (queue tag) ¶

Package: simple-flow-dispatcher.
Source: dispatcher.lisp.

Function: push-task (queue tag task) ¶

Package: simple-flow-dispatcher.
Source: dispatcher.lisp.

Function: simple-dispatcher-instance-alive-p (simple-dispatcher-instance) ¶

Package: simple-flow-dispatcher.
Source: dispatcher.lisp.

5.2.3 Classes

Class: simple-dispatcher ¶

Package

simple-flow-dispatcher.

Source

dispatcher.lisp.

Direct methods

initialize-instance.

Direct slots

Slot: tasks ¶

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

Slot: error-handler ¶

Initargs: :error-handler

Slot: invoker ¶

Initform: (error ":invoker missing")
Initargs: :invoker

Slot: pool ¶

Class: tagged-queue ¶

Package

simple-flow-dispatcher.

Source

dispatcher.lisp.

Direct slots

Slot: lock ¶

Initform: (cl-muth:make-spin-lock)

Slot: queue-table ¶

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

Appendix A Indexes

Concepts
Functions
Variables
Data types

A.1 Concepts

A.2 Functions

Jump to:	C D F I M P S

	Index Entry	Section

C
	`clear-tagged-queue`:	Private ordinary functions

D
	`dispatch-with`:	Private ordinary functions

F
	`free-simple-dispatcher`:	Public ordinary functions
	`Function, clear-tagged-queue`:	Private ordinary functions
	`Function, dispatch-with`:	Private ordinary functions
	`Function, free-simple-dispatcher`:	Public ordinary functions
	`Function, invoke-directly`:	Private ordinary functions
	`Function, make-simple-dispatcher`:	Public ordinary functions
	`Function, peek-task`:	Private ordinary functions
	`Function, pop-task`:	Private ordinary functions
	`Function, push-task`:	Private ordinary functions
	`Function, simple-dispatcher-instance-alive-p`:	Private ordinary functions

I
	`initialize-instance`:	Public standalone methods
	`invoke-directly`:	Private ordinary functions

M
	`make-simple-dispatcher`:	Public ordinary functions
	`Method, initialize-instance`:	Public standalone methods

P
	`peek-task`:	Private ordinary functions
	`pop-task`:	Private ordinary functions
	`push-task`:	Private ordinary functions

S
	`simple-dispatcher-instance-alive-p`:	Private ordinary functions

Jump to:	C D F I M P S

A.3 Variables

Jump to:	* E I L P Q S T

	Index Entry	Section

*
	`dispatcher`:	Private special variables

E
	`error-handler`:	Private classes

I
	`invoker`:	Private classes

L
	`lock`:	Private classes

P
	`pool`:	Private classes

Q
	`queue-table`:	Private classes

S
	`Slot, error-handler`:	Private classes
	`Slot, invoker`:	Private classes
	`Slot, lock`:	Private classes
	`Slot, pool`:	Private classes
	`Slot, queue-table`:	Private classes
	`Slot, tasks`:	Private classes
	`Special Variable, dispatcher`:	Private special variables

T
	`tasks`:	Private classes

Jump to:	* E I L P Q S T

A.4 Data types

Jump to:	C D F P S T

	Index Entry	Section

C
	`Class, simple-dispatcher`:	Private classes
	`Class, tagged-queue`:	Private classes

D
	`dispatcher.lisp`:	The simple-flow-dispatcher/dispatcher․lisp file

F
	`File, dispatcher.lisp`:	The simple-flow-dispatcher/dispatcher․lisp file
	`File, packages.lisp`:	The simple-flow-dispatcher/packages․lisp file
	`File, simple-flow-dispatcher.asd`:	The simple-flow-dispatcher/simple-flow-dispatcher․asd file

P
	`Package, simple-flow-dispatcher`:	The simple-flow-dispatcher package
	`packages.lisp`:	The simple-flow-dispatcher/packages․lisp file

S
	`simple-dispatcher`:	Private classes
	`simple-flow-dispatcher`:	The simple-flow-dispatcher system
	`simple-flow-dispatcher`:	The simple-flow-dispatcher package
	`simple-flow-dispatcher.asd`:	The simple-flow-dispatcher/simple-flow-dispatcher․asd file
	`System, simple-flow-dispatcher`:	The simple-flow-dispatcher system

T
	`tagged-queue`:	Private classes

Jump to:	C D F P S T

The simple-flow-dispatcher Reference Manual

The simple-flow-dispatcher Reference Manual

Table of Contents

1 Introduction

simple-flow-dispatcher

2 Systems

2.1 simple-flow-dispatcher

3 Files

3.1 Lisp

3.1.1 simple-flow-dispatcher/simple-flow-dispatcher.asd

3.1.2 simple-flow-dispatcher/packages.lisp

3.1.3 simple-flow-dispatcher/dispatcher.lisp

4 Packages

4.1 simple-flow-dispatcher

5 Definitions

5.1 Public Interface

5.1.1 Ordinary functions

5.1.2 Standalone methods

5.2 Internals

5.2.1 Special variables

5.2.2 Ordinary functions

5.2.3 Classes

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `simple-flow-dispatcher`

3.1.1 `simple-flow-dispatcher/simple-flow-dispatcher.asd`

3.1.2 `simple-flow-dispatcher/packages.lisp`

3.1.3 `simple-flow-dispatcher/dispatcher.lisp`

4.1 `simple-flow-dispatcher`