This is the psychiq Reference Manual, version 0.1.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Sep 15 06:25:25 2024 GMT+0.
psychiq/psychiq.asdpsychiq/src/psychiq.lisppsychiq/src/client.lisppsychiq/src/launcher.lisppsychiq/src/core/connection.lisppsychiq/src/core/worker.lisppsychiq/src/core/queue.lisppsychiq/src/core/coder.lisppsychiq/src/launcher-core/processor.lisppsychiq/src/launcher-core/manager.lisppsychiq/src/launcher-core/scheduled.lisppsychiq/src/launcher-core/heartbeat.lisppsychiq/src/middleware/retry-jobs.lisppsychiq/src/middleware/logging.lisppsychiq/src/util/util.lisppsychiq/src/util/assoc.lisppsychiq/src/util/redis.lisppsychiq/src/util/concurrency.lisppsychiq/src/specials.lisppsychiq.specialspsychiqpsychiq.coderpsychiq.middleware.loggingpsychiq.util.concurrencypsychiq.launcher.heartbeatpsychiq.launcher.scheduledpsychiq.launcher.managerpsychiq.util.redispsychiq.launcherpsychiq.workerpsychiq.util.assocpsychiq.queuepsychiq.clientpsychiq.launcher.processorpsychiq.utilpsychiq.middleware.retry-jobspsychiq.connectionThe main system appears first, followed by any subsystem dependency.
psychiqRedis-backed job queueing system
Eitaro Fukamachi
LLGPL
0.1.0
cl-redis (system).
jonathan (system).
local-time (system).
cl-reexport (system).
bordeaux-threads (system).
dissect (system).
vom (system).
uiop (system).
alexandria (system).
sb-posix (system)., for feature :sbcl
src (module).
src/specials.lisp (file).
Modules are listed depth-first from the system components tree.
psychiq/srcsrc/specials.lisp (file).
psychiq (system).
psychiq.lisp (file).
client.lisp (file).
launcher.lisp (file).
core (module).
launcher-core (module).
middleware (module).
util (module).
psychiq/src/coreutil (module).
src (module).
connection.lisp (file).
worker.lisp (file).
queue.lisp (file).
coder.lisp (file).
psychiq/src/launcher-corecore (module).
middleware (module).
util (module).
src (module).
processor.lisp (file).
manager.lisp (file).
scheduled.lisp (file).
heartbeat.lisp (file).
psychiq/src/middlewaresrc (module).
retry-jobs.lisp (file).
logging.lisp (file).
psychiq/src/utilsrc (module).
util.lisp (file).
assoc.lisp (file).
redis.lisp (file).
concurrency.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
psychiq/psychiq.asdpsychiq/src/psychiq.lisppsychiq/src/client.lisppsychiq/src/launcher.lisppsychiq/src/core/connection.lisppsychiq/src/core/worker.lisppsychiq/src/core/queue.lisppsychiq/src/core/coder.lisppsychiq/src/launcher-core/processor.lisppsychiq/src/launcher-core/manager.lisppsychiq/src/launcher-core/scheduled.lisppsychiq/src/launcher-core/heartbeat.lisppsychiq/src/middleware/retry-jobs.lisppsychiq/src/middleware/logging.lisppsychiq/src/util/util.lisppsychiq/src/util/assoc.lisppsychiq/src/util/redis.lisppsychiq/src/util/concurrency.lisppsychiq/src/specials.lisppsychiq/src/psychiq.lispcore (module).
client.lisp (file).
src (module).
psychiq/src/client.lispcore (module).
src (module).
all-dead-jobs (function).
all-queues (function).
all-retries (function).
cleanup-processes (function).
delete-queue (function).
dequeue (function).
enqueue (function).
enqueue-bulk (function).
enqueue-in-sec (function).
peek-queue (function).
queue-empty-p (function).
queue-length (function).
retry-length (function).
slice-queue (function).
stats (function).
decode-objects (function).
psychiq/src/launcher.lispcore (module).
launcher-core (module).
src (module).
kill (function).
launcher (structure).
launcher-status (function).
print-object (method).
run (function).
start (function).
stop (function).
wait-for (function).
%make-launcher (function).
copy-launcher (function).
launcher-heartbeat (reader).
(setf launcher-heartbeat) (writer).
launcher-manager (reader).
(setf launcher-manager) (writer).
launcher-p (function).
launcher-scheduled (reader).
(setf launcher-scheduled) (writer).
make-launcher (function).
psychiq/src/core/connection.lispcore (module).
*connection* (special variable).
close-connection (generic function).
connect (function).
connect-toplevel (function).
connectedp (generic function).
connection (class).
disconnect (function).
disconnect-toplevel (function).
ensure-connected (function).
make-connection (function).
open-connection (generic function).
print-object (method).
reconnect (function).
with-connection (macro).
redis-connection (reader method).
(setf redis-connection) (writer method).
psychiq/src/core/worker.lispcore (module).
decode-job (function).
encode-job (function).
perform (generic function).
worker (class).
worker-max-retries (generic function).
worker-queue-name (generic function).
worker-use-backtrace-p (generic function).
worker-use-dead-queue-p (generic function).
psychiq/src/core/queue.lispcoder.lisp (file).
core (module).
dequeue-from-queue (function).
enqueue-to-queue (function).
enqueue-to-scheduled-queue (function).
psychiq/src/core/coder.lispcore (module).
decode-object (function).
encode-object (function).
psychiq/src/launcher-core/processor.lisplauncher-core (module).
fetch-job (generic function).
finalize (generic function).
kill (generic function).
make-processor (function).
perform-job (generic function).
print-object (method).
process-job (generic function).
processor (structure).
processor-connection (reader).
(setf processor-connection) (writer).
processor-id (reader).
(setf processor-id) (writer).
processor-manager (reader).
(setf processor-manager) (writer).
processor-processing (reader).
(setf processor-processing) (writer).
processor-status (reader).
(setf processor-status) (writer).
processor-timeout (reader).
(setf processor-timeout) (writer).
run (generic function).
start (generic function).
stop (generic function).
wait-for (generic function).
%make-processor (function).
copy-processor (function).
processor-down (reader).
(setf processor-down) (writer).
processor-p (function).
processor-queues (reader).
(setf processor-queues) (writer).
processor-thread (reader).
(setf processor-thread) (writer).
psychiq/src/launcher-core/manager.lispprocessor.lisp (file).
launcher-core (module).
finalize (method).
kill (method).
make-manager (function).
manager (structure).
manager-children (reader).
(setf manager-children) (writer).
manager-count (reader).
(setf manager-count) (writer).
manager-queues (reader).
(setf manager-queues) (writer).
manager-stat-failed (reader).
(setf manager-stat-failed) (writer).
manager-stat-processed (reader).
(setf manager-stat-processed) (writer).
manager-stopped-p (reader).
(setf manager-stopped-p) (writer).
process-job (method).
run (method).
start (method).
stop (method).
wait-for (method).
%make-manager (function).
copy-manager (function).
make-child-processors (function).
manager-db (reader).
(setf manager-db) (writer).
manager-host (reader).
(setf manager-host) (writer).
manager-lock (reader).
(setf manager-lock) (writer).
manager-make-processor-fn (reader).
(setf manager-make-processor-fn) (writer).
manager-p (function).
manager-port (reader).
(setf manager-port) (writer).
processor-died (function).
processor-stopped (function).
psychiq/src/launcher-core/scheduled.lisplauncher-core (module).
kill (function).
make-scheduled (function).
scheduled (structure).
scheduled-status (reader).
(setf scheduled-status) (writer).
scheduled-thread (reader).
(setf scheduled-thread) (writer).
start (function).
stop (function).
%make-scheduled (function).
copy-scheduled (function).
enqueue-jobs (function).
scaled-poll-interval (function).
scheduled-connection (reader).
(setf scheduled-connection) (writer).
scheduled-p (function).
psychiq/src/launcher-core/heartbeat.lispmanager.lisp (file).
processor.lisp (file).
launcher-core (module).
clear-heartbeat (function).
copy-heartbeat (function).
heartbeat-db (reader).
(setf heartbeat-db) (writer).
heartbeat-host (reader).
(setf heartbeat-host) (writer).
heartbeat-manager (reader).
(setf heartbeat-manager) (writer).
heartbeat-p (function).
heartbeat-port (reader).
(setf heartbeat-port) (writer).
heartbeat-stopped-p (reader).
(setf heartbeat-stopped-p) (writer).
heartbeat-thread (reader).
(setf heartbeat-thread) (writer).
run (function).
psychiq/src/middleware/retry-jobs.lispmiddleware (module).
*psychiq-middleware-retry-jobs* (special variable).
*dead-max-jobs* (special variable).
*dead-timeout-in-seconds* (special variable).
attempt-retry (function).
backtrace (function).
delay-for (function).
send-to-morgue (function).
psychiq/src/middleware/logging.lispmiddleware (module).
*psychiq-middleware-logging* (special variable).
psychiq/src/util/util.lispassoc.lisp (file).
redis.lisp (file).
concurrency.lisp (file).
util (module).
generate-random-id (function).
getpid (function).
machine-identity (function).
symbol-name-with-package (function).
psychiq/src/util/assoc.lisputil (module).
aget (function).
(setf aget) (function).
psychiq/src/util/redis.lisputil (module).
omit-redis-prefix (function).
redis-key (function).
with-redis-transaction (macro).
psychiq/src/util/concurrency.lisputil (module).
get-value (function).
(setf get-value) (function).
make-thread-safe-variable (function).
reset-value (function).
copy-thread-safe-variable (function).
thread-safe-variable (structure).
thread-safe-variable-initial-value (reader).
(setf thread-safe-variable-initial-value) (writer).
thread-safe-variable-lock (reader).
(setf thread-safe-variable-lock) (writer).
thread-safe-variable-p (function).
thread-safe-variable-value (reader).
(setf thread-safe-variable-value) (writer).
psychiq/src/specials.lisppsychiq (system).
*default-max-retry-attempts* (special variable).
*default-queue-name* (special variable).
*default-redis-host* (special variable).
*default-redis-port* (special variable).
*psychiq-namespace* (special variable).
Packages are listed by definition order.
psychiq.specialspsychiqpsychiq.coderpsychiq.middleware.loggingpsychiq.util.concurrencypsychiq.launcher.heartbeatpsychiq.launcher.scheduledpsychiq.launcher.managerpsychiq.util.redispsychiq.launcherpsychiq.workerpsychiq.util.assocpsychiq.queuepsychiq.clientpsychiq.launcher.processorpsychiq.utilpsychiq.middleware.retry-jobspsychiq.connectionpsychiq.specialscommon-lisp.
*default-max-retry-attempts* (special variable).
*default-queue-name* (special variable).
*default-redis-host* (special variable).
*default-redis-port* (special variable).
*psychiq-namespace* (special variable).
psychiq.codercommon-lisp.
decode-object (function).
encode-object (function).
psychiq.middleware.loggingcommon-lisp.
psychiq.util.
*psychiq-middleware-logging* (special variable).
psychiq.util.concurrencycommon-lisp.
get-value (function).
(setf get-value) (function).
make-thread-safe-variable (function).
reset-value (function).
copy-thread-safe-variable (function).
thread-safe-variable (structure).
thread-safe-variable-initial-value (reader).
(setf thread-safe-variable-initial-value) (writer).
thread-safe-variable-lock (reader).
(setf thread-safe-variable-lock) (writer).
thread-safe-variable-p (function).
thread-safe-variable-value (reader).
(setf thread-safe-variable-value) (writer).
psychiq.launcher.heartbeatcommon-lisp.
psychiq.util.
clear-heartbeat (function).
copy-heartbeat (function).
heartbeat-db (reader).
(setf heartbeat-db) (writer).
heartbeat-host (reader).
(setf heartbeat-host) (writer).
heartbeat-manager (reader).
(setf heartbeat-manager) (writer).
heartbeat-p (function).
heartbeat-port (reader).
(setf heartbeat-port) (writer).
heartbeat-stopped-p (reader).
(setf heartbeat-stopped-p) (writer).
heartbeat-thread (reader).
(setf heartbeat-thread) (writer).
run (function).
psychiq.launcher.scheduledcommon-lisp.
psychiq.specials.
psychiq.util.
kill (function).
make-scheduled (function).
scheduled (structure).
scheduled-status (reader).
(setf scheduled-status) (writer).
scheduled-thread (reader).
(setf scheduled-thread) (writer).
start (function).
stop (function).
%make-scheduled (function).
copy-scheduled (function).
enqueue-jobs (function).
scaled-poll-interval (function).
scheduled-connection (reader).
(setf scheduled-connection) (writer).
scheduled-p (function).
psychiq.launcher.managercommon-lisp.
psychiq.launcher.processor.
psychiq.specials.
psychiq.util.
make-manager (function).
manager (structure).
manager-children (reader).
(setf manager-children) (writer).
manager-count (reader).
(setf manager-count) (writer).
manager-queues (reader).
(setf manager-queues) (writer).
manager-stat-failed (reader).
(setf manager-stat-failed) (writer).
manager-stat-processed (reader).
(setf manager-stat-processed) (writer).
manager-stopped-p (reader).
(setf manager-stopped-p) (writer).
%make-manager (function).
copy-manager (function).
make-child-processors (function).
manager-db (reader).
(setf manager-db) (writer).
manager-host (reader).
(setf manager-host) (writer).
manager-lock (reader).
(setf manager-lock) (writer).
manager-make-processor-fn (reader).
(setf manager-make-processor-fn) (writer).
manager-p (function).
manager-port (reader).
(setf manager-port) (writer).
processor-died (function).
processor-stopped (function).
psychiq.util.rediscommon-lisp.
omit-redis-prefix (function).
redis-key (function).
with-redis-transaction (macro).
psychiq.launchercommon-lisp.
psychiq.specials.
%make-launcher (function).
copy-launcher (function).
launcher-heartbeat (reader).
(setf launcher-heartbeat) (writer).
launcher-manager (reader).
(setf launcher-manager) (writer).
launcher-p (function).
launcher-scheduled (reader).
(setf launcher-scheduled) (writer).
make-launcher (function).
psychiq.workercommon-lisp.
psychiq.specials.
psychiq.util.
decode-job (function).
encode-job (function).
perform (generic function).
worker (class).
worker-max-retries (generic function).
worker-queue-name (generic function).
worker-use-backtrace-p (generic function).
worker-use-dead-queue-p (generic function).
psychiq.util.assoccommon-lisp.
aget (function).
(setf aget) (function).
psychiq.queuecommon-lisp.
psychiq.util.
dequeue-from-queue (function).
enqueue-to-queue (function).
enqueue-to-scheduled-queue (function).
psychiq.clientcommon-lisp.
psychiq.specials.
psychiq.util.
all-dead-jobs (function).
all-queues (function).
all-retries (function).
cleanup-processes (function).
delete-queue (function).
dequeue (function).
enqueue (function).
enqueue-bulk (function).
enqueue-in-sec (function).
peek-queue (function).
queue-empty-p (function).
queue-length (function).
retry-length (function).
slice-queue (function).
stats (function).
decode-objects (function).
psychiq.launcher.processorcommon-lisp.
psychiq.specials.
psychiq.util.
fetch-job (generic function).
finalize (generic function).
kill (generic function).
make-processor (function).
perform-job (generic function).
process-job (generic function).
processor (structure).
processor-connection (reader).
(setf processor-connection) (writer).
processor-id (reader).
(setf processor-id) (writer).
processor-manager (reader).
(setf processor-manager) (writer).
processor-processing (reader).
(setf processor-processing) (writer).
processor-status (reader).
(setf processor-status) (writer).
processor-timeout (reader).
(setf processor-timeout) (writer).
run (generic function).
start (generic function).
stop (generic function).
wait-for (generic function).
%make-processor (function).
copy-processor (function).
processor-down (reader).
(setf processor-down) (writer).
processor-p (function).
processor-queues (reader).
(setf processor-queues) (writer).
processor-thread (reader).
(setf processor-thread) (writer).
psychiq.utilcommon-lisp.
generate-random-id (function).
getpid (function).
machine-identity (function).
symbol-name-with-package (function).
psychiq.middleware.retry-jobscommon-lisp.
psychiq.specials.
psychiq.util.
*psychiq-middleware-retry-jobs* (special variable).
*dead-max-jobs* (special variable).
*dead-timeout-in-seconds* (special variable).
attempt-retry (function).
backtrace (function).
delay-for (function).
send-to-morgue (function).
psychiq.connectioncommon-lisp.
psychiq.specials.
*connection* (special variable).
close-connection (generic function).
connect (function).
connect-toplevel (function).
connectedp (generic function).
connection (slot).
connection (class).
disconnect (function).
disconnect-toplevel (function).
ensure-connected (function).
make-connection (function).
open-connection (generic function).
reconnect (function).
with-connection (macro).
redis-connection (generic reader).
(setf redis-connection) (generic writer).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Clean up dead processes recorded in Redis.
id.
connection)) ¶connection)) ¶connection)) ¶connection) stream) ¶structure-object.
(quote nil)
common-lisp.
25
(quote nil)
(bordeaux-threads-2:make-recursive-lock)
t
structure-object.
fetch-job.
finalize.
finalize.
kill.
perform-job.
print-object.
process-job.
process-job.
run.
run.
start.
stop.
wait-for.
(psychiq.util:generate-random-id 9)
psychiq.connection:connection
list
(quote nil)
:stopped
5
string
psychiq.specials:*default-redis-host*
:host
integer
psychiq.specials:*default-redis-port*
:port
(or integer null)
:db
(or redis:redis-connection null)
db.
host.
port.
db.
host.
lock.
port.
down.
lock.
connection)) ¶automatically generated reader method
connection)) ¶automatically generated writer method
| Jump to: | %
(
A B C D E F G H K L M O P Q R S T W |
|---|
| Jump to: | %
(
A B C D E F G H K L M O P Q R S T W |
|---|
| Jump to: | *
C D H I L M P Q R S T V |
|---|
| Jump to: | *
C D H I L M P Q R S T V |
|---|
| Jump to: | A C F H L M P Q R S T U W |
|---|
| Jump to: | A C F H L M P Q R S T U W |
|---|