104 lines
5.0 KiB
Objective-C
104 lines
5.0 KiB
Objective-C
//
|
|
// ASICacheDelegate.h
|
|
// Part of ASIHTTPRequest -> http://allseeing-i.com/ASIHTTPRequest
|
|
//
|
|
// Created by Ben Copsey on 01/05/2010.
|
|
// Copyright 2010 All-Seeing Interactive. All rights reserved.
|
|
//
|
|
|
|
#import <Foundation/Foundation.h>
|
|
@class ASIHTTPRequest;
|
|
|
|
// Cache policies control the behaviour of a cache and how requests use the cache
|
|
// When setting a cache policy, you can use a combination of these values as a bitmask
|
|
// For example: [request setCachePolicy:ASIAskServerIfModifiedCachePolicy|ASIFallbackToCacheIfLoadFailsCachePolicy|ASIDoNotWriteToCacheCachePolicy];
|
|
// Note that some of the behaviours below are mutally exclusive - you cannot combine ASIAskServerIfModifiedWhenStaleCachePolicy and ASIAskServerIfModifiedCachePolicy, for example.
|
|
typedef enum _ASICachePolicy {
|
|
|
|
// The default cache policy. When you set a request to use this, it will use the cache's defaultCachePolicy
|
|
// ASIDownloadCache's default cache policy is 'ASIAskServerIfModifiedWhenStaleCachePolicy'
|
|
ASIUseDefaultCachePolicy = 0,
|
|
|
|
// Tell the request not to read from the cache
|
|
ASIDoNotReadFromCacheCachePolicy = 1,
|
|
|
|
// The the request not to write to the cache
|
|
ASIDoNotWriteToCacheCachePolicy = 2,
|
|
|
|
// Ask the server if there is an updated version of this resource (using a conditional GET) ONLY when the cached data is stale
|
|
ASIAskServerIfModifiedWhenStaleCachePolicy = 4,
|
|
|
|
// Always ask the server if there is an updated version of this resource (using a conditional GET)
|
|
ASIAskServerIfModifiedCachePolicy = 8,
|
|
|
|
// 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
|
|
ASIOnlyLoadIfNotCachedCachePolicy = 16,
|
|
|
|
// 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)
|
|
ASIDontLoadCachePolicy = 32,
|
|
|
|
// 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.
|
|
ASIFallbackToCacheIfLoadFailsCachePolicy = 64
|
|
} ASICachePolicy;
|
|
|
|
// Cache storage policies control whether cached data persists between application launches (ASICachePermanentlyCacheStoragePolicy) or not (ASICacheForSessionDurationCacheStoragePolicy)
|
|
// Calling [ASIHTTPRequest clearSession] will remove any data stored using ASICacheForSessionDurationCacheStoragePolicy
|
|
typedef enum _ASICacheStoragePolicy {
|
|
ASICacheForSessionDurationCacheStoragePolicy = 0,
|
|
ASICachePermanentlyCacheStoragePolicy = 1
|
|
} ASICacheStoragePolicy;
|
|
|
|
|
|
@protocol ASICacheDelegate <NSObject>
|
|
|
|
@required
|
|
|
|
// Should return the cache policy that will be used when requests have their cache policy set to ASIUseDefaultCachePolicy
|
|
- (ASICachePolicy)defaultCachePolicy;
|
|
|
|
// Returns the date a cached response should expire on. Pass a non-zero max age to specify a custom date.
|
|
- (NSDate *)expiryDateForRequest:(ASIHTTPRequest *)request maxAge:(NSTimeInterval)maxAge;
|
|
|
|
// Updates cached response headers with a new expiry date. Pass a non-zero max age to specify a custom date.
|
|
- (void)updateExpiryForRequest:(ASIHTTPRequest *)request maxAge:(NSTimeInterval)maxAge;
|
|
|
|
// Looks at the request's cache policy and any cached headers to determine if the cache data is still valid
|
|
- (BOOL)canUseCachedDataForRequest:(ASIHTTPRequest *)request;
|
|
|
|
// Removes cached data for a particular request
|
|
- (void)removeCachedDataForRequest:(ASIHTTPRequest *)request;
|
|
|
|
// Should return YES if the cache considers its cached response current for the request
|
|
// Should return NO is the data is not cached, or (for example) if the cached headers state the request should have expired
|
|
- (BOOL)isCachedDataCurrentForRequest:(ASIHTTPRequest *)request;
|
|
|
|
// Should store the response for the passed request in the cache
|
|
// When a non-zero maxAge is passed, it should be used as the expiry time for the cached response
|
|
- (void)storeResponseForRequest:(ASIHTTPRequest *)request maxAge:(NSTimeInterval)maxAge;
|
|
|
|
// Removes cached data for a particular url
|
|
- (void)removeCachedDataForURL:(NSURL *)url;
|
|
|
|
// Should return an NSDictionary of cached headers for the passed URL, if it is stored in the cache
|
|
- (NSDictionary *)cachedResponseHeadersForURL:(NSURL *)url;
|
|
|
|
// Should return the cached body of a response for the passed URL, if it is stored in the cache
|
|
- (NSData *)cachedResponseDataForURL:(NSURL *)url;
|
|
|
|
// Returns a path to the cached response data, if it exists
|
|
- (NSString *)pathToCachedResponseDataForURL:(NSURL *)url;
|
|
|
|
// Returns a path to the cached response headers, if they url
|
|
- (NSString *)pathToCachedResponseHeadersForURL:(NSURL *)url;
|
|
|
|
// Returns the location to use to store cached response headers for a particular request
|
|
- (NSString *)pathToStoreCachedResponseHeadersForRequest:(ASIHTTPRequest *)request;
|
|
|
|
// Returns the location to use to store a cached response body for a particular request
|
|
- (NSString *)pathToStoreCachedResponseDataForRequest:(ASIHTTPRequest *)request;
|
|
|
|
// Clear cached data stored for the passed storage policy
|
|
- (void)clearCachedResponsesForStoragePolicy:(ASICacheStoragePolicy)cachePolicy;
|
|
|
|
@end
|