The cl-gearman Reference Manual

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

The cl-gearman Reference Manual

This is the cl-gearman Reference Manual, version 0.0.2, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Aug 15 03:39:46 2022 GMT+0.

Table of Contents


1 Introduction

Cl-Gearman

Common Lisp Library for the Gearman distributed job system.

Installation

cl-gearman is available on quicklisp.

(ql:quickload 'cl-gearman)

Usage

;; client
(cl-gearman:with-client (client "localhost:4730")
  (format t "~a~%" (cl-gearman:submit-job client "echo" :arg "foo")))


;; worker

(cl-gearman:with-worker (worker "localhost:4730") 
  (cl-gearman:add-ability worker "echo"
                          #'(lambda (arg job) arg))
  (loop do (cl-gearman:work worker)))

Example

Run gearman server,

docker run --rm -p 4730:4730 artefactual/gearmand:1.1.19.1-alpine

and then,

# start worker process
sbcl --script examples/worker.lisp

# start client process
sbcl --script examples/client.lisp

Local development with quicklisp

ln -s path/to/cl-gearman-repo ~/quicklisp/local-projects/cl-gearman

lisp

Author

Copyright

Copyright (c) 2012 Takayuki Sato

License

Licensed under the LLGPL License.


2 Systems

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


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

2.1 cl-gearman

Common Lisp Library for the Gearman distributed job system.

Author

Takayuki Sato

License

LLGPL

Version

0.0.2

Dependencies
  • usocket (system).
  • split-sequence (system).
  • babel (system).
  • alexandria (system).
Source

cl-gearman.asd.

Child Component

src (module).


3 Modules

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


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

3.1 cl-gearman/src

Source

cl-gearman.asd.

Parent Component

cl-gearman (system).

Child Components

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   [Contents][Index]

4.1.1 cl-gearman/cl-gearman.asd

Source

cl-gearman.asd.

Parent Component

cl-gearman (system).

ASDF Systems

cl-gearman.

Packages

cl-gearman-asd.


4.1.2 cl-gearman/src/package.lisp

Source

cl-gearman.asd.

Parent Component

src (module).

Packages

cl-gearman.


4.1.3 cl-gearman/src/misc.lisp

Dependency

package.lisp (file).

Source

cl-gearman.asd.

Parent Component

src (module).

Internals

4.1.4 cl-gearman/src/logger.lisp

Dependency

misc.lisp (file).

Source

cl-gearman.asd.

Parent Component

src (module).

Public Interface
Internals

4.1.5 cl-gearman/src/connection.lisp

Dependency

logger.lisp (file).

Source

cl-gearman.asd.

Parent Component

src (module).

Public Interface

initialize-instance (method).

Internals

4.1.6 cl-gearman/src/protocol.lisp

Dependency

connection.lisp (file).

Source

cl-gearman.asd.

Parent Component

src (module).

Public Interface
Internals

4.1.7 cl-gearman/src/client.lisp

Dependency

protocol.lisp (file).

Source

cl-gearman.asd.

Parent Component

src (module).

Public Interface
Internals

select-server (method).


4.1.8 cl-gearman/src/worker.lisp

Dependency

client.lisp (file).

Source

cl-gearman.asd.

Parent Component

src (module).

Public Interface
Internals

5 Packages

Packages are listed by definition order.


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

5.1 cl-gearman-asd

Source

cl-gearman.asd.

Use List
  • asdf/interface.
  • common-lisp.

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

5.2 cl-gearman

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.


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

6.1 Public Interface


Next: , Previous: , Up: Public Interface   [Contents][Index]

6.1.1 Special variables

Special Variable: *logger-formatter*
Package

cl-gearman.

Source

logger.lisp.

Special Variable: *logger-level*
Package

cl-gearman.

Source

logger.lisp.

Special Variable: *logger-output*
Package

cl-gearman.

Source

logger.lisp.


6.1.2 Macros

Macro: with-client ((var host) &body body)
Package

cl-gearman.

Source

client.lisp.

Macro: with-multiple-servers-client ((var hosts) &body body)
Package

cl-gearman.

Source

client.lisp.

Macro: with-multiple-servers-worker ((var hosts) &body body)
Package

cl-gearman.

Source

worker.lisp.

Macro: with-worker ((var host) &body body)
Package

cl-gearman.

Source

worker.lisp.


6.1.3 Ordinary functions

Function: log-debug (message &optional tag)
Package

cl-gearman.

Source

logger.lisp.

Function: log-error (message &optional tag)
Package

cl-gearman.

Source

logger.lisp.

Function: log-fatal (message &optional tag)
Package

cl-gearman.

Source

logger.lisp.

Function: log-info (message &optional tag)
Package

cl-gearman.

Source

logger.lisp.

Function: log-warn (message &optional tag)
Package

cl-gearman.

Source

logger.lisp.

Function: make-client (server-exps)
Package

cl-gearman.

Source

client.lisp.

Function: make-worker (server-exps)
Package

cl-gearman.

Source

worker.lisp.


6.1.4 Generic functions

Generic Function: add-ability (w name func &key timeout)
Package

cl-gearman.

Methods
Method: add-ability ((w worker) name func &key timeout)

Announce an ability to servers and set the handler function.

Source

worker.lisp.

Generic Function: close-client (c)
Package

cl-gearman.

Methods
Method: close-client ((c client))
Source

client.lisp.

Generic Function: close-worker (w)
Package

cl-gearman.

Methods
Method: close-worker ((w worker))
Source

worker.lisp.

Generic Function: get-job-status (cli j)
Package

cl-gearman.

Methods
Method: get-job-status ((cli client) (j job))
Source

client.lisp.

Generic Function: remove-ability (w name)
Package

cl-gearman.

Methods
Method: remove-ability ((w worker) name)

Let job servers know that we’re no longer able to do something.

Source

worker.lisp.

Generic Function: reset-abilities (w)
Package

cl-gearman.

Methods
Method: reset-abilities ((w worker))
Source

worker.lisp.

Generic Reader: server-response (condition)
Package

cl-gearman.

Methods
Reader Method: server-response ((condition job-failed))
Source

client.lisp.

Target Slot

response.

Generic Function: submit-background-job (cli func &key arg priority)
Package

cl-gearman.

Methods
Method: submit-background-job ((cli client) func &key arg priority)

Submit job and return the job object immediately.

Source

client.lisp.

Generic Function: submit-job (cli func &key arg priority)
Package

cl-gearman.

Methods
Method: submit-job ((cli client) func &key arg priority)

Submit a job and return result data of the job. This function blocks until it is completed.

Source

client.lisp.

Generic Function: work (w)
Package

cl-gearman.

Methods
Method: work ((w worker))

Do a single job and return

Source

worker.lisp.


6.1.5 Standalone methods

Method: initialize-instance :after ((conn connection) &key)
Source

connection.lisp.

Method: print-object ((msg message) stream)
Source

protocol.lisp.

Method: print-object ((j job) stream)
Source

protocol.lisp.


6.1.6 Conditions

Condition: job-failed
Package

cl-gearman.

Source

client.lisp.

Direct superclasses

error.

Direct methods

server-response.

Direct slots
Slot: response
Initargs

:response

Readers

server-response.

Writers

This slot is read-only.


Previous: , Up: Public Interface   [Contents][Index]

6.1.7 Classes

Class: client
Package

cl-gearman.

Source

client.lisp.

Direct methods
Direct slots
Slot: connections
Initargs

:connections

Slot: tasks
Class: worker
Package

cl-gearman.

Source

worker.lisp.

Direct methods
Direct slots
Slot: connections
Initargs

:connections

Slot: abilities
Initform

(make-hash-table :test (function equalp))

Readers

abilities.

Writers

(setf abilities).

Slot: status
Initform

:preparing

Readers

status.

Writers

This slot is read-only.


6.2 Internals


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

6.2.1 Constants

Constant: +debug+
Package

cl-gearman.

Source

logger.lisp.

Constant: +error+
Package

cl-gearman.

Source

logger.lisp.

Constant: +fatal+
Package

cl-gearman.

Source

logger.lisp.

Constant: +info+
Package

cl-gearman.

Source

logger.lisp.

Constant: +warn+
Package

cl-gearman.

Source

logger.lisp.

Constant: all_yours
Package

cl-gearman.

Source

protocol.lisp.

Constant: can_do
Package

cl-gearman.

Source

protocol.lisp.

Constant: can_do_timeout
Package

cl-gearman.

Source

protocol.lisp.

Constant: cant_do
Package

cl-gearman.

Source

protocol.lisp.

Constant: echo_req
Package

cl-gearman.

Source

protocol.lisp.

Constant: echo_res
Package

cl-gearman.

Source

protocol.lisp.

Constant: g_error
Package

cl-gearman.

Source

protocol.lisp.

Constant: get_status
Package

cl-gearman.

Source

protocol.lisp.

Constant: grab_job
Package

cl-gearman.

Source

protocol.lisp.

Constant: grab_job_uniq
Package

cl-gearman.

Source

protocol.lisp.

Constant: job_assign
Package

cl-gearman.

Source

protocol.lisp.

Constant: job_assign_uniq
Package

cl-gearman.

Source

protocol.lisp.

Constant: job_created
Package

cl-gearman.

Source

protocol.lisp.

Constant: no_job
Package

cl-gearman.

Source

protocol.lisp.

Constant: noop
Package

cl-gearman.

Source

protocol.lisp.

Constant: option_req
Package

cl-gearman.

Source

protocol.lisp.

Constant: option_res
Package

cl-gearman.

Source

protocol.lisp.

Constant: pre_sleep
Package

cl-gearman.

Source

protocol.lisp.

Constant: reset_abilities
Package

cl-gearman.

Source

protocol.lisp.

Constant: set_client_id
Package

cl-gearman.

Source

protocol.lisp.

Constant: status_res
Package

cl-gearman.

Source

protocol.lisp.

Constant: submit_job
Package

cl-gearman.

Source

protocol.lisp.

Constant: submit_job_bg
Package

cl-gearman.

Source

protocol.lisp.

Constant: submit_job_epoch
Package

cl-gearman.

Source

protocol.lisp.

Constant: submit_job_high
Package

cl-gearman.

Source

protocol.lisp.

Constant: submit_job_high_bg
Package

cl-gearman.

Source

protocol.lisp.

Constant: submit_job_low
Package

cl-gearman.

Source

protocol.lisp.

Constant: submit_job_low_bg
Package

cl-gearman.

Source

protocol.lisp.

Constant: submit_job_sched
Package

cl-gearman.

Source

protocol.lisp.

Constant: work_complete
Package

cl-gearman.

Source

protocol.lisp.

Constant: work_data
Package

cl-gearman.

Source

protocol.lisp.

Constant: work_exception
Package

cl-gearman.

Source

protocol.lisp.

Constant: work_fail
Package

cl-gearman.

Source

protocol.lisp.

Constant: work_status
Package

cl-gearman.

Source

protocol.lisp.

Constant: work_warning
Package

cl-gearman.

Source

protocol.lisp.


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

6.2.2 Special variables

Special Variable: *uid-random-state*
Package

cl-gearman.

Source

misc.lisp.

Special Variable: +name-table+
Package

cl-gearman.

Source

protocol.lisp.

Special Variable: +request-magic+
Package

cl-gearman.

Source

protocol.lisp.

Special Variable: +response-magic+
Package

cl-gearman.

Source

protocol.lisp.


6.2.3 Macros

Macro: provide-reconnect-restart (expression &body body)

When, during the execution of EXPRESSION, an error occurs that can break the connection socket, a condition of type GEARMAN-CONNECTION-ERROR is raised offering a :reconnect restart whose body is given by BODY.

Package

cl-gearman.

Source

connection.lisp.

Macro: signal-connection-error-with-reconnect-restart (&key message comment restart)

Signal the condition of type GEARMAN-CONNECTION-ERROR denoted by the given MESSAGE and COMMENT offering a :reconnect restart given by RESTART.

Package

cl-gearman.

Source

connection.lisp.

Macro: with-reconnect-restart (conn &body body)

When, inside BODY, an error occurs that breaks the socket of CONN,
a condition of type REDIS-CONNECTION-ERROR is raised offering a :reconnect restart.

Package

cl-gearman.

Source

connection.lisp.


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

6.2.4 Ordinary functions

Function: big-endian-octets-to-uint32 (octets)
Package

cl-gearman.

Source

misc.lisp.

Function: default-formatter (message &key timestamp level tag)
Package

cl-gearman.

Source

logger.lisp.

Function: ensure-connection (conn)

Ensure that CONN is open before doing anything with it.

Package

cl-gearman.

Source

connection.lisp.

Function: list-to-vector (lis)
Package

cl-gearman.

Source

misc.lisp.

Function: make-uid ()
Package

cl-gearman.

Source

misc.lisp.

Function: message-to-octets (msg)
Package

cl-gearman.

Source

protocol.lisp.

Function: open-connection-p (conn)
Package

cl-gearman.

Source

connection.lisp.

Function: read-as-vector (siz stream &key element-type)
Package

cl-gearman.

Source

misc.lisp.

Function: read-message (stream)
Package

cl-gearman.

Source

protocol.lisp.

Function: recv-response (conn)
Package

cl-gearman.

Source

connection.lisp.

Function: reopen-connection (conn)

Close and reopen CONN.

Package

cl-gearman.

Source

connection.lisp.

Function: send-request (conn msg)
Package

cl-gearman.

Source

connection.lisp.

Function: split-payloads (payloads)
Package

cl-gearman.

Source

protocol.lisp.

Function: uint32-to-big-endian-octets (num)
Package

cl-gearman.

Source

misc.lisp.

Function: vector-join (sep &rest vectors)

Join vectors. The first vector must be adjustable or contain enough space to append following vectors.

Package

cl-gearman.

Source

misc.lisp.

Function: write-log (level tag message)
Package

cl-gearman.

Source

logger.lisp.

Function: write-message (stream message)
Package

cl-gearman.

Source

protocol.lisp.


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

6.2.5 Generic functions

Generic Reader: abilities (object)
Package

cl-gearman.

Methods
Reader Method: abilities ((worker worker))

automatically generated reader method

Source

worker.lisp.

Target Slot

abilities.

Generic Writer: (setf abilities) (object)
Package

cl-gearman.

Methods
Writer Method: (setf abilities) ((worker worker))

automatically generated writer method

Source

worker.lisp.

Target Slot

abilities.

Generic Reader: data (object)
Package

cl-gearman.

Methods
Reader Method: data ((message message))

automatically generated reader method

Source

protocol.lisp.

Target Slot

data.

Generic Function: gm-close (conn)
Package

cl-gearman.

Methods
Method: gm-close ((conn connection))
Source

connection.lisp.

Generic Function: gm-connect (conn)
Package

cl-gearman.

Methods
Method: gm-connect ((conn connection))
Source

connection.lisp.

Generic Reader: gm-stream (object)
Package

cl-gearman.

Methods
Reader Method: gm-stream ((connection connection))

automatically generated reader method

Source

connection.lisp.

Target Slot

stream.

Generic Writer: (setf gm-stream) (object)
Package

cl-gearman.

Methods
Writer Method: (setf gm-stream) ((connection connection))

automatically generated writer method

Source

connection.lisp.

Target Slot

stream.

Generic Function: handle-job-assign (w msg)
Package

cl-gearman.

Methods
Method: handle-job-assign ((w worker) (msg message))
Source

worker.lisp.

Generic Reader: host (object)
Package

cl-gearman.

Methods
Reader Method: host ((connection connection))

automatically generated reader method

Source

connection.lisp.

Target Slot

host.

Generic Function: is-active (conn)
Package

cl-gearman.

Methods
Method: is-active ((conn connection))
Source

connection.lisp.

Generic Function: job-assign-message-to-job (msg)
Package

cl-gearman.

Methods
Method: job-assign-message-to-job ((msg message))

convert JOB_ASSIGN message to job object.

Source

protocol.lisp.

Generic Function: job-created-message-to-job (msg &key name arg uid)
Package

cl-gearman.

Methods
Method: job-created-message-to-job ((msg message) &key name arg uid)

convert JOB_CREATED message to job object.

Source

protocol.lisp.

Generic Reader: magic (object)
Package

cl-gearman.

Methods
Reader Method: magic ((message message))

automatically generated reader method

Source

protocol.lisp.

Target Slot

magic.

Generic Function: message-name? (msg n)
Package

cl-gearman.

Methods
Method: message-name? ((msg message) n)
Source

protocol.lisp.

Generic Reader: name (object)
Package

cl-gearman.

Methods
Reader Method: name ((message message))

automatically generated reader method

Source

protocol.lisp.

Target Slot

name.

Generic Reader: port (object)
Package

cl-gearman.

Methods
Reader Method: port ((connection connection))

automatically generated reader method

Source

connection.lisp.

Target Slot

port.

Generic Function: run-job (w j)
Package

cl-gearman.

Methods
Method: run-job ((w worker) (j job))
Source

worker.lisp.

Generic Function: select-server (cli uid)
Package

cl-gearman.

Methods
Method: select-server ((w worker) (j job))

Select the first server ready to response, if some connection error appears the server is automatically discarded

Source

worker.lisp.

Method: select-server ((cli client) uid)

Select the first server ready to response, if some connection error appears the server is automatically discarded

Source

client.lisp.

Generic Reader: socket (object)
Package

cl-gearman.

Methods
Reader Method: socket ((connection connection))

automatically generated reader method

Source

connection.lisp.

Target Slot

socket.

Generic Writer: (setf socket) (object)
Package

cl-gearman.

Methods
Writer Method: (setf socket) ((connection connection))

automatically generated writer method

Source

connection.lisp.

Target Slot

socket.

Generic Reader: status (object)
Package

cl-gearman.

Methods
Reader Method: status ((worker worker))

automatically generated reader method

Source

worker.lisp.

Target Slot

status.

Generic Function: tell-job-fail (w j)
Package

cl-gearman.

Methods
Method: tell-job-fail ((w worker) (j job))
Source

worker.lisp.

Generic Function: tell-job-success (w j data)
Package

cl-gearman.

Methods
Method: tell-job-success ((w worker) (j job) data)
Source

worker.lisp.


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

6.2.6 Conditions

Condition: gearman-connection-error
Package

cl-gearman.

Source

connection.lisp.

Direct superclasses

error.

Direct slots
Slot: message
Initform

(quote nil)

Initargs

:message

Slot: comment
Initform

(quote nil)

Initargs

:comment


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

6.2.7 Classes

Class: connection
Package

cl-gearman.

Source

connection.lisp.

Direct methods
Direct slots
Slot: host
Initform

"localhost"

Initargs

:host

Readers

host.

Writers

This slot is read-only.

Slot: port
Initform

4730

Initargs

:port

Readers

port.

Writers

This slot is read-only.

Slot: socket
Readers

socket.

Writers

(setf socket).

Slot: stream
Package

common-lisp.

Readers

gm-stream.

Writers

(setf gm-stream).

Class: job
Package

cl-gearman.

Source

protocol.lisp.

Direct methods
Direct slots
Slot: handle
Initargs

:handle

Slot: name
Initargs

:name

Slot: arg
Initargs

:arg

Slot: uid
Initargs

:uid

Class: message
Package

cl-gearman.

Source

protocol.lisp.

Direct methods
Direct slots
Slot: magic
Initform

cl-gearman::+request-magic+

Initargs

:magic

Readers

magic.

Writers

This slot is read-only.

Slot: name
Initargs

:name

Readers

name.

Writers

This slot is read-only.

Slot: data
Initargs

:data

Readers

data.

Writers

This slot is read-only.


Appendix A Indexes


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

A.1 Concepts


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

A.2 Functions

Jump to:   (  
A   B   C   D   E   F   G   H   I   J   L   M   N   O   P   R   S   T   U   V   W  
Index Entry  Section

(
(setf abilities): Private generic functions
(setf abilities): Private generic functions
(setf gm-stream): Private generic functions
(setf gm-stream): Private generic functions
(setf socket): Private generic functions
(setf socket): Private generic functions

A
abilities: Private generic functions
abilities: Private generic functions
add-ability: Public generic functions
add-ability: Public generic functions

B
big-endian-octets-to-uint32: Private ordinary functions

C
close-client: Public generic functions
close-client: Public generic functions
close-worker: Public generic functions
close-worker: Public generic functions

D
data: Private generic functions
data: Private generic functions
default-formatter: Private ordinary functions

E
ensure-connection: Private ordinary functions

F
Function, big-endian-octets-to-uint32: Private ordinary functions
Function, default-formatter: Private ordinary functions
Function, ensure-connection: Private ordinary functions
Function, list-to-vector: Private ordinary functions
Function, log-debug: Public ordinary functions
Function, log-error: Public ordinary functions
Function, log-fatal: Public ordinary functions
Function, log-info: Public ordinary functions
Function, log-warn: Public ordinary functions
Function, make-client: Public ordinary functions
Function, make-uid: Private ordinary functions
Function, make-worker: Public ordinary functions
Function, message-to-octets: Private ordinary functions
Function, open-connection-p: Private ordinary functions
Function, read-as-vector: Private ordinary functions
Function, read-message: Private ordinary functions
Function, recv-response: Private ordinary functions
Function, reopen-connection: Private ordinary functions
Function, send-request: Private ordinary functions
Function, split-payloads: Private ordinary functions
Function, uint32-to-big-endian-octets: Private ordinary functions
Function, vector-join: Private ordinary functions
Function, write-log: Private ordinary functions
Function, write-message: Private ordinary functions

G
Generic Function, (setf abilities): Private generic functions
Generic Function, (setf gm-stream): Private generic functions
Generic Function, (setf socket): Private generic functions
Generic Function, abilities: Private generic functions
Generic Function, add-ability: Public generic functions
Generic Function, close-client: Public generic functions
Generic Function, close-worker: Public generic functions
Generic Function, data: Private generic functions
Generic Function, get-job-status: Public generic functions
Generic Function, gm-close: Private generic functions
Generic Function, gm-connect: Private generic functions
Generic Function, gm-stream: Private generic functions
Generic Function, handle-job-assign: Private generic functions
Generic Function, host: Private generic functions
Generic Function, is-active: Private generic functions
Generic Function, job-assign-message-to-job: Private generic functions
Generic Function, job-created-message-to-job: Private generic functions
Generic Function, magic: Private generic functions
Generic Function, message-name?: Private generic functions
Generic Function, name: Private generic functions
Generic Function, port: Private generic functions
Generic Function, remove-ability: Public generic functions
Generic Function, reset-abilities: Public generic functions
Generic Function, run-job: Private generic functions
Generic Function, select-server: Private generic functions
Generic Function, server-response: Public generic functions
Generic Function, socket: Private generic functions
Generic Function, status: Private generic functions
Generic Function, submit-background-job: Public generic functions
Generic Function, submit-job: Public generic functions
Generic Function, tell-job-fail: Private generic functions
Generic Function, tell-job-success: Private generic functions
Generic Function, work: Public generic functions
get-job-status: Public generic functions
get-job-status: Public generic functions
gm-close: Private generic functions
gm-close: Private generic functions
gm-connect: Private generic functions
gm-connect: Private generic functions
gm-stream: Private generic functions
gm-stream: Private generic functions

H
handle-job-assign: Private generic functions
handle-job-assign: Private generic functions
host: Private generic functions
host: Private generic functions

I
initialize-instance: Public standalone methods
is-active: Private generic functions
is-active: Private generic functions

J
job-assign-message-to-job: Private generic functions
job-assign-message-to-job: Private generic functions
job-created-message-to-job: Private generic functions
job-created-message-to-job: Private generic functions

L
list-to-vector: Private ordinary functions
log-debug: Public ordinary functions
log-error: Public ordinary functions
log-fatal: Public ordinary functions
log-info: Public ordinary functions
log-warn: Public ordinary functions

M
Macro, provide-reconnect-restart: Private macros
Macro, signal-connection-error-with-reconnect-restart: Private macros
Macro, with-client: Public macros
Macro, with-multiple-servers-client: Public macros
Macro, with-multiple-servers-worker: Public macros
Macro, with-reconnect-restart: Private macros
Macro, with-worker: Public macros
magic: Private generic functions
magic: Private generic functions
make-client: Public ordinary functions
make-uid: Private ordinary functions
make-worker: Public ordinary functions
message-name?: Private generic functions
message-name?: Private generic functions
message-to-octets: Private ordinary functions
Method, (setf abilities): Private generic functions
Method, (setf gm-stream): Private generic functions
Method, (setf socket): Private generic functions
Method, abilities: Private generic functions
Method, add-ability: Public generic functions
Method, close-client: Public generic functions
Method, close-worker: Public generic functions
Method, data: Private generic functions
Method, get-job-status: Public generic functions
Method, gm-close: Private generic functions
Method, gm-connect: Private generic functions
Method, gm-stream: Private generic functions
Method, handle-job-assign: Private generic functions
Method, host: Private generic functions
Method, initialize-instance: Public standalone methods
Method, is-active: Private generic functions
Method, job-assign-message-to-job: Private generic functions
Method, job-created-message-to-job: Private generic functions
Method, magic: Private generic functions
Method, message-name?: Private generic functions
Method, name: Private generic functions
Method, port: Private generic functions
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, remove-ability: Public generic functions
Method, reset-abilities: Public generic functions
Method, run-job: Private generic functions
Method, select-server: Private generic functions
Method, select-server: Private generic functions
Method, server-response: Public generic functions
Method, socket: Private generic functions
Method, status: Private generic functions
Method, submit-background-job: Public generic functions
Method, submit-job: Public generic functions
Method, tell-job-fail: Private generic functions
Method, tell-job-success: Private generic functions
Method, work: Public generic functions

N
name: Private generic functions
name: Private generic functions

O
open-connection-p: Private ordinary functions

P
port: Private generic functions
port: Private generic functions
print-object: Public standalone methods
print-object: Public standalone methods
provide-reconnect-restart: Private macros

R
read-as-vector: Private ordinary functions
read-message: Private ordinary functions
recv-response: Private ordinary functions
remove-ability: Public generic functions
remove-ability: Public generic functions
reopen-connection: Private ordinary functions
reset-abilities: Public generic functions
reset-abilities: Public generic functions
run-job: Private generic functions
run-job: Private generic functions

S
select-server: Private generic functions
select-server: Private generic functions
select-server: Private generic functions
send-request: Private ordinary functions
server-response: Public generic functions
server-response: Public generic functions
signal-connection-error-with-reconnect-restart: Private macros
socket: Private generic functions
socket: Private generic functions
split-payloads: Private ordinary functions
status: Private generic functions
status: Private generic functions
submit-background-job: Public generic functions
submit-background-job: Public generic functions
submit-job: Public generic functions
submit-job: Public generic functions

T
tell-job-fail: Private generic functions
tell-job-fail: Private generic functions
tell-job-success: Private generic functions
tell-job-success: Private generic functions

U
uint32-to-big-endian-octets: Private ordinary functions

V
vector-join: Private ordinary functions

W
with-client: Public macros
with-multiple-servers-client: Public macros
with-multiple-servers-worker: Public macros
with-reconnect-restart: Private macros
with-worker: Public macros
work: Public generic functions
work: Public generic functions
write-log: Private ordinary functions
write-message: Private ordinary functions

Jump to:   (  
A   B   C   D   E   F   G   H   I   J   L   M   N   O   P   R   S   T   U   V   W  

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

A.3 Variables

Jump to:   *   +  
A   C   D   E   G   H   J   M   N   O   P   R   S   T   U   W  
Index Entry  Section

*
*logger-formatter*: Public special variables
*logger-level*: Public special variables
*logger-output*: Public special variables
*uid-random-state*: Private special variables

+
+debug+: Private constants
+error+: Private constants
+fatal+: Private constants
+info+: Private constants
+name-table+: Private special variables
+request-magic+: Private special variables
+response-magic+: Private special variables
+warn+: Private constants

A
abilities: Public classes
all_yours: Private constants
arg: Private classes

C
cant_do: Private constants
can_do: Private constants
can_do_timeout: Private constants
comment: Private conditions
connections: Public classes
connections: Public classes
Constant, +debug+: Private constants
Constant, +error+: Private constants
Constant, +fatal+: Private constants
Constant, +info+: Private constants
Constant, +warn+: Private constants
Constant, all_yours: Private constants
Constant, cant_do: Private constants
Constant, can_do: Private constants
Constant, can_do_timeout: Private constants
Constant, echo_req: Private constants
Constant, echo_res: Private constants
Constant, get_status: Private constants
Constant, grab_job: Private constants
Constant, grab_job_uniq: Private constants
Constant, g_error: Private constants
Constant, job_assign: Private constants
Constant, job_assign_uniq: Private constants
Constant, job_created: Private constants
Constant, noop: Private constants
Constant, no_job: Private constants
Constant, option_req: Private constants
Constant, option_res: Private constants
Constant, pre_sleep: Private constants
Constant, reset_abilities: Private constants
Constant, set_client_id: Private constants
Constant, status_res: Private constants
Constant, submit_job: Private constants
Constant, submit_job_bg: Private constants
Constant, submit_job_epoch: Private constants
Constant, submit_job_high: Private constants
Constant, submit_job_high_bg: Private constants
Constant, submit_job_low: Private constants
Constant, submit_job_low_bg: Private constants
Constant, submit_job_sched: Private constants
Constant, work_complete: Private constants
Constant, work_data: Private constants
Constant, work_exception: Private constants
Constant, work_fail: Private constants
Constant, work_status: Private constants
Constant, work_warning: Private constants

D
data: Private classes

E
echo_req: Private constants
echo_res: Private constants

G
get_status: Private constants
grab_job: Private constants
grab_job_uniq: Private constants
g_error: Private constants

H
handle: Private classes
host: Private classes

J
job_assign: Private constants
job_assign_uniq: Private constants
job_created: Private constants

M
magic: Private classes
message: Private conditions

N
name: Private classes
name: Private classes
noop: Private constants
no_job: Private constants

O
option_req: Private constants
option_res: Private constants

P
port: Private classes
pre_sleep: Private constants

R
reset_abilities: Private constants
response: Public conditions

S
set_client_id: Private constants
Slot, abilities: Public classes
Slot, arg: Private classes
Slot, comment: Private conditions
Slot, connections: Public classes
Slot, connections: Public classes
Slot, data: Private classes
Slot, handle: Private classes
Slot, host: Private classes
Slot, magic: Private classes
Slot, message: Private conditions
Slot, name: Private classes
Slot, name: Private classes
Slot, port: Private classes
Slot, response: Public conditions
Slot, socket: Private classes
Slot, status: Public classes
Slot, stream: Private classes
Slot, tasks: Public classes
Slot, uid: Private classes
socket: Private classes
Special Variable, *logger-formatter*: Public special variables
Special Variable, *logger-level*: Public special variables
Special Variable, *logger-output*: Public special variables
Special Variable, *uid-random-state*: Private special variables
Special Variable, +name-table+: Private special variables
Special Variable, +request-magic+: Private special variables
Special Variable, +response-magic+: Private special variables
status: Public classes
status_res: Private constants
stream: Private classes
submit_job: Private constants
submit_job_bg: Private constants
submit_job_epoch: Private constants
submit_job_high: Private constants
submit_job_high_bg: Private constants
submit_job_low: Private constants
submit_job_low_bg: Private constants
submit_job_sched: Private constants

T
tasks: Public classes

U
uid: Private classes

W
work_complete: Private constants
work_data: Private constants
work_exception: Private constants
work_fail: Private constants
work_status: Private constants
work_warning: Private constants

Jump to:   *   +  
A   C   D   E   G   H   J   M   N   O   P   R   S   T   U   W  

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

A.4 Data types

Jump to:   C   F   G   J   L   M   P   S   W  
Index Entry  Section

C
cl-gearman: The cl-gearman system
cl-gearman: The cl-gearman package
cl-gearman-asd: The cl-gearman-asd package
cl-gearman.asd: The cl-gearman/cl-gearman․asd file
Class, client: Public classes
Class, connection: Private classes
Class, job: Private classes
Class, message: Private classes
Class, worker: Public classes
client: Public classes
client.lisp: The cl-gearman/src/client․lisp file
Condition, gearman-connection-error: Private conditions
Condition, job-failed: Public conditions
connection: Private classes
connection.lisp: The cl-gearman/src/connection․lisp file

F
File, cl-gearman.asd: The cl-gearman/cl-gearman․asd file
File, client.lisp: The cl-gearman/src/client․lisp file
File, connection.lisp: The cl-gearman/src/connection․lisp file
File, logger.lisp: The cl-gearman/src/logger․lisp file
File, misc.lisp: The cl-gearman/src/misc․lisp file
File, package.lisp: The cl-gearman/src/package․lisp file
File, protocol.lisp: The cl-gearman/src/protocol․lisp file
File, worker.lisp: The cl-gearman/src/worker․lisp file

G
gearman-connection-error: Private conditions

J
job: Private classes
job-failed: Public conditions

L
logger.lisp: The cl-gearman/src/logger․lisp file

M
message: Private classes
misc.lisp: The cl-gearman/src/misc․lisp file
Module, src: The cl-gearman/src module

P
Package, cl-gearman: The cl-gearman package
Package, cl-gearman-asd: The cl-gearman-asd package
package.lisp: The cl-gearman/src/package․lisp file
protocol.lisp: The cl-gearman/src/protocol․lisp file

S
src: The cl-gearman/src module
System, cl-gearman: The cl-gearman system

W
worker: Public classes
worker.lisp: The cl-gearman/src/worker․lisp file

Jump to:   C   F   G   J   L   M   P   S   W