The thread-pool Reference Manual

This is the thread-pool Reference Manual, version 0.2, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 07:07:40 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 thread-pool

Author

Andrea Chiumenti

License

Public Domain

Version

0.2

Dependencies
  • bordeaux-threads (system).
  • arnesi (system).
Source

thread-pool.asd.

Child Component

src (module).


3 Modules

Modules are listed depth-first from the system components tree.


3.1 thread-pool/src

Source

thread-pool.asd.

Parent Component

thread-pool (system).

Child Components

4 Files

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


4.1 Lisp


4.1.1 thread-pool/thread-pool.asd

Source

thread-pool.asd.

Parent Component

thread-pool (system).

ASDF Systems

thread-pool.


4.1.2 thread-pool/src/package.lisp

Source

thread-pool.asd.

Parent Component

src (module).

Packages

thread-pool.


4.1.3 thread-pool/src/thread-pool.lisp

Dependency

package.lisp (file).

Source

thread-pool.asd.

Parent Component

src (module).

Public Interface
Internals

5 Packages

Packages are listed by definition order.


5.1 thread-pool

A simple thread pool system

Source

package.lisp.

Use List

common-lisp.

Public Interface
Internals

6 Definitions

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


6.1 Public Interface


6.1.1 Ordinary functions

Function: make-thread-pool (&optional pool-size)
Package

thread-pool.

Source

thread-pool.lisp.


6.1.2 Generic functions

Generic Function: add-to-pool (thread-pool functions)

Add a function or a list of function to the thread pool

Package

thread-pool.

Source

thread-pool.lisp.

Methods
Method: add-to-pool ((thread-pool thread-pool) functions)
Generic Function: callable-call (call)
Package

thread-pool.

Source

thread-pool.lisp.

Methods
Method: callable-call ((callable callable))
Generic Reader: callable-handler-func (object)
Package

thread-pool.

Methods
Reader Method: callable-handler-func ((callable callable))

automatically generated reader method

Source

thread-pool.lisp.

Target Slot

handler-func.

Generic Writer: (setf callable-handler-func) (object)
Package

thread-pool.

Methods
Writer Method: (setf callable-handler-func) ((callable callable))

automatically generated writer method

Source

thread-pool.lisp.

Target Slot

handler-func.

Generic Reader: pool-size (object)
Package

thread-pool.

Methods
Reader Method: pool-size ((thread-pool thread-pool))

automatically generated reader method

Source

thread-pool.lisp.

Target Slot

pool-size.

Generic Function: (setf pool-size) (thread-pool)
Package

thread-pool.

Methods
Method: (setf pool-size) ((thread-pool thread-pool))
Source

thread-pool.lisp.

Generic Function: start-pool (thread-pool)

Starts serving jobs

Package

thread-pool.

Source

thread-pool.lisp.

Methods
Method: start-pool ((thread-pool thread-pool))
Generic Function: stop-pool (thread-pool)

Stops serving jobs

Package

thread-pool.

Source

thread-pool.lisp.

Methods
Method: stop-pool ((thread-pool thread-pool))

6.1.3 Classes

Class: callable
Package

thread-pool.

Source

thread-pool.lisp.

Direct methods
Direct slots
Slot: handler-func
Initargs

:handler-func

Readers

callable-handler-func.

Writers

(setf callable-handler-func).


6.2 Internals


6.2.1 Generic functions

Generic Reader: jobs (object)
Package

thread-pool.

Methods
Reader Method: jobs ((thread-pool thread-pool))

automatically generated reader method

Source

thread-pool.lisp.

Target Slot

jobs.

Generic Writer: (setf jobs) (object)
Package

thread-pool.

Methods
Writer Method: (setf jobs) ((thread-pool thread-pool))

automatically generated writer method

Source

thread-pool.lisp.

Target Slot

jobs.

Generic Reader: main-thread (object)
Package

thread-pool.

Methods
Reader Method: main-thread ((thread-pool thread-pool))

automatically generated reader method

Source

thread-pool.lisp.

Target Slot

main-thread.

Generic Writer: (setf main-thread) (object)
Package

thread-pool.

