forked from clojure/core.cache
/
api-index.html
246 lines (221 loc) · 10.7 KB
/
api-index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
<html>
<head>
<title>Index - A caching library implementing various cache strategies 0.6.0 API documentation</title>
<link href="static/favicon.png" rel="icon" />
<link href="static/favicon.png" rel="shortcut icon" />
<link media="all" type="text/css" href="static/clojure.css" rel="stylesheet" />
<link media="all" type="text/css" href="static/wiki.css" rel="stylesheet" />
<link media="all" type="text/css" href="static/internal.css" rel="stylesheet" />
<style>.menuWrapper{height: 36px;}</style>
<!--[if lte IE 6]>
<link rel="stylesheet" href="http://www.wikispaces.com/_/2009051601/s/internal_ie.css" type="text/css" />
<![endif]-->
</head>
<!--
This document was auto-generated from the source by the clojure autodoc system.
To report errors or ask questions about the overall documentation structure, formatting,
etc., contact Tom Faulhaber (google mail name: tomfaulhaber).
For errors in the documentation of a particular namespace, contact the author of that
namespace.
-->
<body>
<div id="AllContentContainer">
<div id="Header">
<a id="Logo" href="index.html"><img alt="Clojure" height="100" width="100" src="static/clojure-icon.gif" /></a>
<h1><a title="page header title" id="page-header" href="index.html">core.cache API Reference</a></h1>
</div>
<div id="leftcolumn"><div style="text-align: center;"></div>
<div class="menu">
<div class="WikiCustomNav WikiElement wiki">
<span class="toc-header"><span id="project-name">A caching library implementing various cache strategies</span> <span id="version">0.6.0</span> API</span><br />
<ul>
<li><a class="wiki_link" href="index.html">Overview</a></li>
<li><a class="wiki_link" href="api-index.html">API Index</a></li>
</ul>
<a href="http://clojure.org" class="wiki_link">Clojure Home</a>
</div>
</div>
</div>
<div id="rightcolumn">
<div id="Content">
<div class="contentBox"><div class="innerContentBox">
<div id="content_view" class="wiki wikiPage">
<div id="right-sidebar"></div>
<div id="content-tag"><h1 id="overview">Index of Public Functions and Variables - <span id="header-project">A caching library implementing various cache strategies</span> <span id="header-version">0.6.0</span><span id="header-status-block"> (<span id="header-status">in development</span>)</span></h1>
This page has an alphabetical index of all the documented functions and variables
in <span class="project-name-span">A caching library implementing various cache strategies</span>.
<!-- TODO: enable this functionality on github?
In a narrow browser window, you may want to collapse the sidebar (use the \"<<\" link)
to get more screen space for the index.
-->
<div class="shortcuts">
Shortcuts:<br />
<a href="#A">A</a> <a href="#B">B</a> <a href="#C">C</a> <a href="#D">D</a>
<a href="#E">E</a> <a href="#F">F</a> <a href="#G">G</a> <a href="#H">H</a>
<a href="#I">I</a> <a href="#J">J</a> <a href="#K">K</a> <a href="#L">L</a>
<a href="#M">M</a>
<br />
<a href="#N">N</a> <a href="#O">O</a> <a href="#P">P</a> <a href="#Q">Q</a>
<a href="#R">R</a> <a href="#S">S</a> <a href="#T">T</a> <a href="#U">U</a>
<a href="#V">V</a> <a href="#W">W</a> <a href="#X">X</a> <a href="#Y">Y</a>
<a href="#Z">Z</a>
<br />
<a href="#Other">Other</a>
<br />
</div>
<div id="index-body">
<h2 id="A"><span id="section-head">A</span></h2>
<pre>
</pre>
</div><div id="index-body">
<h2 id="B"><span id="section-head">B</span></h2>
<pre>
<span id="section-content"> <a href="index.html#clojure.core.cache/basic-cache-factory">basic-cache-factory</a><span id="line-content"> function clojure.core.cache Returns a pluggable basic cache initialied to `bas...
</span></span><span id="section-content"> <a href="index.html#clojure.core.cache/BasicCache">BasicCache</a><span id="line-content"> type clojure.core.cache
</span></span>
</pre>
</div><div id="index-body">
<h2 id="C"><span id="section-head">C</span></h2>
<pre>
<span id="section-content"> <a href="index.html#clojure.core.cache/CacheProtocol">CacheProtocol</a><span id="line-content"> protocol clojure.core.cache This is the protocol describing the basic cache ca...
</span></span>
</pre>
</div><div id="index-body">
<h2 id="D"><span id="section-head">D</span></h2>
<pre>
</pre>
</div><div id="index-body">
<h2 id="E"><span id="section-head">E</span></h2>
<pre>
<span id="section-content"> <a href="index.html#clojure.core.cache/evict">evict</a><span id="line-content"> function clojure.core.cache Removes an entry from the cache.
</span></span>
</pre>
</div><div id="index-body">
<h2 id="F"><span id="section-head">F</span></h2>
<pre>
<span id="section-content"> <a href="index.html#clojure.core.cache/fifo-cache-factory">fifo-cache-factory</a><span id="line-content"> function clojure.core.cache Returns a FIFO cache with the cache and FIFO queue...
</span></span><span id="section-content"> <a href="index.html#clojure.core.cache/FIFOCache">FIFOCache</a><span id="line-content"> type clojure.core.cache
</span></span><span id="section-content"> <a href="index.html#clojure.core.cache/FnCache">FnCache</a><span id="line-content"> type clojure.core.cache
</span></span>
</pre>
</div><div id="index-body">
<h2 id="G"><span id="section-head">G</span></h2>
<pre>
</pre>
</div><div id="index-body">
<h2 id="H"><span id="section-head">H</span></h2>
<pre>
<span id="section-content"> <a href="index.html#clojure.core.cache/has?">has?</a><span id="line-content"> function clojure.core.cache Checks if the cache contains a value associtaed wi...
</span></span><span id="section-content"> <a href="index.html#clojure.core.cache/hit">hit</a><span id="line-content"> function clojure.core.cache Is meant to be called if the cache is determined t...
</span></span>
</pre>
</div><div id="index-body">
<h2 id="I"><span id="section-head">I</span></h2>
<pre>
</pre>
</div><div id="index-body">
<h2 id="J"><span id="section-head">J</span></h2>
<pre>
</pre>
</div><div id="index-body">
<h2 id="K"><span id="section-head">K</span></h2>
<pre>
</pre>
</div><div id="index-body">
<h2 id="L"><span id="section-head">L</span></h2>
<pre>
<span id="section-content"> <a href="index.html#clojure.core.cache/lirs-cache-factory">lirs-cache-factory</a><span id="line-content"> function clojure.core.cache Returns an LIRS cache with the S & R LRU lists set...
</span></span><span id="section-content"> <a href="index.html#clojure.core.cache/LIRSCache">LIRSCache</a><span id="line-content"> type clojure.core.cache
</span></span><span id="section-content"> <a href="index.html#clojure.core.cache/lookup">lookup</a><span id="line-content"> function clojure.core.cache Retrieve the value associated with `e` if it exist...
</span></span><span id="section-content"> <a href="index.html#clojure.core.cache/lru-cache-factory">lru-cache-factory</a><span id="line-content"> function clojure.core.cache Returns an LRU cache with the cache and usage-tabl...
</span></span><span id="section-content"> <a href="index.html#clojure.core.cache/LRUCache">LRUCache</a><span id="line-content"> type clojure.core.cache
</span></span><span id="section-content"> <a href="index.html#clojure.core.cache/lu-cache-factory">lu-cache-factory</a><span id="line-content"> function clojure.core.cache Returns an LU cache with the cache and usage-table...
</span></span><span id="section-content"> <a href="index.html#clojure.core.cache/LUCache">LUCache</a><span id="line-content"> type clojure.core.cache
</span></span>
</pre>
</div><div id="index-body">
<h2 id="M"><span id="section-head">M</span></h2>
<pre>
<span id="section-content"> <a href="index.html#clojure.core.cache/miss">miss</a><span id="line-content"> function clojure.core.cache Is meant to be called if the cache is determined t...
</span></span>
</pre>
</div><div id="index-body">
<h2 id="N"><span id="section-head">N</span></h2>
<pre>
</pre>
</div><div id="index-body">
<h2 id="O"><span id="section-head">O</span></h2>
<pre>
</pre>
</div><div id="index-body">
<h2 id="P"><span id="section-head">P</span></h2>
<pre>
</pre>
</div><div id="index-body">
<h2 id="Q"><span id="section-head">Q</span></h2>
<pre>
</pre>
</div><div id="index-body">
<h2 id="R"><span id="section-head">R</span></h2>
<pre>
</pre>
</div><div id="index-body">
<h2 id="S"><span id="section-head">S</span></h2>
<pre>
<span id="section-content"> <a href="index.html#clojure.core.cache/seed">seed</a><span id="line-content"> function clojure.core.cache Is used to signal that the cache should be created...
</span></span>
</pre>
</div><div id="index-body">
<h2 id="T"><span id="section-head">T</span></h2>
<pre>
<span id="section-content"> <a href="index.html#clojure.core.cache/ttl-cache-factory">ttl-cache-factory</a><span id="line-content"> function clojure.core.cache Returns a TTL cache with the cache and expiration-...
</span></span><span id="section-content"> <a href="index.html#clojure.core.cache/TTLCache">TTLCache</a><span id="line-content"> type clojure.core.cache
</span></span>
</pre>
</div><div id="index-body">
<h2 id="U"><span id="section-head">U</span></h2>
<pre>
</pre>
</div><div id="index-body">
<h2 id="V"><span id="section-head">V</span></h2>
<pre>
</pre>
</div><div id="index-body">
<h2 id="W"><span id="section-head">W</span></h2>
<pre>
</pre>
</div><div id="index-body">
<h2 id="X"><span id="section-head">X</span></h2>
<pre>
</pre>
</div><div id="index-body">
<h2 id="Y"><span id="section-head">Y</span></h2>
<pre>
</pre>
</div><div id="index-body">
<h2 id="Z"><span id="section-head">Z</span></h2>
<pre>
</pre>
</div><div id="index-body">
<h2 id="Other"><span id="section-head">Other</span></h2>
<pre>
</pre>
</div>
<style type="text/css">
#AllContentContainer {min-width: 96em;}
</style>
</div>
</div>
</div>
</div>
</div>
<div id="foot">
<div style="text-align: center;" id="copyright">Copyright 2007-2012 by Rich Hickey and the various contributors</div>
</div>
</div>
<div id="DesignedBy">Logo & site design by <a title="Visit Tom Hickey's website." href="http://www.tomhickey.com">Tom Hickey</a>.<br />
Clojure auto-documentation system by Tom Faulhaber.</div>
</div>
<!-- /AllContentContainer -->
</body>
</html>