The psychiq Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The psychiq Reference Manual

This is the psychiq Reference Manual, version 0.1.0, generated automatically by Declt version 2.3 "Robert April" on Wed Mar 14 04:26:49 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

Psychiq

Build Status Coverage Status Quicklisp dist

Psychiq provides background job processing for Common Lisp applications inspired by Ruby's Sidekiq.

Warning

This software is still ALPHA quality. The APIs will be likely to change.

Getting Started

Writing a worker

(psy:connect-toplevel :host "localhost" :port 6379)

(defclass my-worker (psy:worker) ())
(defmethod psy:perform ((worker my-worker) &rest args)
  ;; Do something
  )

The worker class is commonly written in an individual ASDF system because it must be shared with clients and servers.

Enqueueing (Client)

;; Enqueueing to "default" queue
(psy:enqueue 'my-worker '("arg1" "arg2"))

;; Enqueueing the job after 300 seconds.
(psy:enqueue-in-sec 300 'my-worker '("arg1" "arg2"))

;; Enqueueing a large number of jobs at a time
;; This is useful if you are pushing tens of thousands of jobs or more
(psy:enqueue-bulk 'my-worker '("arg1" "arg2") '("another" "one") ...)

The arguments must be simple JSON datatypes which can be serialized with Jonathan.

Starting processing (Server)

Psychiq provides a Roswell script for starting processing:

$ psychiq --host localhost --port 6379 --system myapp-workers
$ psychiq -h
Usage: psychiq [option...]

Options:
    -o, --host HOST                 Redis server host (default: localhost)
    -p, --port PORT                 Redis server port (default: 6379)
    -d, --db DBNUM                  Redis server db (default: 0)
    -q, --queue QUEUE[,WEIGHT]      Queues to process with optional weights (several -q's allowed)
    -c, --concurrency INT           Processor threads to use (default: 25)
    -s, --system SYSTEM             ASDF system to load before starting (several -s's allowed)
    -v, --verbose                   Print more verbose output
    -n, --namespace NAMESPACE       Redis namespace (default: "psychiq")
    -V, --version                   Print version
    -h, --help                      Show help

Worker options

(defclass my-worker (psy:worker) ())

;; Specify max retry attempts. (default: 25)
(defmethod psy:worker-max-retries ((worker my-worker))
  1000)

;; Use a named queue to push. (default: "default")
(defmethod psy:worker-queue-name ((worker my-worker))
  "my-worker-queue")

;; Disable jobs going to the dead job queue. (default: T)
(defmethod psy:worker-use-dead-queue-p ((worker my-worker))
  nil)

;; Whether to save any error backtrace in the retry payload. (default: NIL)
(defmethod psy:worker-use-backtrace-p ((worker my-worker))
  t)

Signals

Error Handling

When getting an error while performing a job, Psychiq will add the job to the "retry" queue. Jobs in the "retry" queue will be retried automatically with an exponential backoff. After 25 attempts, Psychiq move the job to the "dead" queue.

Web UI

Since the data structure which Psychiq stores in Redis is compatible with Ruby's Resque/Sidekiq, Sidekiq's Web UI can be used.

# config.ru
require 'sidekiq'

Sidekiq.configure_client do |config|
  config.redis = { :size => 1, url: 'redis://localhost:6379', namespace: 'psychiq' }
end

require 'sidekiq/web'
run Sidekiq::Web
$ rackup config.ru

It will be up at http://127.0.0.1:9292 which allows you to see processes and can retry failed jobs manually.

Requirements

Installation

$ ros install psychiq

Author

Copyright

Copyright (c) 2015-2017 Eitaro Fukamachi (e.arrows@gmail.com)

License

Licensed under the LLGPL License.


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


Previous: , Up: Systems   [Contents][Index]

2.1 psychiq

Author

Eitaro Fukamachi

License

LLGPL

Description

Redis-backed job queueing system

Version

0.1.0

Dependencies
Source

psychiq.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Modules

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


Next: , Previous: , Up: Modules   [Contents][Index]

3.1 psychiq/src

Dependency

src/specials.lisp (file)

Parent

psychiq (system)

Location

src/

Components

Next: , Previous: , Up: Modules   [Contents][Index]

3.2 psychiq/src/core

Dependency

util (module)

Parent

src (module)

Location

src/core/

Components

Next: , Previous: , Up: Modules   [Contents][Index]

3.3 psychiq/src/launcher-core

Dependencies
Parent

src (module)

Location

src/launcher/

Components

Next: , Previous: , Up: Modules   [Contents][Index]

3.4 psychiq/src/middleware

Dependencies
Parent

src (module)

Location

src/middleware/

Components

Previous: , Up: Modules   [Contents][Index]

3.5 psychiq/src/util

Parent

src (module)

Location

src/util/

Components

Next: , Previous: , Up: Top   [Contents][Index]

4 Files

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


Previous: , Up: Files   [Contents][Index]

4.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.1 psychiq.asd

Location

psychiq.asd

Systems

psychiq (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.2 psychiq/src/psychiq.lisp

Dependencies
Parent

src (module)

Location

src/psychiq.lisp

Packages

psychiq


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.3 psychiq/src/client.lisp

Dependency

core (module)

Parent

src (module)

Location

src/client.lisp

Packages

psychiq.client

Exported Definitions
Internal Definitions

decode-objects (function)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.4 psychiq/src/launcher.lisp

Dependencies
Parent

src (module)

Location

src/launcher.lisp

Packages

psychiq.launcher

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.5 psychiq/src/core/connection.lisp

Parent

core (module)

Location

src/core/connection.lisp

Packages

psychiq.connection

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.6 psychiq/src/core/worker.lisp

Parent

core (module)

Location

src/core/worker.lisp

Packages

psychiq.worker

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.7 psychiq/src/core/queue.lisp

Dependency

coder.lisp (file)

Parent

core (module)

Location

src/core/queue.lisp

Packages

psychiq.queue

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.8 psychiq/src/core/coder.lisp

Parent

core (module)

Location

src/core/coder.lisp

Packages

psychiq.coder

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.9 psychiq/src/launcher-core/processor.lisp

Parent

launcher-core (module)

Location

src/launcher/processor.lisp

Packages

psychiq.launcher.processor

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.10 psychiq/src/launcher-core/manager.lisp

Dependency

processor.lisp (file)

Parent

launcher-core (module)

Location

src/launcher/manager.lisp

Packages

psychiq.launcher.manager

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.11 psychiq/src/launcher-core/scheduled.lisp

Parent

launcher-core (module)

Location

src/launcher/scheduled.lisp

Packages

psychiq.launcher.scheduled

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.12 psychiq/src/launcher-core/heartbeat.lisp

Dependencies
Parent

launcher-core (module)

Location

src/launcher/heartbeat.lisp

Packages

psychiq.launcher.heartbeat

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.13 psychiq/src/middleware/retry-jobs.lisp

Parent

middleware (module)

Location

src/middleware/retry-jobs.lisp

Packages

psychiq.middleware.retry-jobs

Exported Definitions

*psychiq-middleware-retry-jobs* (special variable)

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.14 psychiq/src/middleware/logging.lisp

Parent

middleware (module)

Location

src/middleware/logging.lisp

Packages

psychiq.middleware.logging

Exported Definitions

*psychiq-middleware-logging* (special variable)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.15 psychiq/src/util/util.lisp

Dependencies
Parent

util (module)

Location

src/util/util.lisp

Packages

psychiq.util

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.16 psychiq/src/util/assoc.lisp

Parent

util (module)

Location

src/util/assoc.lisp

Packages

psychiq.util.assoc

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.17 psychiq/src/util/redis.lisp

Parent

util (module)

Location

src/util/redis.lisp

Packages

psychiq.util.redis

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.18 psychiq/src/util/concurrency.lisp

Parent

util (module)

Location

src/util/concurrency.lisp

Packages

psychiq.util.concurrency

Exported Definitions
Internal Definitions

Previous: , Up: Lisp files   [Contents][Index]

4.1.19 psychiq/src/specials.lisp

Parent

psychiq (system)

Location

src/specials.lisp

Packages

psychiq.specials

Exported Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Packages

Packages are listed by definition order.


Next: , Previous: , Up: Packages   [Contents][Index]

5.1 psychiq

Source

psychiq.lisp (file)

Nickname

psy

Use List

common-lisp


Next: , Previous: , Up: Packages   [Contents][Index]

5.2 psychiq.client

Source

client.lisp (file)

Use List
Exported Definitions
Internal Definitions

decode-objects (function)


Next: , Previous: , Up: Packages   [Contents][Index]

5.3 psychiq.launcher

Source

launcher.lisp (file)

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

5.4 psychiq.connection

Source

connection.lisp (file)

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

5.5 psychiq.worker

Source

worker.lisp (file)

Use List
Exported Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

5.6 psychiq.queue

Source

queue.lisp (file)

Use List
Exported Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

5.7 psychiq.coder

Source

coder.lisp (file)

Use List

common-lisp

Exported Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

5.8 psychiq.launcher.processor

Source

processor.lisp (file)

Use List
Used By List

psychiq.launcher.manager

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

5.9 psychiq.launcher.manager

Source

manager.lisp (file)

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

5.10 psychiq.launcher.scheduled

Source

scheduled.lisp (file)

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

5.11 psychiq.launcher.heartbeat

Source

heartbeat.lisp (file)

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

5.12 psychiq.middleware.retry-jobs

Source

retry-jobs.lisp (file)

Use List
Exported Definitions

*psychiq-middleware-retry-jobs* (special variable)

Internal Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

5.13 psychiq.middleware.logging

Source

logging.lisp (file)

Use List
Exported Definitions

*psychiq-middleware-logging* (special variable)


Next: , Previous: , Up: Packages   [Contents][Index]

5.14 psychiq.util

Source

util.lisp (file)

Use List

common-lisp

Used By List
Exported Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

5.15 psychiq.util.assoc

Source

assoc.lisp (file)

Use List

common-lisp

Exported Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

5.16 psychiq.util.redis

Source

redis.lisp (file)

Use List

common-lisp

Exported Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

5.17 psychiq.util.concurrency

Source

concurrency.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

Previous: , Up: Packages   [Contents][Index]

5.18 psychiq.specials

Source

src/specials.lisp (file)

Use List

common-lisp

Used By List
Exported Definitions

Next: , Previous: , Up: Top   [Contents][Index]

6 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

6.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.1 Special variables

Special Variable: *connection*
Package

psychiq.connection

Source

connection.lisp (file)

Special Variable: *default-max-retry-attempts*
Package

psychiq.specials

Source

src/specials.lisp (file)

Special Variable: *default-queue-name*
Package

psychiq.specials

Source

src/specials.lisp (file)

Special Variable: *default-redis-host*
Package

psychiq.specials

Source

src/specials.lisp (file)

Special Variable: *default-redis-port*
Package

psychiq.specials

Source

src/specials.lisp (file)

Special Variable: *psychiq-middleware-logging*
Package

psychiq.middleware.logging

Source

logging.lisp (file)

Special Variable: *psychiq-middleware-retry-jobs*
Package

psychiq.middleware.retry-jobs

Source

retry-jobs.lisp (file)

Special Variable: *psychiq-namespace*
Package

psychiq.specials

Source

src/specials.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.2 Macros

Macro: with-connection CONN &body BODY
Package

psychiq.connection

Source

connection.lisp (file)

Macro: with-redis-transaction &body BODY
Package

psychiq.util.redis

Source

redis.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.3 Functions

Function: aget ALIST KEY &key TEST
Function: (setf aget) VAL ALIST KEY &key TEST
Package

psychiq.util.assoc

Source

assoc.lisp (file)

Function: all-dead-jobs ()
Package

psychiq.client

Source

client.lisp (file)

Function: all-queues ()
Package

psychiq.client

Source

client.lisp (file)

Function: all-retries ()
Package

psychiq.client

Source

client.lisp (file)

Function: cleanup-processes ()

Clean up dead processes recorded in Redis.

Package

psychiq.client

Source

client.lisp (file)

Function: connect &rest INITARGS &key HOST PORT DB
Package

psychiq.connection

Source

connection.lisp (file)

Function: connect-toplevel &rest INITARGS &key HOST PORT DB
Package

psychiq.connection

Source

connection.lisp (file)

Function: decode-job JOB-INFO
Package

psychiq.worker

Source

worker.lisp (file)

Function: decode-object PAYLOAD
Package

psychiq.coder

Source

coder.lisp (file)

Function: delete-queue QUEUE
Package

psychiq.client

Source

client.lisp (file)

Function: dequeue &optional QUEUE-OR-QUEUES TIMEOUT
Package

psychiq.client

Source

client.lisp (file)

Function: dequeue-from-queue QUEUE-OR-QUEUES &key TIMEOUT
Package

psychiq.queue

Source

queue.lisp (file)

Function: disconnect CONN
Package

psychiq.connection

Source

connection.lisp (file)

Function: disconnect-toplevel ()
Package

psychiq.connection

Source

connection.lisp (file)

Function: encode-job WORKER-CLASS ARGS
Package

psychiq.worker

Source

worker.lisp (file)

Function: encode-object OBJECT
Package

psychiq.coder

Source

coder.lisp (file)

Function: enqueue WORKER-CLASS &optional ARGS
Package

psychiq.client

Source

client.lisp (file)

Function: enqueue-bulk WORKER-CLASS JOB-ARGS &rest MORE-JOB-ARGS
Package

psychiq.client

Source

client.lisp (file)

Function: enqueue-in-sec INTERVAL WORKER-CLASS &optional ARGS
Package

psychiq.client

Source

client.lisp (file)

Function: enqueue-to-queue QUEUE JOB-INFO
Package

psychiq.queue

Source

queue.lisp (file)

Function: enqueue-to-scheduled-queue JOB-INFO AT
Package

psychiq.queue

Source

queue.lisp (file)

Function: ensure-connected CONN
Package

psychiq.connection

Source

connection.lisp (file)

Function: generate-random-id &optional LENGTH
Package

psychiq.util

Source

util.lisp (file)

Function: get-value VAR
Function: (setf get-value) NEW-VALUE VAR
Package

psychiq.util.concurrency

Source

concurrency.lisp (file)

Function: getpid ()
Package

psychiq.util

Source

util.lisp (file)

Function: heartbeat HEARTBEAT MACHINE-IDENTITY JSON
Package

psychiq.launcher.heartbeat

Source

heartbeat.lisp (file)

Function: kill LAUNCHER
Package

psychiq.launcher

Source

launcher.lisp (file)

Function: kill SCHEDULED
Package

psychiq.launcher.scheduled

Source

scheduled.lisp (file)

Function: kill HEARTBEAT
Package

psychiq.launcher.heartbeat

Source

heartbeat.lisp (file)

Function: launcher-status LAUNCHER
Package

psychiq.launcher

Source

launcher.lisp (file)

Function: machine-identity ()
Package

psychiq.util

Source

util.lisp (file)

Function: make-connection &rest INITARGS &key HOST PORT DB
Package

psychiq.connection

Source

connection.lisp (file)

Function: make-heartbeat &key (HOST HOST) (PORT PORT) (DB DB) (THREAD THREAD) (STOPPED-P STOPPED-P) (MANAGER MANAGER)
Package

psychiq.launcher.heartbeat

Source

heartbeat.lisp (file)

Function: make-manager &key HOST PORT DB QUEUES COUNT TIMEOUT
Package

psychiq.launcher.manager

Source

manager.lisp (file)

Function: make-processor &key HOST PORT DB QUEUES MANAGER TIMEOUT
Package

psychiq.launcher.processor

Source

processor.lisp (file)

Function: make-scheduled &key HOST PORT DB
Package

psychiq.launcher.scheduled

Source

scheduled.lisp (file)

Function: make-thread-safe-variable INITIAL-VALUE &key LOCK &aux VALUE
Package

psychiq.util.concurrency

Source

concurrency.lisp (file)

Function: manager-children INSTANCE
Function: (setf manager-children) VALUE INSTANCE
Package

psychiq.launcher.manager

Source

manager.lisp (file)

Function: manager-count INSTANCE
Function: (setf manager-count) VALUE INSTANCE
Package

psychiq.launcher.manager

Source

manager.lisp (file)

Function: manager-queues INSTANCE
Function: (setf manager-queues) VALUE INSTANCE
Package

psychiq.launcher.manager

Source

manager.lisp (file)

Function: manager-stat-failed INSTANCE
Function: (setf manager-stat-failed) VALUE INSTANCE
Package

psychiq.launcher.manager

Source

manager.lisp (file)

Function: manager-stat-processed INSTANCE
Function: (setf manager-stat-processed) VALUE INSTANCE
Package

psychiq.launcher.manager

Source

manager.lisp (file)

Function: manager-stopped-p INSTANCE
Function: (setf manager-stopped-p) VALUE INSTANCE
Package

psychiq.launcher.manager

Source

manager.lisp (file)

Function: omit-redis-prefix KEY &rest PREFIXES
Package

psychiq.util.redis

Source

redis.lisp (file)

Function: peek-queue QUEUE &optional START COUNT
Package

psychiq.client

Source

client.lisp (file)

Function: processor-connection INSTANCE
Function: (setf processor-connection) VALUE INSTANCE
Package

psychiq.launcher.processor

Source

processor.lisp (file)

Function: processor-id INSTANCE
Function: (setf processor-id) VALUE INSTANCE
Package

psychiq.launcher.processor

Source

processor.lisp (file)

Function: processor-manager INSTANCE
Function: (setf processor-manager) VALUE INSTANCE
Package

psychiq.launcher.processor

Source

processor.lisp (file)

Function: processor-processing INSTANCE
Function: (setf processor-processing) VALUE INSTANCE
Package

psychiq.launcher.processor

Source

processor.lisp (file)

Function: processor-status INSTANCE
Function: (setf processor-status) VALUE INSTANCE
Package

psychiq.launcher.processor

Source

processor.lisp (file)

Function: processor-timeout INSTANCE
Function: (setf processor-timeout) VALUE INSTANCE
Package

psychiq.launcher.processor

Source

processor.lisp (file)

Function: queue-empty-p QUEUE
Package

psychiq.client

Source

client.lisp (file)

Function: queue-length QUEUE
Package

psychiq.client

Source

client.lisp (file)

Function: reconnect CONN
Package

psychiq.connection

Source

connection.lisp (file)

Function: redis-key &rest KEYS
Package

psychiq.util.redis

Source

redis.lisp (file)

Function: reset-value VAR
Package

psychiq.util.concurrency

Source

concurrency.lisp (file)

Function: retry-length ()
Package

psychiq.client

Source

client.lisp (file)

Function: run &rest INITARGS &key HOST PORT DB CONCURRENCY QUEUE
Package

psychiq.launcher

Source

launcher.lisp (file)

Function: scheduled-status INSTANCE
Function: (setf scheduled-status) VALUE INSTANCE
Package

psychiq.launcher.scheduled

Source

scheduled.lisp (file)

Function: scheduled-thread INSTANCE
Function: (setf scheduled-thread) VALUE INSTANCE
Package

psychiq.launcher.scheduled

Source

scheduled.lisp (file)

Function: slice-queue QUEUE START &optional END
Package

psychiq.client

Source

client.lisp (file)

Function: start LAUNCHER
Package

psychiq.launcher

Source

launcher.lisp (file)

Function: start SCHEDULED
Package

psychiq.launcher.scheduled

Source

scheduled.lisp (file)

Function: start HEARTBEAT
Package

psychiq.launcher.heartbeat

Source

heartbeat.lisp (file)

Function: stats ()
Package

psychiq.client

Source

client.lisp (file)

Function: stop LAUNCHER
Package

psychiq.launcher

Source

launcher.lisp (file)

Function: stop SCHEDULED
Package

psychiq.launcher.scheduled

Source

scheduled.lisp (file)

Function: stop HEARTBEAT
Package

psychiq.launcher.heartbeat

Source

heartbeat.lisp (file)

Function: symbol-name-with-package SYMBOL
Package

psychiq.util

Source

util.lisp (file)

Function: wait-for LAUNCHER
Package

psychiq.launcher

Source

launcher.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.4 Generic functions

Generic Function: close-connection CONN
Package

psychiq.connection

Source

connection.lisp (file)

Methods
Method: close-connection (CONN connection)
Generic Function: connectedp CONN
Package

psychiq.connection

Source

connection.lisp (file)

Methods
Method: connectedp (CONN connection)
Generic Function: fetch-job PROCESSOR
Package

psychiq.launcher.processor

Source

processor.lisp (file)

Methods
Method: fetch-job (PROCESSOR processor)
Generic Function: finalize PROCESSOR
Package

psychiq.launcher.processor

Source

processor.lisp (file)

Methods
Method: finalize (PROCESSOR processor) after
Source

manager.lisp (file)

Method: finalize (PROCESSOR processor)
Generic Function: kill PROCESSOR
Package

psychiq.launcher.processor

Source

processor.lisp (file)

Methods
Method: kill (MANAGER manager)
Source

manager.lisp (file)

Method: kill (PROCESSOR processor)
Generic Function: open-connection CONN
Package

psychiq.connection

Source

connection.lisp (file)

Methods
Method: open-connection (CONN connection)
Generic Function: perform WORKER &rest ARGS
Package

psychiq.worker

Source

worker.lisp (file)

Methods
Method: perform (WORKER worker) &rest ARGS
Generic Function: perform-job PROCESSOR QUEUE WORKER &rest ARGS
Package

psychiq.launcher.processor

Source

processor.lisp (file)

Methods
Method: perform-job (PROCESSOR processor) QUEUE WORKER &rest ARGS
Generic Function: process-job PROCESSOR QUEUE JOB-INFO
Package

psychiq.launcher.processor

Source

processor.lisp (file)

Methods
Method: process-job (PROCESSOR processor) QUEUE JOB-INFO around
Source

manager.lisp (file)

Method: process-job (PROCESSOR processor) QUEUE JOB-INFO
Generic Function: run PROCESSOR
Package

psychiq.launcher.processor

Source

processor.lisp (file)

Methods
Method: run (PROCESSOR processor) around
Source

manager.lisp (file)

Method: run (PROCESSOR processor)
Generic Function: start PROCESSOR
Package

psychiq.launcher.processor

Source

processor.lisp (file)

Methods
Method: start (MANAGER manager)
Source

manager.lisp (file)

Method: start (PROCESSOR processor)
Generic Function: stop PROCESSOR
Package

psychiq.launcher.processor

Source

processor.lisp (file)

Methods
Method: stop (MANAGER manager)
Source

manager.lisp (file)

Method: stop (PROCESSOR processor)
Generic Function: wait-for OBJECT
Package

psychiq.launcher.processor

Source

processor.lisp (file)

Methods
Method: wait-for (MANAGER manager)
Source

manager.lisp (file)

Method: wait-for (PROCESSOR processor)
Generic Function: worker-max-retries WORKER
Package

psychiq.worker

Source

worker.lisp (file)

Methods
Method: worker-max-retries (WORKER worker)
Generic Function: worker-queue-name WORKER
Package

psychiq.worker

Source

worker.lisp (file)

Methods
Method: worker-queue-name (WORKER worker)
Generic Function: worker-use-backtrace-p WORKER
Package

psychiq.worker

Source

worker.lisp (file)

Methods
Method: worker-use-backtrace-p (WORKER worker)
Generic Function: worker-use-dead-queue-p WORKER
Package

psychiq.worker

Source

worker.lisp (file)

Methods
Method: worker-use-dead-queue-p (WORKER worker)

Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.5 Structures

Structure: heartbeat ()
Package

psychiq.launcher.heartbeat

Source

heartbeat.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots
Slot: host
Readers

heartbeat-host (function)

Writers

(setf heartbeat-host) (function)

Slot: port
Readers

heartbeat-port (function)

Writers

(setf heartbeat-port) (function)

Slot: db
Readers

heartbeat-db (function)

Writers

(setf heartbeat-db) (function)

Slot: thread
Readers

heartbeat-thread (function)

Writers

(setf heartbeat-thread) (function)

Slot: stopped-p
Initform

t

Readers

heartbeat-stopped-p (function)

Writers

(setf heartbeat-stopped-p) (function)

Slot: manager
Readers

heartbeat-manager (function)

Writers

(setf heartbeat-manager) (function)

Structure: launcher ()
Package

psychiq.launcher

Source

launcher.lisp (file)

Direct superclasses

structure-object (structure)

Direct methods

print-object (method)

Direct slots
Slot: manager
Readers

launcher-manager (function)

Writers

(setf launcher-manager) (function)

Slot: scheduled
Readers

launcher-scheduled (function)

Writers

(setf launcher-scheduled) (function)

Slot: heartbeat
Readers

launcher-heartbeat (function)

Writers

(setf launcher-heartbeat) (function)

Structure: manager ()
Package

psychiq.launcher.manager

Source

manager.lisp (file)

Direct superclasses

structure-object (structure)

Direct methods
Direct slots
Slot: host
Readers

manager-host (function)

Writers

(setf manager-host) (function)

Slot: port
Readers

manager-port (function)

Writers

(setf manager-port) (function)

Slot: db
Readers

manager-db (function)

Writers

(setf manager-db) (function)

Slot: queues
Initform

(quote nil)

Readers

manager-queues (function)

Writers

(setf manager-queues) (function)

Slot: count
Initform

25

Readers

manager-count (function)

Writers

(setf manager-count) (function)

Slot: children
Initform

(quote nil)

Readers

manager-children (function)

Writers

(setf manager-children) (function)

Slot: lock
Initform

(bordeaux-threads:make-recursive-lock)

Readers

manager-lock (function)

Writers

(setf manager-lock) (function)

Slot: stopped-p
Initform

t

Readers

manager-stopped-p (function)

Writers

(setf manager-stopped-p) (function)

Slot: stat-processed
Readers

manager-stat-processed (function)

Writers

(setf manager-stat-processed) (function)

Slot: stat-failed
Readers

manager-stat-failed (function)

Writers

(setf manager-stat-failed) (function)

Slot: make-processor-fn
Readers

manager-make-processor-fn (function)

Writers

(setf manager-make-processor-fn) (function)

Structure: processor ()
Package

psychiq.launcher.processor

Source

processor.lisp (file)

Direct superclasses

structure-object (structure)

Direct methods
Direct slots
Slot: id
Initform

(psychiq.util:generate-random-id 9)

Readers

processor-id (function)

Writers

(setf processor-id) (function)

Slot: connection
Type

psychiq.connection:connection

Readers

processor-connection (function)

Writers

(setf processor-connection) (function)

Slot: queues
Type

list

Initform

(quote nil)

Readers

processor-queues (function)

Writers

(setf processor-queues) (function)

Slot: manager
Readers

processor-manager (function)

Writers

(setf processor-manager) (function)

Slot: thread
Readers

processor-thread (function)

Writers

(setf processor-thread) (function)

Slot: status
Initform

:stopped

Readers

processor-status (function)

Writers

(setf processor-status) (function)

Slot: timeout
Initform

5

Readers

processor-timeout (function)

Writers

(setf processor-timeout) (function)

Slot: down
Readers

processor-down (function)

Writers

(setf processor-down) (function)

Slot: processing
Readers

processor-processing (function)

Writers

(setf processor-processing) (function)

Structure: scheduled ()
Package

psychiq.launcher.scheduled

Source

scheduled.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots
Slot: connection
Readers

scheduled-connection (function)

Writers

(setf scheduled-connection) (function)

Slot: thread
Readers

scheduled-thread (function)

Writers

(setf scheduled-thread) (function)

Slot: status
Initform

:stopped

Readers

scheduled-status (function)

Writers

(setf scheduled-status) (function)


Previous: , Up: Exported definitions   [Contents][Index]

6.1.6 Classes

Class: connection ()
Package

psychiq.connection

Source

connection.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: host
Type

string

Initargs

:host

Initform

psychiq.specials:*default-redis-host*

Slot: port
Type

integer

Initargs

:port

Initform

psychiq.specials:*default-redis-port*

Slot: db
Type

(or integer null)

Initargs

:db

Slot: redis
Type

(or redis:redis-connection null)

Readers

redis-connection (generic function)

Writers

(setf redis-connection) (generic function)

Class: worker ()
Package

psychiq.worker

Source

worker.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

Previous: , Up: Definitions   [Contents][Index]

6.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.1 Special variables

Special Variable: *dead-max-jobs*
Package

psychiq.middleware.retry-jobs

Source

retry-jobs.lisp (file)

Special Variable: *dead-timeout-in-seconds*
Package

psychiq.middleware.retry-jobs

Source

retry-jobs.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.2 Functions

Function: %make-launcher &key (MANAGER MANAGER) (SCHEDULED SCHEDULED) (HEARTBEAT HEARTBEAT)
Package

psychiq.launcher

Source

launcher.lisp (file)

Function: %make-manager &key HOST PORT DB QUEUES COUNT LOCK &aux STAT-PROCESSED STAT-FAILED
Package

psychiq.launcher.manager

Source

manager.lisp (file)

Function: %make-processor &key (ID ID) (CONNECTION CONNECTION) (QUEUES QUEUES) (MANAGER MANAGER) (THREAD THREAD) (STATUS STATUS) (TIMEOUT TIMEOUT) (DOWN DOWN) (PROCESSING PROCESSING)
Package

psychiq.launcher.processor

Source

processor.lisp (file)

Function: %make-scheduled &key (CONNECTION CONNECTION) (THREAD THREAD) (STATUS STATUS)
Package

psychiq.launcher.scheduled

Source

scheduled.lisp (file)

Function: attempt-retry QUEUE WORKER JOB-INFO E
Package

psychiq.middleware.retry-jobs

Source

retry-jobs.lisp (file)

Function: backtrace &optional COUNT-TO-REMOVE
Package

psychiq.middleware.retry-jobs

Source

retry-jobs.lisp (file)

Function: clear-heartbeat HEARTBEAT
Package

psychiq.launcher.heartbeat

Source

heartbeat.lisp (file)

Function: copy-heartbeat INSTANCE
Package

psychiq.launcher.heartbeat

Source

heartbeat.lisp (file)

Function: copy-launcher INSTANCE
Package

psychiq.launcher

Source

launcher.lisp (file)

Function: copy-manager INSTANCE
Package

psychiq.launcher.manager

Source

manager.lisp (file)

Function: copy-processor INSTANCE
Package

psychiq.launcher.processor

Source

processor.lisp (file)

Function: copy-scheduled INSTANCE
Package

psychiq.launcher.scheduled

Source

scheduled.lisp (file)

Function: copy-thread-safe-variable INSTANCE
Package

psychiq.util.concurrency

Source

concurrency.lisp (file)

Function: decode-objects OBJECTS
Package

psychiq.client

Source

client.lisp (file)

Function: delay-for RETRY-COUNT
Package

psychiq.middleware.retry-jobs

Source

retry-jobs.lisp (file)

Function: enqueue-jobs NOW
Package

psychiq.launcher.scheduled

Source

scheduled.lisp (file)

Function: heartbeat-db INSTANCE
Function: (setf heartbeat-db) VALUE INSTANCE
Package

psychiq.launcher.heartbeat

Source

heartbeat.lisp (file)

Function: heartbeat-host INSTANCE
Function: (setf heartbeat-host) VALUE INSTANCE
Package

psychiq.launcher.heartbeat

Source

heartbeat.lisp (file)

Function: heartbeat-manager INSTANCE
Function: (setf heartbeat-manager) VALUE INSTANCE
Package

psychiq.launcher.heartbeat

Source

heartbeat.lisp (file)

Function: heartbeat-p OBJECT
Package

psychiq.launcher.heartbeat

Source

heartbeat.lisp (file)

Function: heartbeat-port INSTANCE
Function: (setf heartbeat-port) VALUE INSTANCE
Package

psychiq.launcher.heartbeat

Source

heartbeat.lisp (file)

Function: heartbeat-stopped-p INSTANCE
Function: (setf heartbeat-stopped-p) VALUE INSTANCE
Package

psychiq.launcher.heartbeat

Source

heartbeat.lisp (file)

Function: heartbeat-thread INSTANCE
Function: (setf heartbeat-thread) VALUE INSTANCE
Package

psychiq.launcher.heartbeat

Source

heartbeat.lisp (file)

Function: launcher-heartbeat INSTANCE
Function: (setf launcher-heartbeat) VALUE INSTANCE
Package

psychiq.launcher

Source

launcher.lisp (file)

Function: launcher-manager INSTANCE
Function: (setf launcher-manager) VALUE INSTANCE
Package

psychiq.launcher

Source

launcher.lisp (file)

Function: launcher-p OBJECT
Package

psychiq.launcher

Source

launcher.lisp (file)

Function: launcher-scheduled INSTANCE
Function: (setf launcher-scheduled) VALUE INSTANCE
Package

psychiq.launcher

Source

launcher.lisp (file)

Function: make-child-processors MANAGER
Package

psychiq.launcher.manager

Source

manager.lisp (file)

Function: make-launcher &key HOST PORT DB CONCURRENCY QUEUE INTERVAL
Package

psychiq.launcher

Source

launcher.lisp (file)

Function: manager-db INSTANCE
Function: (setf manager-db) VALUE INSTANCE
Package

psychiq.launcher.manager

Source

manager.lisp (file)

Function: manager-host INSTANCE
Function: (setf manager-host) VALUE INSTANCE
Package

psychiq.launcher.manager

Source

manager.lisp (file)

Function: manager-lock INSTANCE
Function: (setf manager-lock) VALUE INSTANCE
Package

psychiq.launcher.manager

Source

manager.lisp (file)

Function: manager-make-processor-fn INSTANCE
Function: (setf manager-make-processor-fn) VALUE INSTANCE
Package

psychiq.launcher.manager

Source

manager.lisp (file)

Function: manager-p OBJECT
Package

psychiq.launcher.manager

Source

manager.lisp (file)

Function: manager-port INSTANCE
Function: (setf manager-port) VALUE INSTANCE
Package

psychiq.launcher.manager

Source

manager.lisp (file)

Function: processor-died MANAGER PROCESSOR E
Package

psychiq.launcher.manager

Source

manager.lisp (file)

Function: processor-down INSTANCE
Function: (setf processor-down) VALUE INSTANCE
Package

psychiq.launcher.processor

Source

processor.lisp (file)

Function: processor-p OBJECT
Package

psychiq.launcher.processor

Source

processor.lisp (file)

Function: processor-queues INSTANCE
Function: (setf processor-queues) VALUE INSTANCE
Package

psychiq.launcher.processor

Source

processor.lisp (file)

Function: processor-stopped MANAGER PROCESSOR
Package

psychiq.launcher.manager

Source

manager.lisp (file)

Function: processor-thread INSTANCE
Function: (setf processor-thread) VALUE INSTANCE
Package

psychiq.launcher.processor

Source

processor.lisp (file)

Function: run HEARTBEAT
Package

psychiq.launcher.heartbeat

Source

heartbeat.lisp (file)

Function: scaled-poll-interval ()
Package

psychiq.launcher.scheduled

Source

scheduled.lisp (file)

Function: scheduled-connection INSTANCE
Function: (setf scheduled-connection) VALUE INSTANCE
Package

psychiq.launcher.scheduled

Source

scheduled.lisp (file)

Function: scheduled-p OBJECT
Package

psychiq.launcher.scheduled

Source

scheduled.lisp (file)

Function: send-to-morgue JOB-INFO
Package

psychiq.middleware.retry-jobs

Source

retry-jobs.lisp (file)

Function: thread-safe-variable-initial-value INSTANCE
Function: (setf thread-safe-variable-initial-value) VALUE INSTANCE
Package

psychiq.util.concurrency

Source

concurrency.lisp (file)

Function: thread-safe-variable-lock INSTANCE
Function: (setf thread-safe-variable-lock) VALUE INSTANCE
Package

psychiq.util.concurrency

Source

concurrency.lisp (file)

Function: thread-safe-variable-p OBJECT
Package

psychiq.util.concurrency

Source

concurrency.lisp (file)

Function: thread-safe-variable-value INSTANCE
Function: (setf thread-safe-variable-value) VALUE INSTANCE
Package

psychiq.util.concurrency

Source

concurrency.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.3 Generic functions

Generic Function: redis-connection OBJECT
Generic Function: (setf redis-connection) NEW-VALUE OBJECT
Package

psychiq.connection

Methods
Method: redis-connection (CONNECTION connection)

automatically generated reader method

Source

connection.lisp (file)

Method: (setf redis-connection) NEW-VALUE (CONNECTION connection)

automatically generated writer method

Source

connection.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

6.2.4 Structures

Structure: thread-safe-variable ()
Package

psychiq.util.concurrency

Source

concurrency.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots
Slot: initial-value
Readers

thread-safe-variable-initial-value (function)

Writers

(setf thread-safe-variable-initial-value) (function)

Slot: value
Readers

thread-safe-variable-value (function)

Writers

(setf thread-safe-variable-value) (function)

Slot: lock
Initform

(bordeaux-threads:make-recursive-lock)

Readers

thread-safe-variable-lock (function)

Writers

(setf thread-safe-variable-lock) (function)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   F   L   M   P  
Index Entry  Section

F
File, Lisp, psychiq.asd: The psychiq<dot>asd file
File, Lisp, psychiq/src/client.lisp: The psychiq/src/client<dot>lisp file
File, Lisp, psychiq/src/core/coder.lisp: The psychiq/src/core/coder<dot>lisp file
File, Lisp, psychiq/src/core/connection.lisp: The psychiq/src/core/connection<dot>lisp file
File, Lisp, psychiq/src/core/queue.lisp: The psychiq/src/core/queue<dot>lisp file
File, Lisp, psychiq/src/core/worker.lisp: The psychiq/src/core/worker<dot>lisp file
File, Lisp, psychiq/src/launcher-core/heartbeat.lisp: The psychiq/src/launcher-core/heartbeat<dot>lisp file
File, Lisp, psychiq/src/launcher-core/manager.lisp: The psychiq/src/launcher-core/manager<dot>lisp file
File, Lisp, psychiq/src/launcher-core/processor.lisp: The psychiq/src/launcher-core/processor<dot>lisp file
File, Lisp, psychiq/src/launcher-core/scheduled.lisp: The psychiq/src/launcher-core/scheduled<dot>lisp file
File, Lisp, psychiq/src/launcher.lisp: The psychiq/src/launcher<dot>lisp file
File, Lisp, psychiq/src/middleware/logging.lisp: The psychiq/src/middleware/logging<dot>lisp file
File, Lisp, psychiq/src/middleware/retry-jobs.lisp: The psychiq/src/middleware/retry-jobs<dot>lisp file
File, Lisp, psychiq/src/psychiq.lisp: The psychiq/src/psychiq<dot>lisp file
File, Lisp, psychiq/src/specials.lisp: The psychiq/src/specials<dot>lisp file
File, Lisp, psychiq/src/util/assoc.lisp: The psychiq/src/util/assoc<dot>lisp file
File, Lisp, psychiq/src/util/concurrency.lisp: The psychiq/src/util/concurrency<dot>lisp file
File, Lisp, psychiq/src/util/redis.lisp: The psychiq/src/util/redis<dot>lisp file
File, Lisp, psychiq/src/util/util.lisp: The psychiq/src/util/util<dot>lisp file

L
Lisp File, psychiq.asd: The psychiq<dot>asd file
Lisp File, psychiq/src/client.lisp: The psychiq/src/client<dot>lisp file
Lisp File, psychiq/src/core/coder.lisp: The psychiq/src/core/coder<dot>lisp file
Lisp File, psychiq/src/core/connection.lisp: The psychiq/src/core/connection<dot>lisp file
Lisp File, psychiq/src/core/queue.lisp: The psychiq/src/core/queue<dot>lisp file
Lisp File, psychiq/src/core/worker.lisp: The psychiq/src/core/worker<dot>lisp file
Lisp File, psychiq/src/launcher-core/heartbeat.lisp: The psychiq/src/launcher-core/heartbeat<dot>lisp file
Lisp File, psychiq/src/launcher-core/manager.lisp: The psychiq/src/launcher-core/manager<dot>lisp file
Lisp File, psychiq/src/launcher-core/processor.lisp: The psychiq/src/launcher-core/processor<dot>lisp file
Lisp File, psychiq/src/launcher-core/scheduled.lisp: The psychiq/src/launcher-core/scheduled<dot>lisp file
Lisp File, psychiq/src/launcher.lisp: The psychiq/src/launcher<dot>lisp file
Lisp File, psychiq/src/middleware/logging.lisp: The psychiq/src/middleware/logging<dot>lisp file
Lisp File, psychiq/src/middleware/retry-jobs.lisp: The psychiq/src/middleware/retry-jobs<dot>lisp file
Lisp File, psychiq/src/psychiq.lisp: The psychiq/src/psychiq<dot>lisp file
Lisp File, psychiq/src/specials.lisp: The psychiq/src/specials<dot>lisp file
Lisp File, psychiq/src/util/assoc.lisp: The psychiq/src/util/assoc<dot>lisp file
Lisp File, psychiq/src/util/concurrency.lisp: The psychiq/src/util/concurrency<dot>lisp file
Lisp File, psychiq/src/util/redis.lisp: The psychiq/src/util/redis<dot>lisp file
Lisp File, psychiq/src/util/util.lisp: The psychiq/src/util/util<dot>lisp file

M
Module, psychiq/src: The psychiq/src module
Module, psychiq/src/core: The psychiq/src/core module
Module, psychiq/src/launcher-core: The psychiq/src/launcher-core module
Module, psychiq/src/middleware: The psychiq/src/middleware module
Module, psychiq/src/util: The psychiq/src/util module

P
psychiq.asd: The psychiq<dot>asd file
psychiq/src: The psychiq/src module
psychiq/src/client.lisp: The psychiq/src/client<dot>lisp file
psychiq/src/core: The psychiq/src/core module
psychiq/src/core/coder.lisp: The psychiq/src/core/coder<dot>lisp file
psychiq/src/core/connection.lisp: The psychiq/src/core/connection<dot>lisp file
psychiq/src/core/queue.lisp: The psychiq/src/core/queue<dot>lisp file
psychiq/src/core/worker.lisp: The psychiq/src/core/worker<dot>lisp file
psychiq/src/launcher-core: The psychiq/src/launcher-core module
psychiq/src/launcher-core/heartbeat.lisp: The psychiq/src/launcher-core/heartbeat<dot>lisp file
psychiq/src/launcher-core/manager.lisp: The psychiq/src/launcher-core/manager<dot>lisp file
psychiq/src/launcher-core/processor.lisp: The psychiq/src/launcher-core/processor<dot>lisp file
psychiq/src/launcher-core/scheduled.lisp: The psychiq/src/launcher-core/scheduled<dot>lisp file
psychiq/src/launcher.lisp: The psychiq/src/launcher<dot>lisp file
psychiq/src/middleware: The psychiq/src/middleware module
psychiq/src/middleware/logging.lisp: The psychiq/src/middleware/logging<dot>lisp file
psychiq/src/middleware/retry-jobs.lisp: The psychiq/src/middleware/retry-jobs<dot>lisp file
psychiq/src/psychiq.lisp: The psychiq/src/psychiq<dot>lisp file
psychiq/src/specials.lisp: The psychiq/src/specials<dot>lisp file
psychiq/src/util: The psychiq/src/util module
psychiq/src/util/assoc.lisp: The psychiq/src/util/assoc<dot>lisp file
psychiq/src/util/concurrency.lisp: The psychiq/src/util/concurrency<dot>lisp file
psychiq/src/util/redis.lisp: The psychiq/src/util/redis<dot>lisp file
psychiq/src/util/util.lisp: The psychiq/src/util/util<dot>lisp file

Jump to:   F   L   M   P  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   %   (  
A   B   C   D   E   F   G   H   K   L   M   O   P   Q   R   S   T   W  
Index Entry  Section

%
%make-launcher: Internal functions
%make-manager: Internal functions
%make-processor: Internal functions
%make-scheduled: Internal functions

(
(setf aget): Exported functions
(setf get-value): Exported functions
(setf heartbeat-db): Internal functions
(setf heartbeat-host): Internal functions
(setf heartbeat-manager): Internal functions
(setf heartbeat-port): Internal functions
(setf heartbeat-stopped-p): Internal functions
(setf heartbeat-thread): Internal functions
(setf launcher-heartbeat): Internal functions
(setf launcher-manager): Internal functions
(setf launcher-scheduled): Internal functions
(setf manager-children): Exported functions
(setf manager-count): Exported functions
(setf manager-db): Internal functions
(setf manager-host): Internal functions
(setf manager-lock): Internal functions
(setf manager-make-processor-fn): Internal functions
(setf manager-port): Internal functions
(setf manager-queues): Exported functions
(setf manager-stat-failed): Exported functions
(setf manager-stat-processed): Exported functions
(setf manager-stopped-p): Exported functions
(setf processor-connection): Exported functions
(setf processor-down): Internal functions
(setf processor-id): Exported functions
(setf processor-manager): Exported functions
(setf processor-processing): Exported functions
(setf processor-queues): Internal functions
(setf processor-status): Exported functions
(setf processor-thread): Internal functions
(setf processor-timeout): Exported functions
(setf redis-connection): Internal generic functions
(setf redis-connection): Internal generic functions
(setf scheduled-connection): Internal functions
(setf scheduled-status): Exported functions
(setf scheduled-thread): Exported functions
(setf thread-safe-variable-initial-value): Internal functions
(setf thread-safe-variable-lock): Internal functions
(setf thread-safe-variable-value): Internal functions

A
aget: Exported functions
all-dead-jobs: Exported functions
all-queues: Exported functions
all-retries: Exported functions
attempt-retry: Internal functions

B
backtrace: Internal functions

C
cleanup-processes: Exported functions
clear-heartbeat: Internal functions
close-connection: Exported generic functions
close-connection: Exported generic functions
connect: Exported functions
connect-toplevel: Exported functions
connectedp: Exported generic functions
connectedp: Exported generic functions
copy-heartbeat: Internal functions
copy-launcher: Internal functions
copy-manager: Internal functions
copy-processor: Internal functions
copy-scheduled: Internal functions
copy-thread-safe-variable: Internal functions

D
decode-job: Exported functions
decode-object: Exported functions
decode-objects: Internal functions
delay-for: Internal functions
delete-queue: Exported functions
dequeue: Exported functions
dequeue-from-queue: Exported functions
disconnect: Exported functions
disconnect-toplevel: Exported functions

E
encode-job: Exported functions
encode-object: Exported functions
enqueue: Exported functions
enqueue-bulk: Exported functions
enqueue-in-sec: Exported functions
enqueue-jobs: Internal functions
enqueue-to-queue: Exported functions
enqueue-to-scheduled-queue: Exported functions
ensure-connected: Exported functions

F
fetch-job: Exported generic functions
fetch-job: Exported generic functions
finalize: Exported generic functions
finalize: Exported generic functions
finalize: Exported generic functions
Function, %make-launcher: Internal functions
Function, %make-manager: Internal functions
Function, %make-processor: Internal functions
Function, %make-scheduled: Internal functions
Function, (setf aget): Exported functions
Function, (setf get-value): Exported functions
Function, (setf heartbeat-db): Internal functions
Function, (setf heartbeat-host): Internal functions
Function, (setf heartbeat-manager): Internal functions
Function, (setf heartbeat-port): Internal functions
Function, (setf heartbeat-stopped-p): Internal functions
Function, (setf heartbeat-thread): Internal functions
Function, (setf launcher-heartbeat): Internal functions
Function, (setf launcher-manager): Internal functions
Function, (setf launcher-scheduled): Internal functions
Function, (setf manager-children): Exported functions
Function, (setf manager-count): Exported functions
Function, (setf manager-db): Internal functions
Function, (setf manager-host): Internal functions
Function, (setf manager-lock): Internal functions
Function, (setf manager-make-processor-fn): Internal functions
Function, (setf manager-port): Internal functions
Function, (setf manager-queues): Exported functions
Function, (setf manager-stat-failed): Exported functions
Function, (setf manager-stat-processed): Exported functions
Function, (setf manager-stopped-p): Exported functions
Function, (setf processor-connection): Exported functions
Function, (setf processor-down): Internal functions
Function, (setf processor-id): Exported functions
Function, (setf processor-manager): Exported functions
Function, (setf processor-processing): Exported functions
Function, (setf processor-queues): Internal functions
Function, (setf processor-status): Exported functions
Function, (setf processor-thread): Internal functions
Function, (setf processor-timeout): Exported functions
Function, (setf scheduled-connection): Internal functions
Function, (setf scheduled-status): Exported functions
Function, (setf scheduled-thread): Exported functions
Function, (setf thread-safe-variable-initial-value): Internal functions
Function, (setf thread-safe-variable-lock): Internal functions
Function, (setf thread-safe-variable-value): Internal functions
Function, aget: Exported functions
Function, all-dead-jobs: Exported functions
Function, all-queues: Exported functions
Function, all-retries: Exported functions
Function, attempt-retry: Internal functions
Function, backtrace: Internal functions
Function, cleanup-processes: Exported functions
Function, clear-heartbeat: Internal functions
Function, connect: Exported functions
Function, connect-toplevel: Exported functions
Function, copy-heartbeat: Internal functions
Function, copy-launcher: Internal functions
Function, copy-manager: Internal functions
Function, copy-processor: Internal functions
Function, copy-scheduled: Internal functions
Function, copy-thread-safe-variable: Internal functions
Function, decode-job: Exported functions
Function, decode-object: Exported functions
Function, decode-objects: Internal functions
Function, delay-for: Internal functions
Function, delete-queue: Exported functions
Function, dequeue: Exported functions
Function, dequeue-from-queue: Exported functions
Function, disconnect: Exported functions
Function, disconnect-toplevel: Exported functions
Function, encode-job: Exported functions
Function, encode-object: Exported functions
Function, enqueue: Exported functions
Function, enqueue-bulk: Exported functions
Function, enqueue-in-sec: Exported functions
Function, enqueue-jobs: Internal functions
Function, enqueue-to-queue: Exported functions
Function, enqueue-to-scheduled-queue: Exported functions
Function, ensure-connected: Exported functions
Function, generate-random-id: Exported functions
Function, get-value: Exported functions
Function, getpid: Exported functions
Function, heartbeat: Exported functions
Function, heartbeat-db: Internal functions
Function, heartbeat-host: Internal functions
Function, heartbeat-manager: Internal functions
Function, heartbeat-p: Internal functions
Function, heartbeat-port: Internal functions
Function, heartbeat-stopped-p: Internal functions
Function, heartbeat-thread: Internal functions
Function, kill: Exported functions
Function, kill: Exported functions
Function, kill: Exported functions
Function, launcher-heartbeat: Internal functions
Function, launcher-manager: Internal functions
Function, launcher-p: Internal functions
Function, launcher-scheduled: Internal functions
Function, launcher-status: Exported functions
Function, machine-identity: Exported functions
Function, make-child-processors: Internal functions
Function, make-connection: Exported functions
Function, make-heartbeat: Exported functions
Function, make-launcher: Internal functions
Function, make-manager: Exported functions
Function, make-processor: Exported functions
Function, make-scheduled: Exported functions
Function, make-thread-safe-variable: Exported functions
Function, manager-children: Exported functions
Function, manager-count: Exported functions
Function, manager-db: Internal functions
Function, manager-host: Internal functions
Function, manager-lock: Internal functions
Function, manager-make-processor-fn: Internal functions
Function, manager-p: Internal functions
Function, manager-port: Internal functions
Function, manager-queues: Exported functions
Function, manager-stat-failed: Exported functions
Function, manager-stat-processed: Exported functions
Function, manager-stopped-p: Exported functions
Function, omit-redis-prefix: Exported functions
Function, peek-queue: Exported functions
Function, processor-connection: Exported functions
Function, processor-died: Internal functions
Function, processor-down: Internal functions
Function, processor-id: Exported functions
Function, processor-manager: Exported functions
Function, processor-p: Internal functions
Function, processor-processing: Exported functions
Function, processor-queues: Internal functions
Function, processor-status: Exported functions
Function, processor-stopped: Internal functions
Function, processor-thread: Internal functions
Function, processor-timeout: Exported functions
Function, queue-empty-p: Exported functions
Function, queue-length: Exported functions
Function, reconnect: Exported functions
Function, redis-key: Exported functions
Function, reset-value: Exported functions
Function, retry-length: Exported functions
Function, run: Exported functions
Function, run: Internal functions
Function, scaled-poll-interval: Internal functions
Function, scheduled-connection: Internal functions
Function, scheduled-p: Internal functions
Function, scheduled-status: Exported functions
Function, scheduled-thread: Exported functions
Function, send-to-morgue: Internal functions
Function, slice-queue: Exported functions
Function, start: Exported functions
Function, start: Exported functions
Function, start: Exported functions
Function, stats: Exported functions
Function, stop: Exported functions
Function, stop: Exported functions
Function, stop: Exported functions
Function, symbol-name-with-package: Exported functions
Function, thread-safe-variable-initial-value: Internal functions
Function, thread-safe-variable-lock: Internal functions
Function, thread-safe-variable-p: Internal functions
Function, thread-safe-variable-value: Internal functions
Function, wait-for: Exported functions

G
generate-random-id: Exported functions
Generic Function, (setf redis-connection): Internal generic functions
Generic Function, close-connection: Exported generic functions
Generic Function, connectedp: Exported generic functions
Generic Function, fetch-job: Exported generic functions
Generic Function, finalize: Exported generic functions
Generic Function, kill: Exported generic functions
Generic Function, open-connection: Exported generic functions
Generic Function, perform: Exported generic functions
Generic Function, perform-job: Exported generic functions
Generic Function, process-job: Exported generic functions
Generic Function, redis-connection: Internal generic functions
Generic Function, run: Exported generic functions
Generic Function, start: Exported generic functions
Generic Function, stop: Exported generic functions
Generic Function, wait-for: Exported generic functions
Generic Function, worker-max-retries: Exported generic functions
Generic Function, worker-queue-name: Exported generic functions
Generic Function, worker-use-backtrace-p: Exported generic functions
Generic Function, worker-use-dead-queue-p: Exported generic functions
get-value: Exported functions
getpid: Exported functions

H
heartbeat: Exported functions
heartbeat-db: Internal functions
heartbeat-host: Internal functions
heartbeat-manager: Internal functions
heartbeat-p: Internal functions
heartbeat-port: Internal functions
heartbeat-stopped-p: Internal functions
heartbeat-thread: Internal functions

K
kill: Exported functions
kill: Exported functions
kill: Exported functions
kill: Exported generic functions
kill: Exported generic functions
kill: Exported generic functions

L
launcher-heartbeat: Internal functions
launcher-manager: Internal functions
launcher-p: Internal functions
launcher-scheduled: Internal functions
launcher-status: Exported functions

M
machine-identity: Exported functions
Macro, with-connection: Exported macros
Macro, with-redis-transaction: Exported macros
make-child-processors: Internal functions
make-connection: Exported functions
make-heartbeat: Exported functions
make-launcher: Internal functions
make-manager: Exported functions
make-processor: Exported functions
make-scheduled: Exported functions
make-thread-safe-variable: Exported functions
manager-children: Exported functions
manager-count: Exported functions
manager-db: Internal functions
manager-host: Internal functions
manager-lock: Internal functions
manager-make-processor-fn: Internal functions
manager-p: Internal functions
manager-port: Internal functions
manager-queues: Exported functions
manager-stat-failed: Exported functions
manager-stat-processed: Exported functions
manager-stopped-p: Exported functions
Method, (setf redis-connection): Internal generic functions
Method, close-connection: Exported generic functions
Method, connectedp: Exported generic functions
Method, fetch-job: Exported generic functions
Method, finalize: Exported generic functions
Method, finalize: Exported generic functions
Method, kill: Exported generic functions
Method, kill: Exported generic functions
Method, open-connection: Exported generic functions
Method, perform: Exported generic functions
Method, perform-job: Exported generic functions
Method, process-job: Exported generic functions
Method, process-job: Exported generic functions
Method, redis-connection: Internal generic functions
Method, run: Exported generic functions
Method, run: Exported generic functions
Method, start: Exported generic functions
Method, start: Exported generic functions
Method, stop: Exported generic functions
Method, stop: Exported generic functions
Method, wait-for: Exported generic functions
Method, wait-for: Exported generic functions
Method, worker-max-retries: Exported generic functions
Method, worker-queue-name: Exported generic functions
Method, worker-use-backtrace-p: Exported generic functions
Method, worker-use-dead-queue-p: Exported generic functions

O
omit-redis-prefix: Exported functions
open-connection: Exported generic functions
open-connection: Exported generic functions

P
peek-queue: Exported functions
perform: Exported generic functions
perform: Exported generic functions
perform-job: Exported generic functions
perform-job: Exported generic functions
process-job: Exported generic functions
process-job: Exported generic functions
process-job: Exported generic functions
processor-connection: Exported functions
processor-died: Internal functions
processor-down: Internal functions
processor-id: Exported functions
processor-manager: Exported functions
processor-p: Internal functions
processor-processing: Exported functions
processor-queues: Internal functions
processor-status: Exported functions
processor-stopped: Internal functions
processor-thread: Internal functions
processor-timeout: Exported functions

Q
queue-empty-p: Exported functions
queue-length: Exported functions

R
reconnect: Exported functions
redis-connection: Internal generic functions
redis-connection: Internal generic functions
redis-key: Exported functions
reset-value: Exported functions
retry-length: Exported functions
run: Exported functions
run: Exported generic functions
run: Exported generic functions
run: Exported generic functions
run: Internal functions

S
scaled-poll-interval: Internal functions
scheduled-connection: Internal functions
scheduled-p: Internal functions
scheduled-status: Exported functions
scheduled-thread: Exported functions
send-to-morgue: Internal functions
slice-queue: Exported functions
start: Exported functions
start: Exported functions
start: Exported functions
start: Exported generic functions
start: Exported generic functions
start: Exported generic functions
stats: Exported functions
stop: Exported functions
stop: Exported functions
stop: Exported functions
stop: Exported generic functions
stop: Exported generic functions
stop: Exported generic functions
symbol-name-with-package: Exported functions

T
thread-safe-variable-initial-value: Internal functions
thread-safe-variable-lock: Internal functions
thread-safe-variable-p: Internal functions
thread-safe-variable-value: Internal functions

W
wait-for: Exported functions
wait-for: Exported generic functions
wait-for: Exported generic functions
wait-for: Exported generic functions
with-connection: Exported macros
with-redis-transaction: Exported macros
worker-max-retries: Exported generic functions
worker-max-retries: Exported generic functions
worker-queue-name: Exported generic functions
worker-queue-name: Exported generic functions
worker-use-backtrace-p: Exported generic functions
worker-use-backtrace-p: Exported generic functions
worker-use-dead-queue-p: Exported generic functions
worker-use-dead-queue-p: Exported generic functions

Jump to:   %   (  
A   B   C   D   E   F   G   H   K   L   M   O   P   Q   R   S   T   W  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *  
C   D   H   I   L   M   P   Q   R   S   T   V  
Index Entry  Section

*
*connection*: Exported special variables
*dead-max-jobs*: Internal special variables
*dead-timeout-in-seconds*: Internal special variables
*default-max-retry-attempts*: Exported special variables
*default-queue-name*: Exported special variables
*default-redis-host*: Exported special variables
*default-redis-port*: Exported special variables
*psychiq-middleware-logging*: Exported special variables
*psychiq-middleware-retry-jobs*: Exported special variables
*psychiq-namespace*: Exported special variables

C
children: Exported structures
connection: Exported structures
connection: Exported structures
count: Exported structures

D
db: Exported structures
db: Exported structures
db: Exported classes
down: Exported structures

H
heartbeat: Exported structures
host: Exported structures
host: Exported structures
host: Exported classes

I
id: Exported structures
initial-value: Internal structures

L
lock: Exported structures
lock: Internal structures

M
make-processor-fn: Exported structures
manager: Exported structures
manager: Exported structures
manager: Exported structures

P
port: Exported structures
port: Exported structures
port: Exported classes
processing: Exported structures

Q
queues: Exported structures
queues: Exported structures

R
redis: Exported classes

S
scheduled: Exported structures
Slot, children: Exported structures
Slot, connection: Exported structures
Slot, connection: Exported structures
Slot, count: Exported structures
Slot, db: Exported structures
Slot, db: Exported structures
Slot, db: Exported classes
Slot, down: Exported structures
Slot, heartbeat: Exported structures
Slot, host: Exported structures
Slot, host: Exported structures
Slot, host: Exported classes
Slot, id: Exported structures
Slot, initial-value: Internal structures
Slot, lock: Exported structures
Slot, lock: Internal structures
Slot, make-processor-fn: Exported structures
Slot, manager: Exported structures
Slot, manager: Exported structures
Slot, manager: Exported structures
Slot, port: Exported structures
Slot, port: Exported structures
Slot, port: Exported classes
Slot, processing: Exported structures
Slot, queues: Exported structures
Slot, queues: Exported structures
Slot, redis: Exported classes
Slot, scheduled: Exported structures
Slot, stat-failed: Exported structures
Slot, stat-processed: Exported structures
Slot, status: Exported structures
Slot, status: Exported structures
Slot, stopped-p: Exported structures
Slot, stopped-p: Exported structures
Slot, thread: Exported structures
Slot, thread: Exported structures
Slot, thread: Exported structures
Slot, timeout: Exported structures
Slot, value: Internal structures
Special Variable, *connection*: Exported special variables
Special Variable, *dead-max-jobs*: Internal special variables
Special Variable, *dead-timeout-in-seconds*: Internal special variables
Special Variable, *default-max-retry-attempts*: Exported special variables
Special Variable, *default-queue-name*: Exported special variables
Special Variable, *default-redis-host*: Exported special variables
Special Variable, *default-redis-port*: Exported special variables
Special Variable, *psychiq-middleware-logging*: Exported special variables
Special Variable, *psychiq-middleware-retry-jobs*: Exported special variables
Special Variable, *psychiq-namespace*: Exported special variables
stat-failed: Exported structures
stat-processed: Exported structures
status: Exported structures
status: Exported structures
stopped-p: Exported structures
stopped-p: Exported structures

T
thread: Exported structures
thread: Exported structures
thread: Exported structures
timeout: Exported structures

V
value: Internal structures

Jump to:   *  
C   D   H   I   L   M   P   Q   R   S   T   V  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   H   L   M   P   S   T   W  
Index Entry  Section

C
Class, connection: Exported classes
Class, worker: Exported classes
connection: Exported classes

H
heartbeat: Exported structures

L
launcher: Exported structures

M
manager: Exported structures

P
Package, psychiq: The psychiq package
Package, psychiq.client: The psychiq<dot>client package
Package, psychiq.coder: The psychiq<dot>coder package
Package, psychiq.connection: The psychiq<dot>connection package
Package, psychiq.launcher: The psychiq<dot>launcher package
Package, psychiq.launcher.heartbeat: The psychiq<dot>launcher<dot>heartbeat package
Package, psychiq.launcher.manager: The psychiq<dot>launcher<dot>manager package
Package, psychiq.launcher.processor: The psychiq<dot>launcher<dot>processor package
Package, psychiq.launcher.scheduled: The psychiq<dot>launcher<dot>scheduled package
Package, psychiq.middleware.logging: The psychiq<dot>middleware<dot>logging package
Package, psychiq.middleware.retry-jobs: The psychiq<dot>middleware<dot>retry-jobs package
Package, psychiq.queue: The psychiq<dot>queue package
Package, psychiq.specials: The psychiq<dot>specials package
Package, psychiq.util: The psychiq<dot>util package
Package, psychiq.util.assoc: The psychiq<dot>util<dot>assoc package
Package, psychiq.util.concurrency: The psychiq<dot>util<dot>concurrency package
Package, psychiq.util.redis: The psychiq<dot>util<dot>redis package
Package, psychiq.worker: The psychiq<dot>worker package
processor: Exported structures
psychiq: The psychiq system
psychiq: The psychiq package
psychiq.client: The psychiq<dot>client package
psychiq.coder: The psychiq<dot>coder package
psychiq.connection: The psychiq<dot>connection package
psychiq.launcher: The psychiq<dot>launcher package
psychiq.launcher.heartbeat: The psychiq<dot>launcher<dot>heartbeat package
psychiq.launcher.manager: The psychiq<dot>launcher<dot>manager package
psychiq.launcher.processor: The psychiq<dot>launcher<dot>processor package
psychiq.launcher.scheduled: The psychiq<dot>launcher<dot>scheduled package
psychiq.middleware.logging: The psychiq<dot>middleware<dot>logging package
psychiq.middleware.retry-jobs: The psychiq<dot>middleware<dot>retry-jobs package
psychiq.queue: The psychiq<dot>queue package
psychiq.specials: The psychiq<dot>specials package
psychiq.util: The psychiq<dot>util package
psychiq.util.assoc: The psychiq<dot>util<dot>assoc package
psychiq.util.concurrency: The psychiq<dot>util<dot>concurrency package
psychiq.util.redis: The psychiq<dot>util<dot>redis package
psychiq.worker: The psychiq<dot>worker package

S
scheduled: Exported structures
Structure, heartbeat: Exported structures
Structure, launcher: Exported structures
Structure, manager: Exported structures
Structure, processor: Exported structures
Structure, scheduled: Exported structures
Structure, thread-safe-variable: Internal structures
System, psychiq: The psychiq system

T
thread-safe-variable: Internal structures

W
worker: Exported classes

Jump to:   C   H   L   M   P   S   T   W