-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathNIInMemoryCache_8h_source.html
155 lines (155 loc) · 17.3 KB
/
NIInMemoryCache_8h_source.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
<!-- HTML header for doxygen 1.8.6-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6-nimbuskit"/>
<title>NimbusKit: src/core/src/NIInMemoryCache.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="appledocs.css" rel="stylesheet" type="text/css"/>
<link href="nimbuskit.css" rel="stylesheet" type="text/css" />
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-24278774-1']);
_gaq.push(['_setDomainName', 'nimbuskit.info']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<a href="index.html"><img style="float:left" src="nimbus128.png" width="80" height="80" /></a>
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">NimbusKit
 <span id="projectnumber">1.2.1 - <a href="http://github.com/jverkoey/nimbus">Fork Nimbus on Github</a> - <a href="http://wiki.nimbuskit.info/">Visit the Nimbus Wiki</a></span>
</div>
<div id="projectbrief">The iOS framework that grows only as fast as its documentation</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6-nimbuskit -->
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('NIInMemoryCache_8h_source.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">NIInMemoryCache.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">//</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// Copyright 2011-2014 NimbusKit</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">//</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// Licensed under the Apache License, Version 2.0 (the "License");</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// you may not use this file except in compliance with the License.</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">// You may obtain a copy of the License at</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">//</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">//</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">// Unless required by applicable law or agreed to in writing, software</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// distributed under the License is distributed on an "AS IS" BASIS,</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// See the License for the specific language governing permissions and</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// limitations under the License.</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">//</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#import <Foundation/Foundation.h></span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#import "NIPreprocessorMacros.h"</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div>
<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="NIMemoryCache.html"> 38</a></span> <span class="keyword">@interface </span><a class="code" href="NIMemoryCache.html">NIMemoryCache</a> : NSObject</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment">// Designated initializer.</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> - (id)initWithCapacity:(NSUInteger)capacity;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> - (NSUInteger)<a class="code" href="NIMemoryCache.html#count">count</a>;</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> - (void)storeObject:(<span class="keywordtype">id</span>)object withName:(NSString *)name;</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> - (void)storeObject:(<span class="keywordtype">id</span>)object withName:(NSString *)name expiresAfter:(NSDate *)expirationDate;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> - (void)removeObjectWithName:(NSString *)name;</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> - (void)removeAllObjectsWithPrefix:(NSString *)prefix;</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> - (void)<a class="code" href="NIMemoryCache.html#removeAllObjects">removeAllObjects</a>;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> - (id)objectWithName:(NSString *)name;</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> - (BOOL)containsObjectWithName:(NSString *)name;</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> - (NSDate *)dateOfLastAccessWithName:(NSString *)name;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> - (NSString *)<a class="code" href="NIMemoryCache.html#nameOfLeastRecentlyUsedObject">nameOfLeastRecentlyUsedObject</a>;</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> - (NSString *)<a class="code" href="NIMemoryCache.html#nameOfMostRecentlyUsedObject">nameOfMostRecentlyUsedObject</a>;</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> - (void)<a class="code" href="NIMemoryCache.html#reduceMemoryUsage">reduceMemoryUsage</a>;</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment">// Subclassing</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> - (BOOL)shouldSetObject:(<span class="keywordtype">id</span>)object withName:(NSString *)name previousObject:(<span class="keywordtype">id</span>)previousObject;</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> - (void)didSetObject:(<span class="keywordtype">id</span>)object withName:(NSString *)name;</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> - (void)willRemoveObject:(<span class="keywordtype">id</span>)object withName:(NSString *)name;</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment">// Deprecated method. Use shouldSetObject:withName:previousObject: instead.</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> - (BOOL)willSetObject:(<span class="keywordtype">id</span>)object withName:(NSString *)name previousObject:(<span class="keywordtype">id</span>)previousObject __NI_DEPRECATED_METHOD;</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="keyword">@end</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div>
<div class="line"><a name="l00091"></a><span class="lineno"><a class="line" href="NIImageMemoryCache.html"> 91</a></span> <span class="keyword">@interface </span><a class="code" href="NIImageMemoryCache.html">NIImageMemoryCache</a> : <a class="code" href="NIMemoryCache.html">NIMemoryCache</a></div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div>
<div class="line"><a name="l00093"></a><span class="lineno"><a class="line" href="NIImageMemoryCache.html#numberOfPixels"> 93</a></span> <span class="keyword">@property</span> (nonatomic, readonly) <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> <a class="code" href="NIImageMemoryCache.html#numberOfPixels">numberOfPixels</a>;</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div>
<div class="line"><a name="l00095"></a><span class="lineno"><a class="line" href="NIImageMemoryCache.html#maxNumberOfPixels"> 95</a></span> <span class="keyword">@property</span> (nonatomic) <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> <a class="code" href="NIImageMemoryCache.html#maxNumberOfPixels">maxNumberOfPixels</a>; <span class="comment">// Default: 0 (unlimited)</span></div>
<div class="line"><a name="l00096"></a><span class="lineno"><a class="line" href="NIImageMemoryCache.html#maxNumberOfPixelsUnderStress"> 96</a></span> <span class="keyword">@property</span> (nonatomic) <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> <a class="code" href="NIImageMemoryCache.html#maxNumberOfPixelsUnderStress">maxNumberOfPixelsUnderStress</a>; <span class="comment">// Default: 0 (unlimited)</span></div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="keyword">@end</span></div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment">// End of In-Memory Cache //////////////////////////////////////////////////////////////////</span></div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> </div>
<div class="line"><a name="l00286"></a><span class="lineno"> 286</span> <span class="comment">// NIImageMemoryCache</span></div>
<div class="line"><a name="l00287"></a><span class="lineno"> 287</span> </div>
<div class="ttc" id="NIMemoryCache_html_removeAllObjects"><div class="ttname"><a href="NIMemoryCache.html#removeAllObjects">-[NIMemoryCache removeAllObjects]</a></div><div class="ttdeci">void removeAllObjects()</div><div class="ttdoc">Removes all objects from the cache, regardless of expiration dates. </div><div class="ttdef"><b>Definition:</b> <a href="NIInMemoryCache_8m_source.html#l00322">NIInMemoryCache.m:322</a></div></div>
<div class="ttc" id="NIMemoryCache_html"><div class="ttname"><a href="NIMemoryCache.html">NIMemoryCache</a></div><div class="ttdoc">An in-memory cache for storing objects with expiration support. </div><div class="ttdef"><b>Definition:</b> <a href="NIInMemoryCache_8h_source.html#l00038">NIInMemoryCache.h:38</a></div></div>
<div class="ttc" id="NIMemoryCache_html_reduceMemoryUsage"><div class="ttname"><a href="NIMemoryCache.html#reduceMemoryUsage">-[NIMemoryCache reduceMemoryUsage]</a></div><div class="ttdeci">void reduceMemoryUsage()</div><div class="ttdoc">Removes all expired objects from the cache. </div><div class="ttdef"><b>Definition:</b> <a href="NIInMemoryCache_8m_source.html#l00329">NIInMemoryCache.m:329</a></div></div>
<div class="ttc" id="NIImageMemoryCache_html"><div class="ttname"><a href="NIImageMemoryCache.html">NIImageMemoryCache</a></div><div class="ttdoc">An in-memory cache for storing images with caps on the total number of pixels. </div><div class="ttdef"><b>Definition:</b> <a href="NIInMemoryCache_8h_source.html#l00091">NIInMemoryCache.h:91</a></div></div>
<div class="ttc" id="NIImageMemoryCache_html_numberOfPixels"><div class="ttname"><a href="NIImageMemoryCache.html#numberOfPixels">NIImageMemoryCache::numberOfPixels</a></div><div class="ttdeci">unsigned long long numberOfPixels</div><div class="ttdoc">Returns the total number of pixels being stored in the cache. </div><div class="ttdef"><b>Definition:</b> <a href="NIInMemoryCache_8h_source.html#l00093">NIInMemoryCache.h:93</a></div></div>
<div class="ttc" id="NIMemoryCache_html_nameOfMostRecentlyUsedObject"><div class="ttname"><a href="NIMemoryCache.html#nameOfMostRecentlyUsedObject">-[NIMemoryCache nameOfMostRecentlyUsedObject]</a></div><div class="ttdeci">NSString * nameOfMostRecentlyUsedObject()</div><div class="ttdoc">Retrieve the key with the most fresh access. </div><div class="ttdef"><b>Definition:</b> <a href="NIInMemoryCache_8m_source.html#l00292">NIInMemoryCache.m:292</a></div></div>
<div class="ttc" id="NIImageMemoryCache_html_maxNumberOfPixelsUnderStress"><div class="ttname"><a href="NIImageMemoryCache.html#maxNumberOfPixelsUnderStress">NIImageMemoryCache::maxNumberOfPixelsUnderStress</a></div><div class="ttdeci">unsigned long long maxNumberOfPixelsUnderStress</div><div class="ttdoc">The maximum number of pixels this cache may store after a call to reduceMemoryUsage. </div><div class="ttdef"><b>Definition:</b> <a href="NIInMemoryCache_8h_source.html#l00096">NIInMemoryCache.h:96</a></div></div>
<div class="ttc" id="NIMemoryCache_html_count"><div class="ttname"><a href="NIMemoryCache.html#count">-[NIMemoryCache count]</a></div><div class="ttdeci">NSUInteger count()</div><div class="ttdoc">Returns the number of objects currently in the cache. </div><div class="ttdef"><b>Definition:</b> <a href="NIInMemoryCache_8m_source.html#l00342">NIInMemoryCache.m:342</a></div></div>
<div class="ttc" id="NIImageMemoryCache_html_maxNumberOfPixels"><div class="ttname"><a href="NIImageMemoryCache.html#maxNumberOfPixels">NIImageMemoryCache::maxNumberOfPixels</a></div><div class="ttdeci">unsigned long long maxNumberOfPixels</div><div class="ttdoc">The maximum number of pixels this cache may ever store. </div><div class="ttdef"><b>Definition:</b> <a href="NIInMemoryCache_8h_source.html#l00095">NIInMemoryCache.h:95</a></div></div>
<div class="ttc" id="NIMemoryCache_html_nameOfLeastRecentlyUsedObject"><div class="ttname"><a href="NIMemoryCache.html#nameOfLeastRecentlyUsedObject">-[NIMemoryCache nameOfLeastRecentlyUsedObject]</a></div><div class="ttdeci">NSString * nameOfLeastRecentlyUsedObject()</div><div class="ttdoc">Retrieve the name of the object that was least recently used. </div><div class="ttdef"><b>Definition:</b> <a href="NIInMemoryCache_8m_source.html#l00279">NIInMemoryCache.m:279</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.6-->
<!-- start footer part -->
<script type="text/javascript" src="widget.js"></script>
</body>
</html>