The leech Reference Manual

This is the leech Reference Manual, version 0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Nov 06 11:39:35 2023 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 leech

leech - parallel HTTP downloader

Maintainer

Manuel Odendahl <>

Author

Manuel Odendahl <>

License

BSD

Version

0

Dependencies
  • unit-test (system).
  • aserve (system).
Source

leech.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 leech/leech.asd

Source

leech.asd.

Parent Component

leech (system).

ASDF Systems

leech.

Packages

leech.system.


3.1.2 leech/package.lisp

Source

leech.asd.

Parent Component

leech (system).

Packages

leech.


3.1.3 leech/leech.lisp

Dependency

package.lisp (file).

Source

leech.asd.

Parent Component

leech (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 leech

Source

package.lisp.

Use List

common-lisp.

Public Interface
Internals

4.2 leech.system

Source

leech.asd.

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

5 Definitions

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


5.1 Public Interface


5.1.1 Ordinary functions

Function: load-proxies (file)
Package

leech.

Source

leech.lisp.


5.1.2 Generic functions

Generic Function: execute-job (queue job)
Package

leech.

Source

leech.lisp.

Methods
Method: execute-job ((queue child-leech-queue) (job job))
Method: execute-job ((queue leech-queue) (job leech-job))
Method: execute-job ((queue job-queue) (job job))
Method: execute-job :around ((queue job-queue) (job job))
Generic Function: execute-leech-job (queue job content)
Package

leech.

Source

leech.lisp.

Methods
Method: execute-leech-job ((queue leech-queue) (job leech-file-job) content)
Generic Function: job-error-handler (queue job e)
Package

leech.

Source

leech.lisp.

Methods
Method: job-error-handler ((queue pleech-queue) (job job) e)
Method: job-error-handler ((queue child-leech-queue) (job job) e)
Method: job-error-handler ((queue job-queue) (job job) e)
Generic Function: job-queue-add-job (queue job)
Package

leech.

Source

leech.lisp.

Methods
Method: job-queue-add-job ((queue job-queue) job)
Generic Function: job-queue-destroy (queue)
Package

leech.

Source

leech.lisp.

Methods
Method: job-queue-destroy :before ((queue pleech-queue))
Method: job-queue-destroy ((queue job-queue))
Generic Function: job-queue-idle-p (queue)
Package

leech.

Source

leech.lisp.

Methods
Method: job-queue-idle-p ((queue pleech-queue))
Method: job-queue-idle-p ((queue job-queue))
Generic Function: job-queue-job-count (queue)
Package

leech.

Source

leech.lisp.

Methods
Method: job-queue-job-count ((queue job-queue))
Generic Function: job-queue-print (queue)
Package

leech.

Source

leech.lisp.

Methods
Method: job-queue-print ((queue pleech-queue))
Method: job-queue-print ((queue job-queue))
Generic Function: job-queue-start (queue)
Package

leech.

Source

leech.lisp.

Methods
Method: job-queue-start :before ((queue pleech-queue))
Method: job-queue-start :before ((queue leech-queue))
Method: job-queue-start ((queue job-queue))
Method: job-queue-start :before ((queue job-queue))
Generic Function: leech-url (queue url &rest args)
Package

leech.

Methods
Method: leech-url ((queue leech-queue) url &rest args)
Source

leech.lisp.

Generic Reader: pleech-proxies (object)
Package

leech.

Methods
Reader Method: pleech-proxies ((pleech-queue pleech-queue))

automatically generated reader method

Source

leech.lisp.

Target Slot

proxies.

Generic Writer: (setf pleech-proxies) (object)
Package

leech.

Methods
Writer Method: (setf pleech-proxies) ((pleech-queue pleech-queue))

automatically generated writer method

Source

leech.lisp.

Target Slot

proxies.

Generic Reader: pleech-queues (object)
Package

leech.

Methods
Reader Method: pleech-queues ((pleech-queue pleech-queue))

automatically generated reader method

Source

leech.lisp.

Target Slot

leech-queues.

Generic Writer: (setf pleech-queues) (object)
Package

leech.

Methods
Writer Method: (setf pleech-queues) ((pleech-queue pleech-queue))

automatically generated writer method

Source

leech.lisp.

Target Slot

leech-queues.

Generic Reader: queue-cookie-jar (object)
Package

leech.

Methods
Reader Method: queue-cookie-jar ((leech-queue leech-queue))

automatically generated reader method

Source

leech.lisp.

Target Slot

cookie-jar.

Generic Writer: (setf queue-cookie-jar) (object)
Package

leech.

Methods
Writer Method: (setf queue-cookie-jar) ((leech-queue leech-queue))

automatically generated writer method

Source

leech.lisp.

Target Slot

cookie-jar.

Generic Reader: queue-errors (object)
Package

leech.

Methods
Reader Method: queue-errors ((job-queue job-queue))

automatically generated reader method

Source

leech.lisp.

Target Slot

errors.

Generic Writer: (setf queue-errors) (object)
Package

leech.

Methods
Writer Method: (setf queue-errors) ((job-queue job-queue))

automatically generated writer method

Source

leech.lisp.

Target Slot

errors.

Generic Reader: queue-jobs (object)
Package

leech.

Methods
Reader Method: queue-jobs ((job-queue job-queue))

automatically generated reader method

Source

leech.lisp.

Target Slot

jobs.

Generic Writer: (setf queue-jobs) (object)
Package

leech.

Methods
Writer Method: (setf queue-jobs) ((job-queue job-queue))

automatically generated writer method

Source

leech.lisp.

Target Slot

jobs.

Generic Reader: queue-proxy (object)
Package

leech.

Methods
Reader Method: queue-proxy ((leech-queue leech-queue))

automatically generated reader method

Source

leech.lisp.

Target Slot

proxy.

Generic Writer: (setf queue-proxy) (object)
Package

leech.

Methods
Writer Method: (setf queue-proxy) ((leech-queue leech-queue))

automatically generated writer method

Source

leech.lisp.

Target Slot

proxy.

Generic Function: schedule-job (queue job)
Package

leech.

Source

leech.lisp.

Methods
Method: schedule-job ((queue pleech-queue) job)
Method: schedule-job ((queue job-queue) (job job))

5.1.3 Standalone methods

Method: initialize-instance :after ((queue job-queue) &rest initargs)
Source

leech.lisp.

Method: print-object ((job job) s)
Source

leech.lisp.


5.1.4 Conditions

Condition: leech-error
Package

leech.

Source

leech.lisp.

Direct superclasses

error.


5.1.5 Classes

Class: job-queue
Package

leech.

Source

leech.lisp.

Direct subclasses

leech-queue.

Direct methods
Direct slots
Slot: proc
Initargs

:process

Readers

queue-process.

Writers

(setf queue-process).

Slot: jobs
Initargs

:jobs

Readers

queue-jobs.

Writers

(setf queue-jobs).

Slot: errors
Readers

queue-errors.

Writers

(setf queue-errors).

Slot: name
Initform

"job queue"

Initargs

:name

Readers

queue-name.

Writers

This slot is read-only.

Slot: waiting
Readers

queue-waiting.

Writers

(setf queue-waiting).

Slot: current
Readers

queue-current.

Writers

(setf queue-current).

Slot: lock
Initform

(acl-compat.mp:make-process-lock)

Initargs

:lock

Readers

queue-lock.

Writers

(setf queue-lock).

Class: leech-file-job
Package

leech.

Source

leech.lisp.

Direct superclasses

leech-job.

Direct methods
Direct slots
Slot: file
Initargs

:file

Readers

job-file.

Writers

This slot is read-only.

Class: leech-job
Package

leech.

Source

leech.lisp.

Direct superclasses

job.

Direct subclasses

leech-file-job.

Direct methods
Direct slots
Slot: url
Initargs

:url

Readers

job-url.

Writers

This slot is read-only.

Class: pleech-queue
Package

leech.

Source

leech.lisp.

Direct superclasses

leech-queue.

Direct methods
Direct slots
Slot: leech-queues
Initargs

:queues

Readers

pleech-queues.

Writers

(setf pleech-queues).

Slot: proxies
Initargs

:proxies

Readers

pleech-proxies.

Writers

(setf pleech-proxies).


5.2 Internals


5.2.1 Special variables

Special Variable: *job*
Package

leech.

Source

leech.lisp.

Special Variable: *queue*
Package

leech.

Source

leech.lisp.


5.2.2 Ordinary functions

Function: uri-make-pathname (uri pathname)
Package

leech.

Source

leech.lisp.


5.2.3 Generic functions

Generic Reader: job-file (object)
Package

leech.

Methods
Reader Method: job-file ((leech-file-job leech-file-job))

automatically generated reader method

Source

leech.lisp.

Target Slot

file.

Generic Reader: job-fun (object)
Package

leech.

Methods
Reader Method: job-fun ((job job))

automatically generated reader method

Source

leech.lisp.

Target Slot

fun.

Generic Reader: job-name (object)
Package

leech.

Methods
Reader Method: job-name ((job job))

automatically generated reader method

Source

leech.lisp.

Target Slot

name.

Generic Function: job-queue-run-function (queue)
Package

leech.

Source

leech.lisp.

Methods
Method: job-queue-run-function ((queue job-queue))
Generic Reader: job-url (object)
Package

leech.

Methods
Reader Method: job-url ((leech-job leech-job))

automatically generated reader method

Source

leech.lisp.

Target Slot

url.

Generic Reader: parent-queue (object)
Package

leech.

Methods
Reader Method: parent-queue ((child-leech-queue child-leech-queue))

automatically generated reader method

Source

leech.lisp.

Target Slot

parent-queue.

Generic Reader: queue-current (object)
Package

leech.

Methods
Reader Method: queue-current ((job-queue job-queue))

automatically generated reader method

Source

leech.lisp.

Target Slot

current.

Generic Writer: (setf queue-current) (object)
Package

leech.

Methods
Writer Method: (setf queue-current) ((job-queue job-queue))

automatically generated writer method

Source

leech.lisp.

Target Slot

current.

Generic Reader: queue-lock (object)
Package

leech.

Methods
Reader Method: queue-lock ((job-queue job-queue))

automatically generated reader method

Source

leech.lisp.

Target Slot

lock.

Generic Writer: (setf queue-lock) (object)
Package

leech.

Methods
Writer Method: (setf queue-lock) ((job-queue job-queue))

automatically generated writer method

Source

leech.lisp.

Target Slot

lock.

Generic Reader: queue-name (object)
Package

leech.

Methods
Reader Method: queue-name ((job-queue job-queue))

automatically generated reader method

Source

leech.lisp.

Target Slot

name.

Generic Reader: queue-process (object)
Package

leech.

Methods
Reader Method: queue-process ((job-queue job-queue))

automatically generated reader method

Source

leech.lisp.

Target Slot

proc.

Generic Writer: (setf queue-process) (object)
Package

leech.

Methods
Writer Method: (setf queue-process) ((job-queue job-queue))

automatically generated writer method

Source

leech.lisp.

Target Slot

proc.

Generic Reader: queue-waiting (object)
Package

leech.

Methods
Reader Method: queue-waiting ((job-queue job-queue))

automatically generated reader method

Source

leech.lisp.

Target Slot

waiting.

Generic Writer: (setf queue-waiting) (object)
Package

leech.

Methods
Writer Method: (setf queue-waiting) ((job-queue job-queue))

automatically generated writer method

Source

leech.lisp.

Target Slot

waiting.


5.2.4 Classes

Class: child-leech-queue
Package

leech.

Source

leech.lisp.

Direct superclasses

leech-queue.

Direct methods
Direct slots
Slot: parent-queue
Initargs

:parent-queue

Readers

parent-queue.

Writers

This slot is read-only.

Class: job
Package

leech.

Source

leech.lisp.

Direct subclasses

leech-job.

Direct methods
Direct slots
Slot: name
Initargs

:name

Readers

job-name.

Writers

This slot is read-only.

Slot: fun
Initargs

:fun

Readers

job-fun.

Writers

This slot is read-only.

Class: leech-queue
Package

leech.

Source

leech.lisp.

Direct superclasses

job-queue.

Direct subclasses
Direct methods
Direct slots
Slot: proxy
Initargs

:proxy

Readers

queue-proxy.

Writers

(setf queue-proxy).

Initargs

:cookie-jar

Readers

queue-cookie-jar.

Writers

(setf queue-cookie-jar).


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
E   F   G   I   J   L   M   P   Q   S   U  
Index Entry  Section

(
(setf pleech-proxies): Public generic functions
(setf pleech-proxies): Public generic functions
(setf pleech-queues): Public generic functions
(setf pleech-queues): Public generic functions
(setf queue-cookie-jar): Public generic functions
(setf queue-cookie-jar): Public generic functions
(setf queue-current): Private generic functions
(setf queue-current): Private generic functions
(setf queue-errors): Public generic functions
(setf queue-errors): Public generic functions
(setf queue-jobs): Public generic functions
(setf queue-jobs): Public generic functions
(setf queue-lock): Private generic functions
(setf queue-lock): Private generic functions
(setf queue-process): Private generic functions
(setf queue-process): Private generic functions
(setf queue-proxy): Public generic functions
(setf queue-proxy): Public generic functions
(setf queue-waiting): Private generic functions
(setf queue-waiting): Private generic functions

E
execute-job: Public generic functions
execute-job: Public generic functions
execute-job: Public generic functions
execute-job: Public generic functions
execute-job: Public generic functions
execute-leech-job: Public generic functions
execute-leech-job: Public generic functions

F
Function, load-proxies: Public ordinary functions
Function, uri-make-pathname: Private ordinary functions

G
Generic Function, (setf pleech-proxies): Public generic functions
Generic Function, (setf pleech-queues): Public generic functions
Generic Function, (setf queue-cookie-jar): Public generic functions
Generic Function, (setf queue-current): Private generic functions
Generic Function, (setf queue-errors): Public generic functions
Generic Function, (setf queue-jobs): Public generic functions
Generic Function, (setf queue-lock): Private generic functions
Generic Function, (setf queue-process): Private generic functions
Generic Function, (setf queue-proxy): Public generic functions
Generic Function, (setf queue-waiting): Private generic functions
Generic Function, execute-job: Public generic functions
Generic Function, execute-leech-job: Public generic functions
Generic Function, job-error-handler: Public generic functions
Generic Function, job-file: Private generic functions
Generic Function, job-fun: Private generic functions
Generic Function, job-name: Private generic functions
Generic Function, job-queue-add-job: Public generic functions
Generic Function, job-queue-destroy: Public generic functions
Generic Function, job-queue-idle-p: Public generic functions
Generic Function, job-queue-job-count: Public generic functions
Generic Function, job-queue-print: Public generic functions
Generic Function, job-queue-run-function: Private generic functions
Generic Function, job-queue-start: Public generic functions
Generic Function, job-url: Private generic functions
Generic Function, leech-url: Public generic functions
Generic Function, parent-queue: Private generic functions
Generic Function, pleech-proxies: Public generic functions
Generic Function, pleech-queues: Public generic functions
Generic Function, queue-cookie-jar: Public generic functions
Generic Function, queue-current: Private generic functions
Generic Function, queue-errors: Public generic functions
Generic Function, queue-jobs: Public generic functions
Generic Function, queue-lock: Private generic functions
Generic Function, queue-name: Private generic functions
Generic Function, queue-process: Private generic functions
Generic Function, queue-proxy: Public generic functions
Generic Function, queue-waiting: Private generic functions
Generic Function, schedule-job: Public generic functions

I
initialize-instance: Public standalone methods

J
job-error-handler: Public generic functions
job-error-handler: Public generic functions
job-error-handler: Public generic functions
job-error-handler: Public generic functions
job-file: Private generic functions
job-file: Private generic functions
job-fun: Private generic functions
job-fun: Private generic functions
job-name: Private generic functions
job-name: Private generic functions
job-queue-add-job: Public generic functions
job-queue-add-job: Public generic functions
job-queue-destroy: Public generic functions
job-queue-destroy: Public generic functions
job-queue-destroy: Public generic functions
job-queue-idle-p: Public generic functions
job-queue-idle-p: Public generic functions
job-queue-idle-p: Public generic functions
job-queue-job-count: Public generic functions
job-queue-job-count: Public generic functions
job-queue-print: Public generic functions
job-queue-print: Public generic functions
job-queue-print: Public generic functions
job-queue-run-function: Private generic functions
job-queue-run-function: Private generic functions
job-queue-start: Public generic functions
job-queue-start: Public generic functions
job-queue-start: Public generic functions
job-queue-start: Public generic functions
job-queue-start: Public generic functions
job-url: Private generic functions
job-url: Private generic functions

L
leech-url: Public generic functions
leech-url: Public generic functions
load-proxies: Public ordinary functions

M
Method, (setf pleech-proxies): Public generic functions
Method, (setf pleech-queues): Public generic functions
Method, (setf queue-cookie-jar): Public generic functions
Method, (setf queue-current): Private generic functions
Method, (setf queue-errors): Public generic functions
Method, (setf queue-jobs): Public generic functions
Method, (setf queue-lock): Private generic functions
Method, (setf queue-process): Private generic functions
Method, (setf queue-proxy): Public generic functions
Method, (setf queue-waiting): Private generic functions
Method, execute-job: Public generic functions
Method, execute-job: Public generic functions
Method, execute-job: Public generic functions
Method, execute-job: Public generic functions
Method, execute-leech-job: Public generic functions
Method, initialize-instance: Public standalone methods
Method, job-error-handler: Public generic functions
Method, job-error-handler: Public generic functions
Method, job-error-handler: Public generic functions
Method, job-file: Private generic functions
Method, job-fun: Private generic functions
Method, job-name: Private generic functions
Method, job-queue-add-job: Public generic functions
Method, job-queue-destroy: Public generic functions
Method, job-queue-destroy: Public generic functions
Method, job-queue-idle-p: Public generic functions
Method, job-queue-idle-p: Public generic functions
Method, job-queue-job-count: Public generic functions
Method, job-queue-print: Public generic functions
Method, job-queue-print: Public generic functions
Method, job-queue-run-function: Private generic functions
Method, job-queue-start: Public generic functions
Method, job-queue-start: Public generic functions
Method, job-queue-start: Public generic functions
Method, job-queue-start: Public generic functions
Method, job-url: Private generic functions
Method, leech-url: Public generic functions
Method, parent-queue: Private generic functions
Method, pleech-proxies: Public generic functions
Method, pleech-queues: Public generic functions
Method, print-object: Public standalone methods
Method, queue-cookie-jar: Public generic functions
Method, queue-current: Private generic functions
Method, queue-errors: Public generic functions
Method, queue-jobs: Public generic functions
Method, queue-lock: Private generic functions
Method, queue-name: Private generic functions
Method, queue-process: Private generic functions
Method, queue-proxy: Public generic functions
Method, queue-waiting: Private generic functions
Method, schedule-job: Public generic functions
Method, schedule-job: Public generic functions

P
parent-queue: Private generic functions
parent-queue: Private generic functions
pleech-proxies: Public generic functions
pleech-proxies: Public generic functions
pleech-queues: Public generic functions
pleech-queues: Public generic functions
print-object: Public standalone methods

Q
queue-cookie-jar: Public generic functions
queue-cookie-jar: Public generic functions
queue-current: Private generic functions
queue-current: Private generic functions
queue-errors: Public generic functions
queue-errors: Public generic functions
queue-jobs: Public generic functions
queue-jobs: Public generic functions
queue-lock: Private generic functions
queue-lock: Private generic functions
queue-name: Private generic functions
queue-name: Private generic functions
queue-process: Private generic functions
queue-process: Private generic functions
queue-proxy: Public generic functions
queue-proxy: Public generic functions
queue-waiting: Private generic functions
queue-waiting: Private generic functions

S
schedule-job: Public generic functions
schedule-job: Public generic functions
schedule-job: Public generic functions

U
uri-make-pathname: Private ordinary functions