The cacle Reference Manual

This is the cacle Reference Manual, version 1.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sat Dec 03 19:40:37 2022 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 cacle

Extensible cache services for Common Lisp

Maintainer

Jussi Lahdenniemi <>

Author

Jussi Lahdenniemi <>

License

MIT

Version

1.0.1

Dependency

bordeaux-threads (system).

Source

cacle.asd.

Child Component

cacle (module).


3 Modules

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


3.1 cacle/cacle

Source

cacle.asd.

Parent Component

cacle (system).

Child Components

4 Files

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


4.1 Lisp


4.1.1 cacle/cacle.asd

Source

cacle.asd.

Parent Component

cacle (system).

ASDF Systems

cacle.

Packages

cacle-system.


4.1.2 cacle/cacle/package.lisp

Source

cacle.asd.

Parent Component

cacle (module).

Packages

cacle.


4.1.3 cacle/cacle/testsuite.lisp

Dependency

package.lisp (file).

Source

cacle.asd.

Parent Component

cacle (module).


4.1.4 cacle/cacle/entry.lisp

Dependencies
Source

cacle.asd.

Parent Component

cacle (module).

Public Interface
Internals

4.1.5 cacle/cacle/policy.lisp

Dependency

entry.lisp (file).

Source

cacle.asd.

Parent Component

cacle (module).

Public Interface

4.1.6 cacle/cacle/simple-policies.lisp

Dependency

policy.lisp (file).

Source

cacle.asd.

Parent Component

cacle (module).

Public Interface
Internals

array-replacement-policy (class).


4.1.7 cacle/cacle/lfu-policies.lisp

Dependency

policy.lisp (file).

Source

cacle.asd.

Parent Component

cacle (module).

Public Interface
Internals

4.1.8 cacle/cacle/cache.lisp

Dependencies
Source

cacle.asd.

Parent Component

cacle (module).

Public Interface
Internals

5 Packages

Packages are listed by definition order.


5.1 cacle

Source

package.lisp.

Use List

common-lisp.

Public Interface
Internals

5.2 cacle-system

Source

cacle.asd.

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

6 Definitions

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


6.1 Public Interface


6.1.1 Macros

Macro: with-cache-fetch (var (cache key &key only-if-cached) &body body)

Combines a cache-fetch and cache-release in a form.

Package

cacle.

Source

cache.lisp.


6.1.2 Setf expanders

Setf Expander: (setf cache-cleanup) (cache)
Package

cacle.

Source

cache.lisp.

Reader

cache-cleanup (generic reader).

Writer

set-cache-cleanup (generic function).

Setf Expander: (setf cache-lifetime) (cache)
Package

cacle.

Source

cache.lisp.

Reader

cache-lifetime (generic reader).

Writer

set-cache-lifetime (generic function).

Setf Expander: (setf cache-max-size) (cache)
Package

cacle.

Source

cache.lisp.

Reader

cache-max-size (generic reader).

Writer

set-cache-max-size (generic function).

Setf Expander: (setf cache-provider) (cache)
Package

cacle.

Source

cache.lisp.

Reader

cache-provider (generic reader).

Writer

set-cache-provider (generic function).


6.1.3 Ordinary functions

Function: make-cache (max-size provider &key test policy lifetime cleanup)

Create a new cache with the specified maximum size, provider function, and options.

Package

cacle.

Source

cache.lisp.


6.1.4 Generic functions

Generic Function: access-entry (policy entry)
Package

cacle.

Source

policy.lisp.

Methods
Method: access-entry ((policy lfu-replacement-policy) (entry heap-cache-entry))
Source

lfu-policies.lisp.

Method: access-entry ((policy mru-replacement-policy) (entry cache-entry))
Source

simple-policies.lisp.

Method: access-entry ((policy lru-replacement-policy) (entry cache-entry))
Source

simple-policies.lisp.

Method: access-entry ((policy array-replacement-policy) (entry cache-entry))
Source

simple-policies.lisp.

Method: access-entry ((policy linked-list-replacement-policy) (entry linked-cache-entry))
Source