Methods
Writer Method: (setf main-thread) ((thread-pool thread-pool))

automatically generated writer method

Source

thread-pool.lisp.

Target Slot

main-thread.

Generic Reader: pool-condition (object)
Package

thread-pool.

Methods
Reader Method: pool-condition ((thread-pool thread-pool))

automatically generated reader method

Source

thread-pool.lisp.

Target Slot

pool-condition.

Generic Writer: (setf pool-condition) (object)
Package

thread-pool.

Methods
Writer Method: (setf pool-condition) ((thread-pool thread-pool))

automatically generated writer method

Source

thread-pool.lisp.

Target Slot

pool-condition.

Generic Reader: pool-condition-vars (object)
Package

thread-pool.

Methods
Reader Method: pool-condition-vars ((thread-pool thread-pool))

automatically generated reader method

Source

thread-pool.lisp.

Target Slot

pool-condition-vars.

Generic Writer: (setf pool-condition-vars) (object)
Package

thread-pool.

Methods
Writer Method: (setf pool-condition-vars) ((thread-pool thread-pool))

automatically generated writer method

Source

thread-pool.lisp.

Target Slot

pool-condition-vars.

Generic Reader: pool-lock (object)
Package

thread-pool.

Methods
Reader Method: pool-lock ((thread-pool thread-pool))

automatically generated reader method

Source

thread-pool.lisp.

Target Slot

pool-lock.

Generic Writer: (setf pool-lock) (object)
Package

thread-pool.

Methods
Writer Method: (setf pool-lock) ((thread-pool thread-pool))

automatically generated writer method

Source

thread-pool.lisp.

Target Slot

pool-lock.

Generic Reader: running-p (object)
Package

thread-pool.

Methods
Reader Method: running-p ((thread-pool thread-pool))

automatically generated reader method

Source

thread-pool.lisp.

Target Slot

running-p.

Generic Writer: (setf running-p) (object)
Package

thread-pool.

Methods
Writer Method: (setf running-p) ((thread-pool thread-pool))

automatically generated writer method

Source

thread-pool.lisp.

Target Slot

running-p.

Generic Reader: thread-locks (object)
Package

thread-pool.

Methods
Reader Method: thread-locks ((thread-pool thread-pool))

automatically generated reader method

Source

thread-pool.lisp.

Target Slot

thread-locks.

Generic Writer: (setf thread-locks) (object)
Package

thread-pool.

Methods
Writer Method: (setf thread-locks) ((thread-pool thread-pool))

automatically generated writer method

Source

thread-pool.lisp.

Target Slot

thread-locks.

Generic Reader: threads (object)
Package

thread-pool.

Methods
Reader Method: threads ((thread-pool thread-pool))

automatically generated reader method

Source

thread-pool.lisp.

Target Slot

threads.

Generic Writer: (setf threads) (object)
Package

thread-pool.

Methods
Writer Method: (setf threads) ((thread-pool thread-pool))

automatically generated writer method

Source

thread-pool.lisp.

Target Slot

threads.


6.2.2 Classes

Class: thread-pool
Package

thread-pool.

Source

thread-pool.lisp.

Direct methods
Direct Default Initargs
InitargValue
:pool-size1
Direct slots
Slot: jobs
Initform

(make-instance (quote it.bese.arnesi:queue))

Readers

jobs.

Writers

(setf jobs).

Slot: pool-size
Initargs

:pool-size

Readers

pool-size.

Writers

This slot is read-only.

Slot: threads
Readers

threads.

Writers

(setf threads).

Slot: thread-locks
Readers

thread-locks.

Writers

(setf thread-locks).

Slot: pool-condition-vars
Readers

pool-condition-vars.

Writers

(setf pool-condition-vars).

Slot: pool-lock
Initform

(bordeaux-threads:make-lock)

Readers

pool-lock.

Writers

(setf pool-lock).

Slot: pool-condition
Initform

(bordeaux-threads:make-condition-variable)

Readers

pool-condition.

Writers

(setf pool-condition).

Slot: running-p
Readers

running-p.

Writers

(setf running-p).

Slot: main-thread
Readers

main-thread.

Writers

