This is the pooler Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 17:35:29 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
poolerGeneric thread-safe pooling facility for your library.
quasi <quasi@quasilabs.in>
MIT
A Trivial, Fast & Thread-Safe Pooling Library for Common Lisp.
We need pools for items which have heavy cost of creation and which we can reuse.
A typical use case is connection pools.
Pool item creation (as required) is automatic on fetch-from pool. Pool-item’s are created and destroyed using user supplied funcitons. The pool has a idle timeout after which all the existing pool-item’s are destroyed and new ones created (pool-init). The pool has a threshold number of items which it tries to maintain.
1.0.0
sb-concurrency (system).
package.lisp (file).
utils.lisp (file).
pooler.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
pooler/utils.lisppackage.lisp (file).
pooler (system).
copy-q (function).
dequeue (macro).
empty-queue? (function).
enqueue (macro).
enqueue-at-end (function).
make-empty-queue (function).
make-pool-lock (function).
make-q (function).
make-queue (function).
q (structure).
q-elements (reader).
(setf q-elements) (writer).
q-key (reader).
(setf q-key) (writer).
q-last (reader).
(setf q-last) (writer).
q-p (function).
queue-empty-p (macro).
queue-front (function).
remove-front (function).
with-pool-lock (macro).
pooler/pooler.lisputils.lisp (file).
pooler (system).
copy-pool (function).
destroy-pool-item (function).
fetch-from-aux (function).
message (reader method).
message (reader method).
(setf message) (writer method).
(setf message) (writer method).
name (reader method).
(setf name) (writer method).
new-pool-item (function).
pool (structure).
pool-capacity (reader).
(setf pool-capacity) (writer).
pool-current-size (reader).
(setf pool-current-size) (writer).
pool-empty-error (condition).
pool-error (function).
pool-error (condition).
pool-item-creation-error (condition).
pool-item-destroyer (reader).
pool-item-maker (reader).
pool-last-access (reader).
(setf pool-last-access) (writer).
pool-lock (reader).
pool-name (reader).
pool-p (function).
pool-queue (reader).
(setf pool-queue) (writer).
pool-threshold (reader).
(setf pool-threshold) (writer).
pool-timeout (reader).
(setf pool-timeout) (writer).
pool-total-created (reader).
(setf pool-total-created) (writer).
pool-total-pool-inits (reader).
(setf pool-total-pool-inits) (writer).
pool-total-uses (reader).
(setf pool-total-uses) (writer).
pool-warning (condition).
Packages are listed by definition order.
poolercommon-lisp.
copy-pool (function).
copy-q (function).
dequeue (macro).
destroy-pool-item (function).
empty-queue? (function).
enqueue (macro).
enqueue-at-end (function).
fetch-from-aux (function).
make-empty-queue (function).
make-pool-lock (function).
make-q (function).
make-queue (function).
message (generic reader).
(setf message) (generic writer).
name (generic reader).
(setf name) (generic writer).
new-pool-item (function).
pool (structure).
pool-capacity (reader).
(setf pool-capacity) (writer).
pool-current-size (reader).
(setf pool-current-size) (writer).
pool-empty-error (condition).
pool-error (function).
pool-error (condition).
pool-item-creation-error (condition).
pool-item-destroyer (reader).
pool-item-maker (reader).
pool-last-access (reader).
(setf pool-last-access) (writer).
pool-lock (reader).
pool-name (reader).
pool-p (function).
pool-queue (reader).
(setf pool-queue) (writer).
pool-threshold (reader).
(setf pool-threshold) (writer).
pool-timeout (reader).
(setf pool-timeout) (writer).
pool-total-created (reader).
(setf pool-total-created) (writer).
pool-total-pool-inits (reader).
(setf pool-total-pool-inits) (writer).
pool-total-uses (reader).
(setf pool-total-uses) (writer).
pool-warning (condition).
q (structure).
q-elements (reader).
(setf q-elements) (writer).
q-key (reader).
(setf q-key) (writer).
q-last (reader).
(setf q-last) (writer).
q-p (function).
queue-empty-p (macro).
queue-front (function).
remove-front (function).
with-pool-lock (macro).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Tries a couple of times to fetch from pool. Grows the pool.
Cleans up the pool & reinits it with MIN-THRESHOLD number of POOL-ITEM
Returns a pool object to the pool
Destroys the POOL-ITEM using the item-destroyer funciton stored in the pool
Are there no elements in the queue?
Add a list of items to the end of the queue.
Fetches a pool item from pool.
Creates a new POOL-ITEM using the item-maker funciton stored in the pool
Signals an error of type POOL-ERROR with the provided information
Return the element at the front of the queue.
Remove the element from the front of the queue and return it.
pool-warning)) ¶pool-warning)) ¶pool-error)) ¶pool-error)) ¶pool-error)) ¶pool-error)) ¶name.
Superclass for all errors related to Pooler.
warning.
(quote nil)
:message
structure-object.
simple-string
"default pool"
This slot is read-only.
(pooler::make-queue)
function
(function (lambda nil (quote pooler::sample-item)))
This slot is read-only.
function
(function (lambda (pooler::item) (setf pooler::item nil)))
This slot is read-only.
fixnum
40
fixnum
2
fixnum
300
integer
0
fixnum
0
fixnum
0
fixnum
0
fixnum
0
| Jump to: | (
C D E F G M N P Q R W |
|---|
| Jump to: | (
C D E F G M N P Q R W |
|---|
| Jump to: | C E I K L M N Q S T |
|---|
| Jump to: | C E I K L M N Q S T |
|---|
| Jump to: | C F P Q S U |
|---|
| Jump to: | C F P Q S U |
|---|