This is the legion Reference Manual, version 0.1.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 16:52:30 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
legionSimple worker threads with a queue.
Eitaro Fukamachi
BSD 3-Clause
0.1.1
vom (system).
legion/main (system).
legion/mainEitaro Fukamachi
BSD 3-Clause
legion/worker (system).
legion/cluster (system).
legion/error (system).
legion/workerEitaro Fukamachi
BSD 3-Clause
legion/queue (system).
bordeaux-threads (system).
legion/queueEitaro Fukamachi
BSD 3-Clause
cl-speedy-queue (system).
bordeaux-threads (system).
legion/clusterEitaro Fukamachi
BSD 3-Clause
legion/worker (system).
legion/queue (system).
legion/error (system).
bordeaux-threads (system).
Files are sorted by type and then listed depth-first from the systems components trees.
legion/legion.asdlegion/main/file-type.lisplegion/worker/file-type.lisplegion/queue/file-type.lisplegion/cluster/file-type.lisplegion/error/file-type.lisplegion/main/file-type.lisplegion/main (system).
make-cluster (function).
make-worker (function).
legion/worker/file-type.lisplegion/worker (system).
add-job (generic function).
fetch-job (generic function).
kill (generic function).
print-object (method).
process-job (generic function).
start (generic function).
stop (generic function).
wakenup (function).
worker (class).
worker-queue (reader method).
(setf worker-queue) (writer method).
worker-queue-count (function).
worker-status (reader method).
(setf worker-status) (writer method).
run (generic function).
worker-process-fn (reader method).
worker-thread (reader method).
worker-wait-cond (reader method).
worker-wait-lock (reader method).
legion/queue/file-type.lisplegion/queue (system).
dequeue (function).
enqueue (function).
make-queue (function).
queue (structure).
queue-count (function).
queue-empty-p (function).
%make-queue (function).
copy-queue (function).
extend (function).
need-to-extend-p (function).
need-to-tidy-p (function).
queue-buffered (reader).
(setf queue-buffered) (writer).
queue-lock (reader).
(setf queue-lock) (writer).
queue-p (function).
queue-primary (reader).
(setf queue-primary) (writer).
queue-to-enqueue (function).
tidy (function).
legion/cluster/file-type.lisplegion/cluster (system).
add-job (method).
cluster (class).
cluster-status (reader method).
(setf cluster-status) (writer method).
cluster-workers (reader method).
initialize-instance (method).
kill (method).
print-object (method).
start (method).
stop (method).
cluster-queue (reader method).
(setf cluster-queue) (writer method).
legion/error/file-type.lisplegion/error (system).
legion-error (condition).
Packages are listed by definition order.
legion/clustercommon-lisp.
cluster (class).
cluster-status (generic reader).
(setf cluster-status) (generic writer).
cluster-workers (generic reader).
cluster-queue (generic reader).
(setf cluster-queue) (generic writer).
legion/queuecommon-lisp.
dequeue (function).
enqueue (function).
make-queue (function).
queue (structure).
queue-count (function).
queue-empty-p (function).
%make-queue (function).
copy-queue (function).
extend (function).
need-to-extend-p (function).
need-to-tidy-p (function).
queue-buffered (reader).
(setf queue-buffered) (writer).
queue-lock (reader).
(setf queue-lock) (writer).
queue-p (function).
queue-primary (reader).
(setf queue-primary) (writer).
queue-to-enqueue (function).
tidy (function).
legion/workercommon-lisp.
add-job (generic function).
fetch-job (generic function).
kill (generic function).
process-job (generic function).
start (generic function).
stop (generic function).
wakenup (function).
worker (class).
worker-queue (generic reader).
(setf worker-queue) (generic writer).
worker-queue-count (function).
worker-status (generic reader).
(setf worker-status) (generic writer).
run (generic function).
worker-process-fn (generic reader).
worker-thread (generic reader).
worker-wait-cond (generic reader).
worker-wait-lock (generic reader).
legionlegion/main
common-lisp.
make-cluster (function).
make-worker (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Return the number of outstanding jobs.
Enqueue VAL to WORKER’s queue. This returns WORKER when the queueing has been succeeded; otherwise NIL is returned.
Dequeue a value from WORKER’s queue. This returns multiple values – the job and a successed flag.
Stop the given WORKER immediately.
It raises an error if the WORKER is not running.
Start the given WORKER.
It raises an error if the WORKER is already running.
Stop the given WORKER after processing its queued jobs. It raises an error if the WORKER is not running.
cluster) &rest initargs &key workers &allow-other-keys) ¶:shutdown
(legion/queue:make-queue)
:queue
:process-fn
This slot is read-only.
This slot is read-only.
(bordeaux-threads-2:make-recursive-lock :name "wait-lock")
This slot is read-only.
(bordeaux-threads-2:make-condition-variable)
This slot is read-only.
lock.
| Jump to: | %
(
A C D E F G I K M N P Q R S T W |
|---|
| Jump to: | %
(
A C D E F G I K M N P Q R S T W |
|---|
| Jump to: | B L P Q S T W |
|---|
| Jump to: | B L P Q S T W |
|---|
| Jump to: | C F L P Q S W |
|---|
| Jump to: | C F L P Q S W |
|---|