(setf main-thread).


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
A   C   F   G   J   M   P   R   S   T  
Index Entry  Section

(
(setf callable-handler-func): Public generic functions
(setf callable-handler-func): Public generic functions
(setf jobs): Private generic functions
(setf jobs): Private generic functions
(setf main-thread): Private generic functions
(setf main-thread): Private generic functions
(setf pool-condition): Private generic functions
(setf pool-condition): Private generic functions
(setf pool-condition-vars): Private generic functions
(setf pool-condition-vars): Private generic functions
(setf pool-lock): Private generic functions
(setf pool-lock): Private generic functions
(setf pool-size): Public generic functions
(setf pool-size): Public generic functions
(setf running-p): Private generic functions
(setf running-p): Private generic functions
(setf thread-locks): Private generic functions
(setf thread-locks): Private generic functions
(setf threads): Private generic functions
(setf threads): Private generic functions

A
add-to-pool: Public generic functions
add-to-pool: Public generic functions

C
callable-call: Public generic functions
callable-call: Public generic functions
callable-handler-func: Public generic functions
callable-handler-func: Public generic functions

F
Function, make-thread-pool: Public ordinary functions

G
Generic Function, (setf callable-handler-func): Public generic functions
Generic Function, (setf jobs): Private generic functions
Generic Function, (setf main-thread): Private generic functions
Generic Function, (setf pool-condition): Private generic functions
Generic Function, (setf pool-condition-vars): Private generic functions
Generic Function, (setf pool-lock): Private generic functions
Generic Function, (setf pool-size): Public generic functions
Generic Function, (setf running-p): Private generic functions
Generic Function, (setf thread-locks): Private generic functions
Generic Function, (setf threads): Private generic functions
Generic Function, add-to-pool: Public generic functions
Generic Function, callable-call: Public generic functions
Generic Function, callable-handler-func: Public generic functions
Generic Function, jobs: Private generic functions
Generic Function, main-thread: Private generic functions
Generic Function, pool-condition: Private generic functions
Generic Function, pool-condition-vars: Private generic functions
Generic Function, pool-lock: Private generic functions
Generic Function, pool-size: Public generic functions
Generic Function, running-p: Private generic functions
Generic Function, start-pool: Public generic functions
Generic Function, stop-pool: Public generic functions
Generic Function, thread-locks: Private generic functions
Generic Function, threads: Private generic functions

J
jobs: Private generic functions
jobs: Private generic functions

M
main-thread: Private generic functions
main-thread: Private generic functions
make-thread-pool: Public ordinary functions
Method, (setf callable-handler-func): Public generic functions
Method, (setf jobs): Private generic functions
Method, (setf main-thread): Private generic functions
Method, (setf pool-condition): Private generic functions
Method, (setf pool-condition-vars): Private generic functions
Method, (setf pool-lock): Private generic functions
Method, (setf pool-size): Public generic functions
Method, (setf running-p): Private generic functions
Method, (setf thread-locks): Private generic functions
Method, (setf threads): Private generic functions
Method, add-to-pool: Public generic functions
Method, callable-call: Public generic functions
Method, callable-handler-func: Public generic functions
Method, jobs: Private generic functions
Method, main-thread: Private generic functions
Method, pool-condition: Private generic functions
Method, pool-condition-vars: Private generic functions
Method, pool-lock: Private generic functions
Method, pool-size: Public generic functions
Method, running-p: Private generic functions
Method, start-pool: Public generic functions
Method, stop-pool: Public generic functions
Method, thread-locks: Private generic functions
Method, threads: Private generic functions

P
pool-condition: Private generic functions
pool-condition: Private generic functions
pool-condition-vars: Private generic functions
pool-condition-vars: Private generic functions
pool-lock: Private generic functions
pool-lock: Private generic functions
pool-size: Public generic functions
pool-size: Public generic functions

R
running-p: Private generic functions
running-p: Private generic functions

S
start-pool: Public generic functions
start-pool: Public generic functions
stop-pool: Public generic functions
stop-pool: Public generic functions

T
thread-locks: Private generic functions
thread-locks: Private generic functions
threads: Private generic functions
threads: Private generic functions