simple-policies.lisp.

Generic Reader: cache-cleanup (object)
Package

cacle.

Setf expander for this generic reader

(setf cache-cleanup).

Methods
Reader Method: cache-cleanup ((cache cache))

automatically generated reader method

Source

cache.lisp.

Target Slot

cleanup.

Generic Function: cache-count (cache)
Package

cacle.

Methods
Method: cache-count ((cache cache))

Returns the current count of items in the cache.

Source

cache.lisp.

Generic Function: cache-fetch (cache key &key only-if-cached force-fetch)
Package

cacle.

Methods
Method: cache-fetch ((cache 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!

Source

cache.lisp.

Generic Function: cache-flush (cache)
Package

cacle.

Methods
Method: cache-flush ((cache cache))

Flush the cache, removing all items currently stored in it. If a cleanup function is defined for the cache, it is called for every item.

Source

cache.lisp.

Generic Reader: cache-lifetime (object)
Package

cacle.

Setf expander for this generic reader

(setf cache-lifetime).

Methods
Reader Method: cache-lifetime ((cache cache))

automatically generated reader method

Source

cache.lisp.

Target Slot

lifetime.

Generic Reader: cache-max-size (object)
Package

cacle.

Setf expander for this generic reader

(setf cache-max-size).

Methods
Reader Method: cache-max-size ((cache cache))

automatically generated reader method

Source

cache.lisp.

Target Slot

max-size.

Generic Reader: cache-policy (object)
Package

cacle.

Methods
Reader Method: cache-policy ((cache cache))

automatically generated reader method

Source

cache.lisp.

Target Slot

policy.

Generic Reader: cache-provider (object)
Package

cacle.

Setf expander for this generic reader

(setf cache-provider).

Methods
Reader Method: cache-provider ((cache cache))

automatically generated reader method

Source

cache.lisp.

Target Slot

provider.

Generic Function: cache-release (cache entry)
Package

cacle.

Methods
Method: cache-release ((cache cache) entry)

Releases a reference for an item fetched earlier.
An item fetched from the cache with cache-fetch will not be cleaned up before it is released.

Source

cache.lisp.

Generic Function: cache-remove (cache key)
Package

cacle.

Methods
Method: cache-remove ((cache cache) key)

Remove the item with the specified key from the cache.

Source

cache.lisp.

Generic Function: cache-size (cache)
Package

cacle.

Methods
Method: cache-size ((cache cache))

Returns the current size of the cache.

Source

cache.lisp.

Generic Function: entry-added (policy entry)
Package

cacle.

Source

policy.lisp.

Methods
Method: entry-added ((policy lfuda-replacement-policy) (entry cache-entry))
Source

lfu-policies.lisp.

Method: entry-added ((policy lfu-replacement-policy) (entry cache-entry))
Source

lfu-policies.lisp.

Method: entry-added ((policy array-replacement-policy) (entry cache-entry))
Source

simple-policies.lisp.

Method: entry-added :before ((policy array-replacement-policy) (entry cache-entry))
Source

simple-policies.lisp.

Method: entry-added ((policy linked-list-replacement-policy) (entry cache-entry))
Source

simple-policies.lisp.

Method: entry-added :before ((policy linked-list-replacement-policy) (entry cache-entry))
Source

simple-policies.lisp.

Generic Reader: entry-expiry (object)
Package

cacle.

Methods
Reader Method: entry-expiry ((cache-entry cache-entry))

automatically generated reader method

Source

entry.lisp.

Target Slot

expiry.

Generic Reader: entry-index (object)
Package

cacle.

Methods
Reader Method: entry-index ((indexed-cache-entry indexed-cache-entry))

automatically generated reader method

Source

entry.lisp.

Target Slot

index.

Generic Writer: (setf entry-index) (object)
Package

cacle.

Methods
Writer Method: (setf entry-index) ((indexed-cache-entry indexed-cache-entry))

automatically generated writer method

Source

entry.lisp.

Target Slot

index.

Generic Reader: entry-key (object)
Package

cacle.

Methods
Reader Method: entry-key ((cache-entry cache-entry))

automatically generated reader method

Source

entry.lisp.

Target Slot

key.

Generic Reader: entry-next (object)
Package

cacle.

Methods
Reader Method: entry-next ((linked-cache-entry linked-cache-entry))

automatically generated reader method

Source

entry.lisp.

Target Slot

next.

Generic Reader: entry-previous (object)
Package

cacle.

Methods
Reader Method: entry-previous ((linked-cache-entry linked-cache-entry))

automatically generated reader method

Source

entry.lisp.

Target Slot

prev.

Generic Function: entry-removed (policy entry)
Package

cacle.

Source

policy.lisp.

Methods
Method: entry-removed ((policy lfu-replacement-policy) (entry heap-cache-entry))
Source

lfu-policies.lisp.

Method: entry-removed ((policy array-replacement-policy) (entry indexed-cache-entry))
Source

simple-policies.lisp.

Method: entry-removed ((policy linked-list-replacement-policy) (entry linked-cache-entry))
Source

simple-policies.lisp.

Generic Reader: entry-size (object)
Package

cacle.

Methods
Reader Method: entry-size ((cache-entry cache-entry))

automatically generated reader method

Source

entry.lisp.

Target Slot

size.

Generic Function: entry-valid-p (entry)
Package

cacle.

Methods
Method: entry-valid-p ((entry cache-entry))
Source

entry.lisp.

Generic Function: evict-entry (policy size-hint)
Package

cacle.

Source

policy.lisp.

Methods
Method: evict-entry ((policy lfuda-replacement-policy) size-hint)
Source

lfu-policies.lisp.

Method: evict-entry ((policy lfu-replacement-policy) size-hint)
Source

lfu-policies.lisp.

Method: evict-entry ((policy random-replacement-policy) size-hint)
Source

simple-policies.lisp.

Method: evict-entry ((policy lifo-replacement-policy) size-hint)
Source

simple-policies.lisp.

Method: evict-entry ((policy fifo-replacement-policy) size-hint)
Source

simple-policies.lisp.

Package

cacle.

Methods
Source

entry.lisp.

Package

cacle.

Methods
Source

entry.lisp.

Generic Reader: linked-list-head (object)
Package

cacle.

Methods
Reader Method: linked-list-head ((linked-list-replacement-policy linked-list-replacement-policy))

automatically generated reader method

Source

simple-policies.lisp.

Target Slot

head.

Package

cacle.

Methods
Source

entry.lisp.


6.1.5 Standalone methods

Method: initialize-instance ((cache cache) &rest initargs &key policy provider hash-test &allow-other-keys)
Source

cache.lisp.

Method: print-object ((obj cache) stream)
Source

cache.lisp.

Method: print-object ((obj linked-list-replacement-policy) stream)
Source

simple-policies.lisp.

Method: print-object ((obj cache-entry) stream)
Source

entry.lisp.

Method: print-object ((obj heap-cache-entry) stream)
Source

lfu-policies.lisp.

Method: shared-initialize ((entry linked-cache-entry) slot-names &rest initargs)
Source

entry.lisp.


6.1.6 Classes

Class: cache
Package

cacle.

Source

cache.lisp.

Direct methods
Direct slots
Slot: max-size
Initargs

:max-size

Readers

cache-max-size.

Writers

This slot is read-only.

Slot: size
Initform

0

Slot: lock
Initform

(bordeaux-threads:make-lock "cache")

Slot: hash
Slot: provider
Initargs

:provider

Readers

cache-provider.

Writers

This slot is read-only.

Slot: cleanup
Initargs

:cleanup

Readers

cache-cleanup.

Writers

This slot is read-only.

Slot: lifetime
Initargs

:lifetime

Readers

cache-lifetime.

Writers

This slot is read-only.

Slot: policy
Initform

:fifo

Initargs

:policy

Readers

cache-policy.

Writers

This slot is read-only.

Class: cache-entry
Package

cacle.

Source

entry.lisp.

Direct subclasses
Direct methods
Direct slots
Slot: key
Initargs

:key

Readers

entry-key.

Writers

This slot is read-only.

Slot: data
Slot: pending
Initargs

:pending

Slot: busy
Initform

0

Readers

entry-busy.

Writers

(setf entry-busy).

Slot: size
Readers

entry-size.

Writers

This slot is read-only.

Slot: expiry
Readers

entry-expiry.

Writers

This slot is read-only.

Class: fifo-replacement-policy
Package

cacle.

Source

simple-policies.lisp.

Direct superclasses

linked-list-replacement-policy.

Direct subclasses

lru-replacement-policy.

Direct methods

evict-entry.

Class: indexed-cache-entry
Package

cacle.

Source

entry.lisp.

Direct superclasses

cache-entry.

Direct subclasses

heap-cache-entry.

Direct methods
Direct slots
Slot: index
Readers

entry-index.

Writers

(setf entry-index).

Class: lfu-replacement-policy
Package

cacle.

Source

lfu-policies.lisp.

Direct superclasses

replacement-policy.

Direct subclasses

lfuda-replacement-policy.

Direct methods
Direct slots
Slot: heap
Initform

(make-array 16 :adjustable t :fill-pointer 0)

Class: lfuda-replacement-policy
Package

cacle.

Source

lfu-policies.lisp.

Direct superclasses

lfu-replacement-policy.

Direct methods
Direct slots
Slot: age
Initform

0

Class: lifo-replacement-policy
Package

cacle.

Source

simple-policies.lisp.

Direct superclasses

linked-list-replacement-policy.

Direct subclasses

mru-replacement-policy.

Direct methods

evict-entry.

Class: linked-cache-entry
Package

cacle.

Source

entry.lisp.

Direct superclasses

cache-entry.

Direct methods
Direct slots
Slot: next
Readers

entry-next.

Writers

This slot is read-only.

Slot: prev
Readers

entry-previous.

Writers

This slot is read-only.

Class: linked-list-replacement-policy
Package

cacle.

Source

simple-policies.lisp.

Direct superclasses

replacement-policy.

Direct subclasses
Direct methods
Direct slots
Slot: head
Initform

(make-instance (quote cacle:linked-cache-entry))

Readers

linked-list-head.

Writers

This slot is read-only.

Class: lru-replacement-policy
Package

cacle.

Source

simple-policies.lisp.

Direct superclasses

fifo-replacement-policy.

Direct methods

access-entry.

Class: mru-replacement-policy
Package

cacle.

Source

simple-policies.lisp.

Direct superclasses

lifo-replacement-policy.

Direct methods

access-entry.

Class: random-replacement-policy
Package

cacle.

Source

simple-policies.lisp.

Direct superclasses

array-replacement-policy.

Direct methods

evict-entry.

Class: replacement-policy
Package

cacle.

Source

policy.lisp.

Direct subclasses

6.2 Internals


6.2.1 Special variables

Special Variable: *cleanup-list*
Package

cacle.

Source

cache.lisp.


6.2.2 Macros

Macro: with-collected-cleanups ((cache) &body body)
Package

cacle.

Source

cache.lisp.


6.2.3 Ordinary functions

Function: bubble-up (heap idx)
Package

cacle.

Source

lfu-policies.lisp.

Function: ensure-cache-size (cache)
Package

cacle.

Source

cache.lisp.

Function: ensure-unlinked (entry)
Package

cacle.

Source

entry.lisp.

Function: heap-left (heap idx)
Package

cacle.

Source

lfu-policies.lisp.

Function: heap-left-idx (idx)
Package

cacle.

Source

lfu-policies.lisp.

Function: heap-parent (heap idx)
Package

cacle.

Source

lfu-policies.lisp.

Function: heap-parent-idx (idx)
Package

cacle.

Source

lfu-policies.lisp.

Function: heap-right (heap idx)
Package

cacle.

Source

lfu-policies.lisp.

Function: heap-right-idx (idx)
Package

cacle.

Source

lfu-policies.lisp.

Function: heap-swap (heap i1 i2)
Package

cacle.

Source

lfu-policies.lisp.

Function: prepare-cleanup (entry hash)
Package

cacle.

Source

cache.lisp.

Function: sink-down (heap idx &optional prefer-to-sink)
Package

cacle.

Source

lfu-policies.lisp.


6.2.4 Generic functions

Generic Reader: cache-entry-weight (object)
Package

cacle.

Methods
Reader Method: cache-entry-weight ((heap-cache-entry heap-cache-entry))

automatically generated reader method

Source

lfu-policies.lisp.

Target Slot

weight.

Generic Writer: (setf cache-entry-weight) (object)
Package

cacle.

Methods
Writer Method: (setf cache-entry-weight) ((heap-cache-entry heap-cache-entry))

automatically generated writer method

Source

lfu-policies.lisp.

Target Slot

weight.

Generic Function: cache-sanity-check (cache)
Package

cacle.

Methods
Method: cache-sanity-check ((cache cache))
Source

cache.lisp.

Generic Reader: entry-busy (object)
Package

cacle.

Methods
Reader Method: entry-busy ((cache-entry cache-entry))

automatically generated reader method

Source

entry.lisp.

Target Slot

busy.

Generic Writer: (setf entry-busy) (object)
Package

cacle.

Methods
Writer Method: (setf entry-busy) ((cache-entry cache-entry))

automatically generated writer method

Source

entry.lisp.

Target Slot

busy.

Generic Function: set-cache-cleanup (cache new-cleanup)
Package

cacle.

Setf expanders to this generic function

(setf cache-cleanup).

Methods
Method: set-cache-cleanup ((cache cache) new-cleanup)
Source

cache.lisp.

Generic Function: set-cache-lifetime (cache new-lifetime)
Package

cacle.

Setf expanders to this generic function

(setf cache-lifetime).

Methods
Method: set-cache-lifetime ((cache cache) new-lifetime)
Source

cache.lisp.

Generic Function: set-cache-max-size (cache new-max)
Package

cacle.

Setf expanders to this generic function

(setf cache-max-size).

Methods
Method: set-cache-max-size ((cache cache) new-max)
Source

cache.lisp.

Generic Function: set-cache-provider (cache new-provider)
Package

cacle.

Setf expanders to this generic function

(setf cache-provider).

Methods
Method: set-cache-provider ((cache cache) new-provider)
Source

cache.lisp.


6.2.5 Classes

Class: array-replacement-policy
Package

cacle.

Source

simple-policies.lisp.

Direct superclasses

replacement-policy.

Direct subclasses

random-replacement-policy.

Direct methods
Direct slots
Slot: data
Initform

(make-array 16 :adjustable t :fill-pointer 0)

Slot: unused
Initform

(make-array 16 :adjustable t :fill-pointer 0)

Class: heap-cache-entry
Package

cacle.

Source

lfu-policies.lisp.

Direct superclasses

indexed-cache-entry.

Direct methods
Direct slots
Slot: weight
Readers

cache-entry-weight.

Writers

(setf cache-entry-weight).


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
A   B   C   E   F   G   H   I   L   M   P   S   U   W  
Index Entry  Section

(
(setf cache-cleanup): Public setf expanders
(setf cache-entry-weight): Private generic functions
(setf cache-entry-weight): Private generic functions
(setf cache-lifetime): Public setf expanders
(setf cache-max-size): Public setf expanders
(setf cache-provider): Public setf expanders
(setf entry-busy): Private generic functions
(setf entry-busy): Private generic functions
(setf entry-index): Public generic functions
(setf entry-index): Public generic functions

A
access-entry: Public generic functions
access-entry: Public generic functions
access-entry: Public generic functions
access-entry: Public generic functions
access-entry: Public generic functions
access-entry: Public generic functions

B
bubble-up: Private ordinary functions

C
cache-cleanup: Public generic functions
cache-cleanup: Public generic functions
cache-count: Public generic functions
cache-count: Public generic functions
cache-entry-weight: Private generic functions
cache-entry-weight: Private generic functions
cache-fetch: Public generic functions
cache-fetch: Public generic functions
cache-flush: Public generic functions
cache-flush: Public generic functions
cache-lifetime: Public generic functions
cache-lifetime: Public generic functions
cache-max-size: Public generic functions
cache-max-size: Public generic functions
cache-policy: Public generic functions
cache-policy: Public generic functions
cache-provider: Public generic functions
cache-provider: Public generic functions
cache-release: Public generic functions
cache-release: Public generic functions
cache-remove: Public generic functions
cache-remove: Public generic functions
cache-sanity-check: Private generic functions
cache-sanity-check: Private generic functions
cache-size: Public generic functions
cache-size: Public generic functions

E
ensure-cache-size: Private ordinary functions
ensure-unlinked: Private ordinary functions
entry-added: Public generic functions
entry-added: Public generic functions
entry-added: Public generic functions
entry-added: Public generic functions
entry-added: Public generic functions
entry-added: Public generic functions
entry-added: Public generic functions
entry-busy: Private generic functions
entry-busy: Private generic functions
entry-expiry: Public generic functions
entry-expiry: Public generic functions
entry-index: Public generic functions
entry-index: Public generic functions
entry-key: Public generic functions
entry-key: Public generic functions
entry-next: Public generic functions
entry-next: Public generic functions
entry-previous: Public generic functions
entry-previous: Public generic functions
entry-removed: Public generic functions
entry-removed: Public generic functions
entry-removed: Public generic functions
entry-removed: Public generic functions
entry-size: Public generic functions
entry-size: Public generic functions
entry-valid-p: Public generic functions
entry-valid-p: Public generic functions
evict-entry: Public generic functions
evict-entry: Public generic functions
evict-entry: Public generic functions
evict-entry: Public generic functions
evict-entry: Public generic functions
evict-entry: Public generic functions

F
Function, bubble-up: Private ordinary functions
Function, ensure-cache-size: Private ordinary functions
Function, ensure-unlinked: Private ordinary functions
Function, heap-left: Private ordinary functions
Function, heap-left-idx: Private ordinary functions
Function, heap-parent: Private ordinary functions
Function, heap-parent-idx: Private ordinary functions
Function, heap-right: Private ordinary functions
Function, heap-right-idx: Private ordinary functions
Function, heap-swap: Private ordinary functions
Function, make-cache: Public ordinary functions
Function, prepare-cleanup: Private ordinary functions
Function, sink-down: Private ordinary functions

G
Generic Function, (setf cache-entry-weight): Private generic functions
Generic Function, (setf entry-busy): Private generic functions
Generic Function, (setf entry-index): Public generic functions
Generic Function, access-entry: Public generic functions
Generic Function, cache-cleanup: Public generic functions
Generic Function, cache-count: Public generic functions
Generic Function, cache-entry-weight: Private generic functions
Generic Function, cache-fetch: Public generic functions
Generic Function, cache-flush: Public generic functions
Generic Function, cache-lifetime: Public generic functions
Generic Function, cache-max-size: Public generic functions
Generic Function, cache-policy: Public generic functions
Generic Function, cache-provider: Public generic functions
Generic Function, cache-release: Public generic functions
Generic Function, cache-remove: Public generic functions
Generic Function, cache-sanity-check: Private generic functions
Generic Function, cache-size: Public generic functions
Generic Function, entry-added: Public generic functions
Generic Function, entry-busy: Private generic functions
Generic Function, entry-expiry: Public generic functions
Generic Function, entry-index: Public generic functions
Generic Function, entry-key: Public generic functions
Generic Function, entry-next: Public generic functions
Generic Function, entry-previous: Public generic functions
Generic Function, entry-removed: Public generic functions
Generic Function, entry-size: Public generic functions
Generic Function, entry-valid-p: Public generic functions
Generic Function, evict-entry: Public generic functions
Generic Function, link-after: Public generic functions
Generic Function, link-before: Public generic functions
Generic Function, linked-list-head: Public generic functions
Generic Function, set-cache-cleanup: Private generic functions
Generic Function, set-cache-lifetime: Private generic functions
Generic Function, set-cache-max-size: Private generic functions
Generic Function, set-cache-provider: Private generic functions
Generic Function, unlink: Public generic functions

H
heap-left: Private ordinary functions
heap-left-idx: Private ordinary functions
heap-parent: Private ordinary functions
heap-parent-idx: Private ordinary functions
heap-right: Private ordinary functions
heap-right-idx: Private ordinary functions
heap-swap: Private ordinary functions

I
initialize-instance: Public standalone methods

L
link-after: Public generic functions
link-after: Public generic functions
link-before: Public generic functions
link-before: Public generic functions
linked-list-head: Public generic functions
linked-list-head: Public generic functions

M
Macro, with-cache-fetch: Public macros
Macro, with-collected-cleanups: Private macros
make-cache: Public ordinary functions
Method, (setf cache-entry-weight): Private generic functions
Method, (setf entry-busy): Private generic functions
Method, (setf entry-index): Public generic functions
Method, access-entry: Public generic functions
Method, access-entry: Public generic functions
Method, access-entry: Public generic functions
Method, access-entry: Public generic functions
Method, access-entry: Public generic functions
Method, cache-cleanup: Public generic functions
Method, cache-count: Public generic functions
Method, cache-entry-weight: Private generic functions
Method, cache-fetch: Public generic functions
Method, cache-flush: Public generic functions
Method, cache-lifetime: Public generic functions
Method, cache-max-size: Public generic functions
Method, cache-policy: Public generic functions
Method, cache-provider: Public generic functions
Method, cache-release: Public generic functions
Method, cache-remove: Public generic functions
Method, cache-sanity-check: Private generic functions
Method, cache-size: Public generic functions
Method, entry-added: Public generic functions
Method, entry-added: Public generic functions
Method, entry-added: Public generic functions
Method, entry-added: Public generic functions
Method, entry-added: Public generic functions
Method, entry-added: Public generic functions
Method, entry-busy: Private generic functions
Method, entry-expiry: Public generic functions
Method, entry-index: Public generic functions
Method, entry-key: Public generic functions
Method, entry-next: Public generic functions
Method, entry-previous: Public generic functions
Method, entry-removed: Public generic functions
Method, entry-removed: Public generic functions
Method, entry-removed: Public generic functions
Method, entry-size: Public generic functions
Method, entry-valid-p: Public generic functions
Method, evict-entry: Public generic functions
Method, evict-entry: Public generic functions
Method, evict-entry: Public generic functions
Method, evict-entry: Public generic functions
Method, evict-entry: Public generic functions
Method, initialize-instance: Public standalone methods
Method, link-after: Public generic functions
Method, link-before: Public generic functions
Method, linked-list-head: Public generic functions
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, set-cache-cleanup: Private generic functions
Method, set-cache-lifetime: Private generic functions
Method, set-cache-max-size: Private generic functions
Method, set-cache-provider: Private generic functions
Method, shared-initialize: Public standalone methods
Method, unlink: Public generic functions

P
prepare-cleanup: Private ordinary functions
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods

S
set-cache-cleanup: Private generic functions
set-cache-cleanup: Private generic functions
set-cache-lifetime: Private generic functions
set-cache-lifetime: Private generic functions
set-cache-max-size: Private generic functions
set-cache-max-size: Private generic functions
set-cache-provider: Private generic functions
set-cache-provider: Private generic functions
Setf Expander, (setf cache-cleanup): Public setf expanders
Setf Expander, (setf cache-lifetime): Public setf expanders
Setf Expander, (setf cache-max-size): Public setf expanders
Setf Expander, (setf cache-provider): Public setf expanders
shared-initialize: Public standalone methods
sink-down: Private ordinary functions

U
unlink: Public generic functions
unlink: Public generic functions

W
with-cache-fetch: Public macros
with-collected-cleanups: Private macros


A.3 Variables

Jump to:   *  
A   B   C   D   E   H   I   K   L   M   N   P   S   U   W  
Index Entry  Section

*
*cleanup-list*: Private special variables

A
age: Public classes

B
busy: Public classes

C
cleanup: Public classes

D
data: Public classes
data: Private classes

E
expiry: Public classes

H
hash: Public classes
head: Public classes
heap: Public classes

I
index: Public classes

K
key: Public classes

L
lifetime: Public classes
lock: Public classes

M
max-size: Public classes

N
next: Public classes

P
pending: Public classes
policy: Public classes
prev: Public classes
provider: Public classes

S
size: Public classes
size: Public classes
Slot, age: Public classes
Slot, busy: Public classes
Slot, cleanup: Public classes
Slot, data: Public classes
Slot, data: Private classes
Slot, expiry: Public classes
Slot, hash: Public classes
Slot, head: Public classes
Slot, heap: Public classes
Slot, index: Public classes
Slot, key: Public classes
Slot, lifetime: Public classes
Slot, lock: Public classes
Slot, max-size: Public classes
Slot, next: Public classes
Slot, pending: Public classes
Slot, policy: Public classes
Slot, prev: Public classes
Slot, provider: Public classes
Slot, size: Public classes
Slot, size: Public classes
Slot, unused: Private classes
Slot, weight: Private classes
Special Variable, *cleanup-list*: Private special variables

U
unused: Private classes

W
weight: Private classes


A.4 Data types

Jump to:   A   C   E   F   H   I   L   M   P   R   S   T  
Index Entry  Section

A
array-replacement-policy: Private classes

C
cache: Public classes
cache-entry: Public classes
cache.lisp: The cacle/cacle/cache․lisp file
cacle: The cacle system
cacle: The cacle/cacle module
cacle: The cacle package
cacle-system: The cacle-system package
cacle.asd: The cacle/cacle․asd file
Class, array-replacement-policy: Private classes
Class, cache: Public classes
Class, cache-entry: Public classes
Class, fifo-replacement-policy: Public classes
Class, heap-cache-entry: Private classes
Class, indexed-cache-entry: Public classes
Class, lfu-replacement-policy: Public classes
Class, lfuda-replacement-policy: Public classes
Class, lifo-replacement-policy: Public classes
Class, linked-cache-entry: Public classes
Class, linked-list-replacement-policy: Public classes
Class, lru-replacement-policy: Public classes
Class, mru-replacement-policy: Public classes
Class, random-replacement-policy: Public classes
Class, replacement-policy: Public classes

E
entry.lisp: The cacle/cacle/entry․lisp file

F
fifo-replacement-policy: Public classes
File, cache.lisp: The cacle/cacle/cache․lisp file
File, cacle.asd: The cacle/cacle․asd file
File, entry.lisp: The cacle/cacle/entry․lisp file
File, lfu-policies.lisp: The cacle/cacle/lfu-policies․lisp file
File, package.lisp: The cacle/cacle/package․lisp file
File, policy.lisp: The cacle/cacle/policy․lisp file
File, simple-policies.lisp: The cacle/cacle/simple-policies․lisp file
File, testsuite.lisp: The cacle/cacle/testsuite․lisp file

H
heap-cache-entry: Private classes

I
indexed-cache-entry: Public classes

L
lfu-policies.lisp: The cacle/cacle/lfu-policies․lisp file
lfu-replacement-policy: Public classes
lfuda-replacement-policy: Public classes
lifo-replacement-policy: Public classes
linked-cache-entry: Public classes
linked-list-replacement-policy: Public classes
lru-replacement-policy: Public classes

M
Module, cacle: The cacle/cacle module
mru-replacement-policy: Public classes

P
Package, cacle: The cacle package
Package, cacle-system: The cacle-system package
package.lisp: The cacle/cacle/package․lisp file
policy.lisp: The cacle/cacle/policy․lisp file

R
random-replacement-policy: Public classes
replacement-policy: Public classes

S
simple-policies.lisp: The cacle/cacle/simple-policies․lisp file
System, cacle: The cacle system

T
testsuite.lisp: The cacle/cacle/testsuite․lisp file