The cl-beanstalk Reference Manual

This is the cl-beanstalk Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Sep 15 03:44:41 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 cl-beanstalk

An interface to the beanstalk queue server

Dependencies
  • usocket (system).
  • flexi-streams (system).
  • split-sequence (system).
Source

cl-beanstalk.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 cl-beanstalk/cl-beanstalk.asd

Source

cl-beanstalk.asd.

Parent Component

cl-beanstalk (system).

ASDF Systems

cl-beanstalk.


3.1.2 cl-beanstalk/package.lisp

Source

cl-beanstalk.asd.

Parent Component

cl-beanstalk (system).

Packages

3.1.3 cl-beanstalk/beanstalk.lisp

Dependency

package.lisp (file).

Source

cl-beanstalk.asd.

Parent Component

cl-beanstalk (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 beanstalk-internal

Source

package.lisp.

Use List

common-lisp.

Internals

4.2 beanstalk

Source

package.lisp.

Public Interface

5 Definitions

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


5.1 Public Interface


5.1.1 Macros

Macro: with-beanstalk-connection ((connection host port &rest initargs) &body body)

Open a beanstalk connection to HOST:PORT for as long as control is inside BODY.

Package

beanstalk.

Source

beanstalk.lisp.


5.1.2 Ordinary functions

Function: bury (connection id pri)
Package

beanstalk.

Source

beanstalk.lisp.

Function: connect (host port &rest initargs)

Connect to a beanstalk daemon running on HOST:PORT.

Package

beanstalk.

Source

beanstalk.lisp.

Function: delete (connection id)
Package

beanstalk.

Source

beanstalk.lisp.

Function: disconnect (connection)

Disconnect the beanstalk connection.

Package

beanstalk.

Source

beanstalk.lisp.

Function: ignore (connection tube)
Package

beanstalk.

Source

beanstalk.lisp.

Function: kick (connection bound)
Package

beanstalk.

Source

beanstalk.lisp.

Function: list-tube-used (connection)
Package

beanstalk.

Source

beanstalk.lisp.

Function: list-tubes (connection)
Package

beanstalk.

Source

beanstalk.lisp.

Function: list-tubes-watched (connection)
Package

beanstalk.

Source

beanstalk.lisp.

Function: peek (connection id &key external-format)
Package

beanstalk.

Source

beanstalk.lisp.

Function: peek-buried (connection &key external-format)
Package

beanstalk.

Source

beanstalk.lisp.

Function: peek-delayed (connection &key external-format)
Package

beanstalk.

Source

beanstalk.lisp.

Function: peek-ready (connection &key external-format)
Package

beanstalk.

Source

beanstalk.lisp.

Function: put (connection pri delay ttr message &key external-format)
Package

beanstalk.

Source

beanstalk.lisp.

Function: quit (connection)

Alias for BEANSTALK:DISCONNECT.

Package

beanstalk.

Source

beanstalk.lisp.

Function: release (connection id pri delay)
Package

beanstalk.

Source

beanstalk.lisp.

Function: reserve (connection &key timeout external-format)
Package

beanstalk.

Source

beanstalk.lisp.

Function: stats (connection)
Package

beanstalk.

Source

beanstalk.lisp.

Function: stats-job (connection id)
Package

beanstalk.

Source

beanstalk.lisp.

Function: stats-tube (connection tube)
Package

beanstalk.

Source

beanstalk.lisp.

Function: touch (connection id)
Package

beanstalk.

Source

beanstalk.lisp.

Function: use (connection name)
Package

beanstalk.

Source

beanstalk.lisp.

Function: watch (connection tube)
Package

beanstalk.

Source

beanstalk.lisp.


5.1.3 Standalone methods

Method: print-object ((o beanstalk-connection) stream)
Source

beanstalk.lisp.


5.1.4 Conditions

Condition: bad-message-format
Package

beanstalk.

Source

beanstalk.lisp.

Direct superclasses

beanstalk-error.

Direct subclasses

expected-crlf.

Condition: bad-reply
Package

beanstalk.

Source

beanstalk.lisp.

Direct superclasses

condition.

Direct methods

reply.

Direct slots
Slot: reply
Package

beanstalk-internal.

Initargs

:reply

Readers

reply.

Writers

This slot is read-only.

Condition: beanstalk-error
Package

beanstalk.

Source

beanstalk.lisp.

Direct superclasses

condition.

Direct subclasses
Condition: beanstalkd-draining
Package

beanstalk.

Source

beanstalk.lisp.

Direct superclasses

beanstalk-error.

Condition: beanstalkd-internal-error
Package

beanstalk.

Source

beanstalk.lisp.

Direct superclasses

beanstalk-error.

Condition: beanstalkd-out-of-memory
Package

beanstalk.

Source

beanstalk.lisp.

Direct superclasses

beanstalk-error.

Condition: buried-job
Package

beanstalk.

Source

beanstalk.lisp.

Direct superclasses

warning.

Direct methods

buried-job-id.

Direct slots
Slot: id
Package

beanstalk-internal.

Initargs

:id

Readers

buried-job-id.

Writers

This slot is read-only.

Condition: deadline-soon
Package

beanstalk.

Source

beanstalk.lisp.

Direct superclasses

warning.

Condition: expected-crlf
Package

beanstalk.

Source

beanstalk.lisp.

Direct superclasses

bad-message-format.

Condition: unknown-command
Package

beanstalk.

Source

beanstalk.lisp.

Direct superclasses

beanstalk-error.

Direct methods

unknown-command.

Direct slots
Slot: unknown-command
Package

beanstalk-internal.

Initargs

beanstalk-internal::command

Readers

unknown-command.

Writers

This slot is read-only.

Condition: yaml-parsing-failed
Package

beanstalk.

Source

beanstalk.lisp.

Direct superclasses

beanstalk-error.

Direct methods

document.

Direct slots
Slot: document
Package

beanstalk-internal.

Initargs

:document

Readers

document.

Writers

This slot is read-only.


5.2 Internals


5.2.1 Special variables

Special Variable: *debug-protocol*
Package

beanstalk-internal.

Source

beanstalk.lisp.

Special Variable: *yaml-external-format*
Package

beanstalk-internal.

Source

beanstalk.lisp.


5.2.2 Macros

Macro: command-reply-case ((reply connection command data-producer &rest args) &body clauses)
Package

beanstalk-internal.

Source

beanstalk.lisp.

Macro: proto-debug (datum &rest args)
Package

beanstalk-internal.

Source

beanstalk.lisp.


5.2.3 Ordinary functions

Function: converse (connection command data-producer &rest args)
Package

beanstalk-internal.

Source

beanstalk.lisp.

Function: length-below-200 (string)
Package

beanstalk-internal.

Source

beanstalk.lisp.

Function: parse-yaml-data (n-bytes stream string-fields)
Package

beanstalk-internal.

Source

beanstalk.lisp.

Function: proto-debug* (datum &rest args)
Package

beanstalk-internal.

Source

beanstalk.lisp.

Function: read-data-reply (bytes-as-string stream external-format)
Package

beanstalk-internal.

Source

beanstalk.lisp.

Function: read-reply (connection)
Package

beanstalk-internal.

Source

beanstalk.lisp.

Function: send-command (connection name &rest args)
Package

beanstalk-internal.

Source

beanstalk.lisp.


5.2.4 Generic functions

Generic Reader: buried-job-id (condition)
Package

beanstalk-internal.

Methods
Reader Method: buried-job-id ((condition buried-job))
Source

beanstalk.lisp.

Target Slot

id.

Generic Function: convert-message-out (message connection external-format)
Package

beanstalk-internal.

Source

beanstalk.lisp.

Methods
Method: convert-message-out ((message string) conn external-format)
Method: convert-message-out ((message vector) conn external-format)
Generic Reader: document (condition)
Package

beanstalk-internal.

Methods
Reader Method: document ((condition yaml-parsing-failed))
Source

beanstalk.lisp.

Target Slot

document.

Generic Reader: name-of (object)
Package

beanstalk-internal.

Methods
Reader Method: name-of ((beanstalk-connection beanstalk-connection))

automatically generated reader method

Source

beanstalk.lisp.

Target Slot

name.

Generic Writer: (setf name-of) (object)
Package

beanstalk-internal.

Methods
Writer Method: (setf name-of) ((beanstalk-connection beanstalk-connection))

automatically generated writer method

Source

beanstalk.lisp.

Target Slot

name.

Generic Reader: reply (condition)
Package

beanstalk-internal.

Methods
Reader Method: reply ((condition bad-reply))
Source

beanstalk.lisp.

Target Slot

reply.

Generic Reader: socket-of (object)
Package

beanstalk-internal.

Methods
Reader Method: socket-of ((beanstalk-connection beanstalk-connection))

automatically generated reader method

Source

beanstalk.lisp.

Target Slot

socket.

Generic Writer: (setf socket-of) (object)
Package

beanstalk-internal.

Methods
Writer Method: (setf socket-of) ((beanstalk-connection beanstalk-connection))

automatically generated writer method

Source

beanstalk.lisp.

Target Slot

socket.

Generic Reader: stream-of (object)
Package

beanstalk-internal.

Methods
Reader Method: stream-of ((beanstalk-connection beanstalk-connection))

automatically generated reader method

Source

beanstalk.lisp.

Target Slot

stream.

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

beanstalk-internal.

Methods
Writer Method: (setf stream-of) ((beanstalk-connection beanstalk-connection))

automatically generated writer method

Source

beanstalk.lisp.

Target Slot

stream.

Generic Reader: unknown-command (condition)
Package

beanstalk-internal.

Methods
Reader Method: unknown-command ((condition unknown-command))
Source

beanstalk.lisp.

Target Slot

unknown-command.


5.2.5 Classes

Class: beanstalk-connection
Package

beanstalk-internal.

Source

beanstalk.lisp.

Direct methods
Direct slots
Slot: socket
Initargs

:socket

Readers

socket-of.

Writers

(setf socket-of).

Slot: stream
Package

common-lisp.

Initargs

:stream

Readers

stream-of.

Writers

(setf stream-of).

Slot: name
Initargs

:name

Readers

name-of.

Writers

(setf name-of).


5.2.6 Types

Type: pri ()
Package

beanstalk-internal.

Source

beanstalk.lisp.

Type: time-spec ()
Package

beanstalk-internal.

Source

beanstalk.lisp.

Type: tube-name ()
Package

beanstalk-internal.

Source

beanstalk.lisp.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
B   C   D   F   G   I   K   L   M   N   P   Q   R   S   T   U   W  
Index Entry  Section

(
(setf name-of): Private generic functions
(setf name-of): Private generic functions
(setf socket-of): Private generic functions
(setf socket-of): Private generic functions
(setf stream-of): Private generic functions
(setf stream-of): Private generic functions

B
buried-job-id: Private generic functions
buried-job-id: Private generic functions
bury: Public ordinary functions

C
command-reply-case: Private macros
connect: Public ordinary functions
converse: Private ordinary functions
convert-message-out: Private generic functions
convert-message-out: Private generic functions
convert-message-out: Private generic functions

D
delete: Public ordinary functions
disconnect: Public ordinary functions
document: Private generic functions
document: Private generic functions

F
Function, bury: Public ordinary functions
Function, connect: Public ordinary functions
Function, converse: Private ordinary functions
Function, delete: Public ordinary functions
Function, disconnect: Public ordinary functions
Function, ignore: Public ordinary functions
Function, kick: Public ordinary functions
Function, length-below-200: Private ordinary functions
Function, list-tube-used: Public ordinary functions
Function, list-tubes: Public ordinary functions
Function, list-tubes-watched: Public ordinary functions
Function, parse-yaml-data: Private ordinary functions
Function, peek: Public ordinary functions
Function, peek-buried: Public ordinary functions
Function, peek-delayed: Public ordinary functions
Function, peek-ready: Public ordinary functions
Function, proto-debug*: Private ordinary functions
Function, put: Public ordinary functions
Function, quit: Public ordinary functions
Function, read-data-reply: Private ordinary functions
Function, read-reply: Private ordinary functions
Function, release: Public ordinary functions
Function, reserve: Public ordinary functions
Function, send-command: Private ordinary functions
Function, stats: Public ordinary functions
Function, stats-job: Public ordinary functions
Function, stats-tube: Public ordinary functions
Function, touch: Public ordinary functions
Function, use: Public ordinary functions
Function, watch: Public ordinary functions

G
Generic Function, (setf name-of): Private generic functions
Generic Function, (setf socket-of): Private generic functions
Generic Function, (setf stream-of): Private generic functions
Generic Function, buried-job-id: Private generic functions
Generic Function, convert-message-out: Private generic functions
Generic Function, document: Private generic functions
Generic Function, name-of: Private generic functions
Generic Function, reply: Private generic functions
Generic Function, socket-of: Private generic functions
Generic Function, stream-of: Private generic functions
Generic Function, unknown-command: Private generic functions

I
ignore: Public ordinary functions

K
kick: Public ordinary functions

L
length-below-200: Private ordinary functions
list-tube-used: Public ordinary functions
list-tubes: Public ordinary functions
list-tubes-watched: Public ordinary functions

M
Macro, command-reply-case: Private macros
Macro, proto-debug: Private macros
Macro, with-beanstalk-connection: Public macros
Method, (setf name-of): Private generic functions
Method, (setf socket-of): Private generic functions
Method, (setf stream-of): Private generic functions
Method, buried-job-id: Private generic functions
Method, convert-message-out: Private generic functions
Method, convert-message-out: Private generic functions
Method, document: Private generic functions
Method, name-of: Private generic functions
Method, print-object: Public standalone methods
Method, reply: Private generic functions
Method, socket-of: Private generic functions
Method, stream-of: Private generic functions
Method, unknown-command: Private generic functions

N
name-of: Private generic functions
name-of: Private generic functions

P
parse-yaml-data: Private ordinary functions
peek: Public ordinary functions
peek-buried: Public ordinary functions
peek-delayed: Public ordinary functions
peek-ready: Public ordinary functions
print-object: Public standalone methods
proto-debug: Private macros
proto-debug*: Private ordinary functions
put: Public ordinary functions

Q
quit: Public ordinary functions

R
read-data-reply: Private ordinary functions
read-reply: Private ordinary functions
release: Public ordinary functions
reply: Private generic functions
reply: Private generic functions
reserve: Public ordinary functions

S
send-command: Private ordinary functions
socket-of: Private generic functions
socket-of: Private generic functions
stats: Public ordinary functions
stats-job: Public ordinary functions
stats-tube: Public ordinary functions
stream-of: Private generic functions
stream-of: Private generic functions

T
touch: Public ordinary functions

U
unknown-command: Private generic functions
unknown-command: Private generic functions
use: Public ordinary functions

W
watch: Public ordinary functions
with-beanstalk-connection: Public macros


A.4 Data types

Jump to:   B   C   D   E   F   P   S   T   U   Y  
Index Entry  Section

B
bad-message-format: Public conditions
bad-reply: Public conditions
beanstalk: The beanstalk package
beanstalk-connection: Private classes
beanstalk-error: Public conditions
beanstalk-internal: The beanstalk-internal package
beanstalk.lisp: The cl-beanstalk/beanstalk․lisp file
beanstalkd-draining: Public conditions
beanstalkd-internal-error: Public conditions
beanstalkd-out-of-memory: Public conditions
buried-job: Public conditions

C
cl-beanstalk: The cl-beanstalk system
cl-beanstalk.asd: The cl-beanstalk/cl-beanstalk․asd file
Class, beanstalk-connection: Private classes
Condition, bad-message-format: Public conditions
Condition, bad-reply: Public conditions
Condition, beanstalk-error: Public conditions
Condition, beanstalkd-draining: Public conditions
Condition, beanstalkd-internal-error: Public conditions
Condition, beanstalkd-out-of-memory: Public conditions
Condition, buried-job: Public conditions
Condition, deadline-soon: Public conditions
Condition, expected-crlf: Public conditions
Condition, unknown-command: Public conditions
Condition, yaml-parsing-failed: Public conditions

D
deadline-soon: Public conditions

E
expected-crlf: Public conditions

F
File, beanstalk.lisp: The cl-beanstalk/beanstalk․lisp file
File, cl-beanstalk.asd: The cl-beanstalk/cl-beanstalk․asd file
File, package.lisp: The cl-beanstalk/package․lisp file

P
Package, beanstalk: The beanstalk package
Package, beanstalk-internal: The beanstalk-internal package
package.lisp: The cl-beanstalk/package․lisp file
pri: Private types

S
System, cl-beanstalk: The cl-beanstalk system

T
time-spec: Private types
tube-name: Private types
Type, pri: Private types
Type, time-spec: Private types
Type, tube-name: Private types

U
unknown-command: Public conditions

Y
yaml-parsing-failed: Public conditions