This is the cacle Reference Manual, version 1.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 14:47:40 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
cacleExtensible cache services for Common Lisp
Jussi Lahdenniemi <jussi@lahdenniemi.fi>
Jussi Lahdenniemi <jussi@lahdenniemi.fi>
MIT
1.0.1
bordeaux-threads (system).
cacle (module).
Modules are listed depth-first from the system components tree.
cacle/caclecacle (system).
package.lisp (file).
testsuite.lisp (file).
entry.lisp (file).
policy.lisp (file).
simple-policies.lisp (file).
lfu-policies.lisp (file).
cache.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cacle/cacle.asdcacle/cacle/package.lispcacle/cacle/testsuite.lispcacle/cacle/entry.lispcacle/cacle/policy.lispcacle/cacle/simple-policies.lispcacle/cacle/lfu-policies.lispcacle/cacle/cache.lispcacle/cacle/testsuite.lisppackage.lisp (file).
cacle (module).
cacle/cacle/entry.lisppackage.lisp (file).
testsuite.lisp (file).
cacle (module).
cache-entry (class).
entry-expiry (reader method).
entry-index (reader method).
(setf entry-index) (writer method).
entry-key (reader method).
entry-next (reader method).
entry-previous (reader method).
entry-size (reader method).
entry-valid-p (method).
indexed-cache-entry (class).
link-after (method).
link-before (method).
linked-cache-entry (class).
print-object (method).
shared-initialize (method).
unlink (method).
ensure-unlinked (function).
entry-busy (reader method).
(setf entry-busy) (writer method).
cacle/cacle/policy.lispentry.lisp (file).
cacle (module).
access-entry (generic function).
entry-added (generic function).
entry-removed (generic function).
evict-entry (generic function).
replacement-policy (class).
cacle/cacle/simple-policies.lisppolicy.lisp (file).
cacle (module).
access-entry (method).
access-entry (method).
access-entry (method).
access-entry (method).
entry-added (method).
entry-added (method).
entry-added (method).
entry-added (method).
entry-removed (method).
entry-removed (method).
evict-entry (method).
evict-entry (method).
evict-entry (method).
fifo-replacement-policy (class).
lifo-replacement-policy (class).
linked-list-head (reader method).
linked-list-replacement-policy (class).
lru-replacement-policy (class).
mru-replacement-policy (class).
print-object (method).
random-replacement-policy (class).
array-replacement-policy (class).
cacle/cacle/lfu-policies.lisppolicy.lisp (file).
cacle (module).
access-entry (method).
entry-added (method).
entry-added (method).
entry-removed (method).
evict-entry (method).
evict-entry (method).
lfu-replacement-policy (class).
lfuda-replacement-policy (class).
print-object (method).
bubble-up (function).
cache-entry-weight (reader method).
(setf cache-entry-weight) (writer method).
heap-cache-entry (class).
heap-left (function).
heap-left-idx (function).
heap-parent (function).
heap-parent-idx (function).
heap-right (function).
heap-right-idx (function).
heap-swap (function).
sink-down (function).
cacle/cacle/cache.lispentry.lisp (file).
simple-policies.lisp (file).
cacle (module).
cache (class).
(setf cache-cleanup) (setf expander).
cache-cleanup (reader method).
cache-count (method).
cache-fetch (method).
cache-flush (method).
(setf cache-lifetime) (setf expander).
cache-lifetime (reader method).
(setf cache-max-size) (setf expander).
cache-max-size (reader method).
cache-policy (reader method).
(setf cache-provider) (setf expander).
cache-provider (reader method).
cache-release (method).
cache-remove (method).
cache-size (method).
initialize-instance (method).
make-cache (function).
print-object (method).
with-cache-fetch (macro).
*cleanup-list* (special variable).
cache-sanity-check (method).
ensure-cache-size (function).
prepare-cleanup (function).
set-cache-cleanup (method).
set-cache-lifetime (method).
set-cache-max-size (method).
set-cache-provider (method).
with-collected-cleanups (macro).
Packages are listed by definition order.
caclecommon-lisp.
access-entry (generic function).
cache (class).
(setf cache-cleanup) (setf expander).
cache-cleanup (generic reader).
cache-count (generic function).
cache-entry (class).
cache-fetch (generic function).
cache-flush (generic function).
(setf cache-lifetime) (setf expander).
cache-lifetime (generic reader).
(setf cache-max-size) (setf expander).
cache-max-size (generic reader).
cache-policy (generic reader).
(setf cache-provider) (setf expander).
cache-provider (generic reader).
cache-release (generic function).
cache-remove (generic function).
cache-size (generic function).
entry-added (generic function).
entry-expiry (generic reader).
entry-index (generic reader).
(setf entry-index) (generic writer).
entry-key (generic reader).
entry-next (generic reader).
entry-previous (generic reader).
entry-removed (generic function).
entry-size (generic reader).
entry-valid-p (generic function).
evict-entry (generic function).
fifo-replacement-policy (class).
indexed-cache-entry (class).
lfu-replacement-policy (class).
lfuda-replacement-policy (class).
lifo-replacement-policy (class).
link-after (generic function).
link-before (generic function).
linked-cache-entry (class).
linked-list-head (generic reader).
linked-list-replacement-policy (class).
lru-replacement-policy (class).
make-cache (function).
mru-replacement-policy (class).
random-replacement-policy (class).
replacement-policy (class).
unlink (generic function).
with-cache-fetch (macro).
*cleanup-list* (special variable).
array-replacement-policy (class).
bubble-up (function).
cache-entry-weight (generic reader).
(setf cache-entry-weight) (generic writer).
cache-sanity-check (generic function).
ensure-cache-size (function).
ensure-unlinked (function).
entry-busy (generic reader).
(setf entry-busy) (generic writer).
heap-cache-entry (class).
heap-left (function).
heap-left-idx (function).
heap-parent (function).
heap-parent-idx (function).
heap-right (function).
heap-right-idx (function).
heap-swap (function).
prepare-cleanup (function).
set-cache-cleanup (generic function).
set-cache-lifetime (generic function).
set-cache-max-size (generic function).
set-cache-provider (generic function).
sink-down (function).
with-collected-cleanups (macro).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Combines a cache-fetch and cache-release in a form.
cache-cleanup (generic reader).
set-cache-cleanup (generic function).
cache-lifetime (generic reader).
set-cache-lifetime (generic function).
cache-max-size (generic reader).
set-cache-max-size (generic function).
cache-provider (generic reader).
set-cache-provider (generic function).
Create a new cache with the specified maximum size, provider function, and options.
lfu-replacement-policy) (entry heap-cache-entry)) ¶mru-replacement-policy) (entry cache-entry)) ¶lru-replacement-policy) (entry cache-entry)) ¶array-replacement-policy) (entry cache-entry)) ¶linked-list-replacement-policy) (entry linked-cache-entry)) ¶cache) key &key only-if-cached force-fetch) ¶Fetch an item for the given key.
If the item is not currently in the cache, or has expired, it is fetched from the provider and stored in the cache.
If force-fetch is specified, a new value is fetched from the provider even if it already exists in the cache.
If a cleanup function is defined for the cache, remember to call cache-release with the second value returned by cache-fetch!
lfuda-replacement-policy) (entry cache-entry)) ¶lfu-replacement-policy) (entry cache-entry)) ¶array-replacement-policy) (entry cache-entry)) ¶array-replacement-policy) (entry cache-entry)) ¶linked-list-replacement-policy) (entry cache-entry)) ¶linked-list-replacement-policy) (entry cache-entry)) ¶cache-entry)) ¶automatically generated reader method
indexed-cache-entry)) ¶automatically generated reader method
indexed-cache-entry)) ¶automatically generated writer method
cache-entry)) ¶automatically generated reader method
key.
linked-cache-entry)) ¶automatically generated reader method
next.
linked-cache-entry)) ¶automatically generated reader method
prev.
lfu-replacement-policy) (entry heap-cache-entry)) ¶array-replacement-policy) (entry indexed-cache-entry)) ¶linked-list-replacement-policy) (entry linked-cache-entry)) ¶cache-entry)) ¶automatically generated reader method
size.
cache-entry)) ¶lfuda-replacement-policy) size-hint) ¶lfu-replacement-policy) size-hint) ¶random-replacement-policy) size-hint) ¶lifo-replacement-policy) size-hint) ¶fifo-replacement-policy) size-hint) ¶linked-cache-entry) (ref linked-cache-entry)) ¶linked-cache-entry) (ref linked-cache-entry)) ¶linked-list-replacement-policy)) ¶automatically generated reader method
head.
linked-cache-entry)) ¶cache) &rest initargs &key policy provider hash-test &allow-other-keys) ¶cache-entry) stream) ¶linked-list-replacement-policy) stream) ¶heap-cache-entry) stream) ¶:max-size
This slot is read-only.
0
(bordeaux-threads:make-lock "cache")
:provider
This slot is read-only.
:cleanup
This slot is read-only.
:lifetime
This slot is read-only.
:fifo
:policy
This slot is read-only.
(make-array 16 :adjustable t :fill-pointer 0)
0
(make-instance (quote cacle:linked-cache-entry))
This slot is read-only.
heap-cache-entry)) ¶automatically generated reader method
heap-cache-entry)) ¶automatically generated writer method
cache-entry)) ¶automatically generated reader method
busy.
cache-entry)) ¶automatically generated writer method
busy.
| Jump to: | (
A B C E F G H I L M P S U W |
|---|
| Jump to: | (
A B C E F G H I L M P S U W |
|---|
| Jump to: | *
A B C D E H I K L M N P S U W |
|---|
| Jump to: | *
A B C D E H I K L M N P S U W |
|---|
| Jump to: | A C E F H I L M P R S T |
|---|
| Jump to: | A C E F H I L M P R S T |
|---|