forked from jverkoey/nimbus
/
_a_s_i_cache_delegate_8h_source.html
199 lines (181 loc) · 12.8 KB
/
_a_s_i_cache_delegate_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
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
<!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"/>
<title>Nimbus: /Users/featherless/workbench/ios/nimbus/src/ASIHTTPRequest/src/ASICacheDelegate.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="stylesheet.css" rel="stylesheet" type="text/css" />
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-24278774-1']);
_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="page">
<div style="position:relative">
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<a style="float: right;margin-right:20px;margin-top:20px" href='http://www.pledgie.com/campaigns/15519'><img alt='Click here to support Nimbus development and make a donation at www.pledgie.com !' src='http://www.pledgie.com/campaigns/15519.png?skin_name=chrome' border='0' /></a>
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Nimbus
 <span id="projectnumber">0.6.0 - <a href="http://github.com/jverkoey/nimbus">Nimbus is proudly hosted on Github</a></span>
</div>
<div id="projectbrief">An iOS framework whose growth is bounded by O(documentation).</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.4-20110629 -->
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('_a_s_i_cache_delegate_8h.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">/Users/featherless/workbench/ios/nimbus/src/ASIHTTPRequest/src/ASICacheDelegate.h</div> </div>
</div>
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">//</span>
<a name="l00002"></a>00002 <span class="comment">// ASICacheDelegate.h</span>
<a name="l00003"></a>00003 <span class="comment">// Part of ASIHTTPRequest -> http://allseeing-i.com/ASIHTTPRequest</span>
<a name="l00004"></a>00004 <span class="comment">//</span>
<a name="l00005"></a>00005 <span class="comment">// Created by Ben Copsey on 01/05/2010.</span>
<a name="l00006"></a>00006 <span class="comment">// Copyright 2010 All-Seeing Interactive. All rights reserved.</span>
<a name="l00007"></a>00007 <span class="comment">//</span>
<a name="l00008"></a>00008
<a name="l00009"></a>00009 <span class="preprocessor">#import <Foundation/Foundation.h></span>
<a name="l00010"></a>00010 <span class="keyword">@class</span> ASIHTTPRequest;
<a name="l00011"></a>00011
<a name="l00012"></a>00012 <span class="comment">// Cache policies control the behaviour of a cache and how requests use the cache</span>
<a name="l00013"></a>00013 <span class="comment">// When setting a cache policy, you can use a combination of these values as a bitmask</span>
<a name="l00014"></a>00014 <span class="comment">// For example: [request setCachePolicy:ASIAskServerIfModifiedCachePolicy|ASIFallbackToCacheIfLoadFailsCachePolicy|ASIDoNotWriteToCacheCachePolicy];</span>
<a name="l00015"></a>00015 <span class="comment">// Note that some of the behaviours below are mutally exclusive - you cannot combine ASIAskServerIfModifiedWhenStaleCachePolicy and ASIAskServerIfModifiedCachePolicy, for example.</span>
<a name="l00016"></a>00016 <span class="keyword">typedef</span> <span class="keyword">enum</span> _ASICachePolicy {
<a name="l00017"></a>00017
<a name="l00018"></a>00018 <span class="comment">// The default cache policy. When you set a request to use this, it will use the cache's defaultCachePolicy</span>
<a name="l00019"></a>00019 <span class="comment">// ASIDownloadCache's default cache policy is 'ASIAskServerIfModifiedWhenStaleCachePolicy'</span>
<a name="l00020"></a>00020 ASIUseDefaultCachePolicy = 0,
<a name="l00021"></a>00021
<a name="l00022"></a>00022 <span class="comment">// Tell the request not to read from the cache</span>
<a name="l00023"></a>00023 ASIDoNotReadFromCacheCachePolicy = 1,
<a name="l00024"></a>00024
<a name="l00025"></a>00025 <span class="comment">// The the request not to write to the cache</span>
<a name="l00026"></a>00026 ASIDoNotWriteToCacheCachePolicy = 2,
<a name="l00027"></a>00027
<a name="l00028"></a>00028 <span class="comment">// Ask the server if there is an updated version of this resource (using a conditional GET) ONLY when the cached data is stale</span>
<a name="l00029"></a>00029 ASIAskServerIfModifiedWhenStaleCachePolicy = 4,
<a name="l00030"></a>00030
<a name="l00031"></a>00031 <span class="comment">// Always ask the server if there is an updated version of this resource (using a conditional GET)</span>
<a name="l00032"></a>00032 ASIAskServerIfModifiedCachePolicy = 8,
<a name="l00033"></a>00033
<a name="l00034"></a>00034 <span class="comment">// If cached data exists, use it even if it is stale. This means requests will not talk to the server unless the resource they are requesting is not in the cache</span>
<a name="l00035"></a>00035 ASIOnlyLoadIfNotCachedCachePolicy = 16,
<a name="l00036"></a>00036
<a name="l00037"></a>00037 <span class="comment">// If cached data exists, use it even if it is stale. If cached data does not exist, stop (will not set an error on the request)</span>
<a name="l00038"></a>00038 ASIDontLoadCachePolicy = 32,
<a name="l00039"></a>00039
<a name="l00040"></a>00040 <span class="comment">// Specifies that cached data may be used if the request fails. If cached data is used, the request will succeed without error. Usually used in combination with other options above.</span>
<a name="l00041"></a>00041 ASIFallbackToCacheIfLoadFailsCachePolicy = 64
<a name="l00042"></a>00042 } ASICachePolicy;
<a name="l00043"></a>00043
<a name="l00044"></a>00044 <span class="comment">// Cache storage policies control whether cached data persists between application launches (ASICachePermanentlyCacheStoragePolicy) or not (ASICacheForSessionDurationCacheStoragePolicy)</span>
<a name="l00045"></a>00045 <span class="comment">// Calling [ASIHTTPRequest clearSession] will remove any data stored using ASICacheForSessionDurationCacheStoragePolicy</span>
<a name="l00046"></a>00046 <span class="keyword">typedef</span> <span class="keyword">enum</span> _ASICacheStoragePolicy {
<a name="l00047"></a>00047 ASICacheForSessionDurationCacheStoragePolicy = 0,
<a name="l00048"></a>00048 ASICachePermanentlyCacheStoragePolicy = 1
<a name="l00049"></a>00049 } ASICacheStoragePolicy;
<a name="l00050"></a>00050
<a name="l00051"></a>00051
<a name="l00052"></a>00052 <span class="keyword">@protocol </span>ASICacheDelegate <NSObject>
<a name="l00053"></a>00053
<a name="l00054"></a>00054 <span class="keyword">@required</span>
<a name="l00055"></a>00055
<a name="l00056"></a>00056 <span class="comment">// Should return the cache policy that will be used when requests have their cache policy set to ASIUseDefaultCachePolicy</span>
<a name="l00057"></a>00057 - (ASICachePolicy)defaultCachePolicy;
<a name="l00058"></a>00058
<a name="l00059"></a>00059 <span class="comment">// Returns the date a cached response should expire on. Pass a non-zero max age to specify a custom date.</span>
<a name="l00060"></a>00060 - (NSDate *)expiryDateForRequest:(ASIHTTPRequest *)request maxAge:(NSTimeInterval)maxAge;
<a name="l00061"></a>00061
<a name="l00062"></a>00062 <span class="comment">// Updates cached response headers with a new expiry date. Pass a non-zero max age to specify a custom date.</span>
<a name="l00063"></a>00063 - (void)updateExpiryForRequest:(ASIHTTPRequest *)request maxAge:(NSTimeInterval)maxAge;
<a name="l00064"></a>00064
<a name="l00065"></a>00065 <span class="comment">// Looks at the request's cache policy and any cached headers to determine if the cache data is still valid</span>
<a name="l00066"></a>00066 - (BOOL)canUseCachedDataForRequest:(ASIHTTPRequest *)request;
<a name="l00067"></a>00067
<a name="l00068"></a>00068 <span class="comment">// Removes cached data for a particular request</span>
<a name="l00069"></a>00069 - (void)removeCachedDataForRequest:(ASIHTTPRequest *)request;
<a name="l00070"></a>00070
<a name="l00071"></a>00071 <span class="comment">// Should return YES if the cache considers its cached response current for the request</span>
<a name="l00072"></a>00072 <span class="comment">// Should return NO is the data is not cached, or (for example) if the cached headers state the request should have expired</span>
<a name="l00073"></a>00073 - (BOOL)isCachedDataCurrentForRequest:(ASIHTTPRequest *)request;
<a name="l00074"></a>00074
<a name="l00075"></a>00075 <span class="comment">// Should store the response for the passed request in the cache</span>
<a name="l00076"></a>00076 <span class="comment">// When a non-zero maxAge is passed, it should be used as the expiry time for the cached response</span>
<a name="l00077"></a>00077 - (void)storeResponseForRequest:(ASIHTTPRequest *)request maxAge:(NSTimeInterval)maxAge;
<a name="l00078"></a>00078
<a name="l00079"></a>00079 <span class="comment">// Removes cached data for a particular url</span>
<a name="l00080"></a>00080 - (void)removeCachedDataForURL:(NSURL *)url;
<a name="l00081"></a>00081
<a name="l00082"></a>00082 <span class="comment">// Should return an NSDictionary of cached headers for the passed URL, if it is stored in the cache</span>
<a name="l00083"></a>00083 - (NSDictionary *)cachedResponseHeadersForURL:(NSURL *)url;
<a name="l00084"></a>00084
<a name="l00085"></a>00085 <span class="comment">// Should return the cached body of a response for the passed URL, if it is stored in the cache</span>
<a name="l00086"></a>00086 - (<a class="code" href="class_n_s_data.html" title="For hashing raw data.">NSData</a> *)cachedResponseDataForURL:(NSURL *)url;
<a name="l00087"></a>00087
<a name="l00088"></a>00088 <span class="comment">// Returns a path to the cached response data, if it exists</span>
<a name="l00089"></a>00089 - (<a class="code" href="class_n_s_string.html" title="For manipulating NSStrings.">NSString</a> *)pathToCachedResponseDataForURL:(NSURL *)url;
<a name="l00090"></a>00090
<a name="l00091"></a>00091 <span class="comment">// Returns a path to the cached response headers, if they url</span>
<a name="l00092"></a>00092 - (<a class="code" href="class_n_s_string.html" title="For manipulating NSStrings.">NSString</a> *)pathToCachedResponseHeadersForURL:(NSURL *)url;
<a name="l00093"></a>00093
<a name="l00094"></a>00094 <span class="comment">// Returns the location to use to store cached response headers for a particular request</span>
<a name="l00095"></a>00095 - (<a class="code" href="class_n_s_string.html" title="For manipulating NSStrings.">NSString</a> *)pathToStoreCachedResponseHeadersForRequest:(ASIHTTPRequest *)request;
<a name="l00096"></a>00096
<a name="l00097"></a>00097 <span class="comment">// Returns the location to use to store a cached response body for a particular request</span>
<a name="l00098"></a>00098 - (<a class="code" href="class_n_s_string.html" title="For manipulating NSStrings.">NSString</a> *)pathToStoreCachedResponseDataForRequest:(ASIHTTPRequest *)request;
<a name="l00099"></a>00099
<a name="l00100"></a>00100 <span class="comment">// Clear cached data stored for the passed storage policy</span>
<a name="l00101"></a>00101 - (void)clearCachedResponsesForStoragePolicy:(ASICacheStoragePolicy)cachePolicy;
<a name="l00102"></a>00102
<a name="l00103"></a>00103 <span class="keyword">@end</span>
</pre></div></div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>ASICacheDelegate.h</b> </li>
</div><!-- .fixedwidth -->
<span class="footer">Generated for Nimbus by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4-20110629 </span>
</ul>
</div>
</div> <!-- page -->
</body>
</html>