CkoCache Objective-C Reference Documentation

CkoCache

Current Version: 9.5.0.73

Object Creation

CkoCache *obj = [[CkoCache alloc] init];

Properties

DebugLogFilePath
@property (nonatomic, copy) NSString *DebugLogFilePath;

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

top
LastErrorHtml
@property (nonatomic, readonly, copy) NSString *LastErrorHtml;

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorText
@property (nonatomic, readonly, copy) NSString *LastErrorText;

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorXml
@property (nonatomic, readonly, copy) NSString *LastErrorXml;

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastEtagFetched
@property (nonatomic, readonly, copy) NSString *LastEtagFetched;

The ETag of the last item fetched from cache.

top
LastExpirationFetched
@property (nonatomic, readonly, copy) NSDate *LastExpirationFetched;
This property is deprecated. It will be removed in a future version.

Expiration date/time of the last item fetched from cache.

top
LastExpirationFetchedStr
@property (nonatomic, readonly, copy) NSString *LastExpirationFetchedStr;

Expiration date/time of the last item fetched from cache in RFC822 string format.

top
LastHitExpired
@property (nonatomic, readonly) BOOL LastHitExpired;

YES if the LastExpirationFetched is before the current date/time. Otherwise NO.

top
LastKeyFetched
@property (nonatomic, readonly, copy) NSString *LastKeyFetched;

The key of the last item fetched from cache. (For web pages, the key is typically the canonicalized URL. Otherwise, the key is a unique identifer used to access the cached item.)

top
LastMethodSuccess
@property (nonatomic) BOOL LastMethodSuccess;
Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of YES indicates success, a value of NO indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = YES and failure = NO.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to YES. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
Level
@property (nonatomic, copy) NSNumber *Level;

The number of directory levels in the cache. Possible values are:

0: All cache files are in a single directory (the cache root).

1: Cache files are located in 256 sub-directories numbered 0 .. 255 directly under the cache root.

2: There are two levels of sub-directories under the cache root. The 1st level has 256 sub-directories numbered 0 .. 255 directly under the cache root. The 2nd level allows for up to 256 sub-directories (0..255) under each level-1 directory. Cache files are stored in the leaf directories.

top
NumRoots
@property (nonatomic, readonly, copy) NSNumber *NumRoots;

The number of root directories composing the cache. A typical multi-root cache would place each root on a separate hard drive.

top
VerboseLogging
@property (nonatomic) BOOL VerboseLogging;

If set to YES, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is NO. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top
Version
@property (nonatomic, readonly, copy) NSString *Version;

Version of the component/library, such as "9.5.0.63"

top

Methods

AddRoot
- (void)AddRoot:(NSString *)path;

Must be called once for each cache root. For example, if the cache is spread across D:\cacheRoot, E:\cacheRoot, and F:\cacheRoot, an application would setup the cache object by calling AddRoot three times -- once with "D:\cacheRoot", once with "E:\cacheRoot", and once with "F:\cacheRoot".

More Information and Examples
top
DeleteAll
- (NSNumber *)DeleteAll;

Deletes all items in the cache. This method completely clears the cache. All files in the cache are deleted. (If the cache is multi-level, existing sub-directories are not deleted.)

Returns the number of items (i.e. cache files) deleted.

top
DeleteAllExpired
- (NSNumber *)DeleteAllExpired;

Deletes all expired items from the cache.

Returns the number of items (i.e. cache files) deleted.

top
DeleteFromCache
- (BOOL)DeleteFromCache:(NSString *)key;

Deletes a single item from the disk cache. Returns NO if the item exists in cache but could not be deleted. Otherwise returns YES.

Returns YES for success, NO for failure.

top
DeleteOlder
- (NSNumber *)DeleteOlder:(NSDate *)dt;
This method is deprecated. It will be removed in a future version.

Deletes all items older than a specified date/time.

Returns the number of items (i.e. cache files) deleted. Returns -1 on error.

top
DeleteOlderDt
- (NSNumber *)DeleteOlderDt:(CkoDateTime *)dt;

The same as DeleteOlder, except the dateTime is passed as a CkDateTime.

top
DeleteOlderStr
- (NSNumber *)DeleteOlderStr:(NSString *)dateTimeStr;

The same as DeleteOlder, except the dateTimeStr is passed as a date/time in RFC822 format.

top
FetchFromCache
- (NSData *)FetchFromCache:(NSString *)key;

Fetches an item from cache.

The key may be any length and may include any characters. It should uniquely identify the cached item. (No two items in the cache should have the same key.)

Returns nil on failure

More Information and Examples
top
FetchText
- (NSString *)FetchText:(NSString *)key;

Fetches a text item from the cache and returns it's text content.

The key may be any length and may include any characters. It should uniquely identify the cached item. (No two items in the cache should have the same key.)

Returns nil on failure

More Information and Examples
top
GetEtag
- (NSString *)GetEtag:(NSString *)key;

Returns the eTag for an item in the cache.

Returns nil on failure

top
GetExpiration
- (NSDate *)GetExpiration:(NSString *)key;
This method is deprecated. It will be removed in a future version.

Returns the expire date/time for an item in the cache.

top
GetExpirationDt
- (CkoDateTime *)GetExpirationDt:(NSString *)key;

Returns the expiration date/time for an item in the cache as a CkDateTime object.

Returns nil on failure

top
GetExpirationStr
- (NSString *)GetExpirationStr:(NSString *)url;

Returns the expiration date/time for an item in the cache in RFC822 string format.

Returns nil on failure

top
GetFilename
- (NSString *)GetFilename:(NSString *)key;

Returns the absolute file path of the cache file associated with the key.

Returns nil on failure

top
GetRoot
- (NSString *)GetRoot:(NSNumber *)index;

Returns the directory path of the Nth cache root. (Indexing begins at 0.)

Returns nil on failure

top
IsCached
- (BOOL)IsCached:(NSString *)key;

Returns YES if the item is found in the cache, otherwise returns NO.

top
SaveLastError
- (BOOL)SaveLastError:(NSString *)path;

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns YES for success, NO for failure.

top
SaveText
- (BOOL)SaveText:(NSString *)key
    expire:(NSDate *)expire
    eTag:(NSString *)eTag
    strData:(NSString *)strData;
This method is deprecated. It will be removed in a future version.

Inserts or replaces an text item in the cache. The eTag is optional and may be set to a zero-length string. Applications may use it as a place to save additional information about the cached item. The key may be any length and may include any characters. It should uniquely identify the cached item. (No two items in the cache should have the same key.)

Returns YES for success, NO for failure.

top
SaveTextDt
- (BOOL)SaveTextDt:(NSString *)key
    expire:(CkoDateTime *)expire
    eTag:(NSString *)eTag
    strData:(NSString *)strData;

The same as SaveText, except the expire date/time is passed as a CkDateTime object.

Returns YES for success, NO for failure.

top
SaveTextNoExpire
- (BOOL)SaveTextNoExpire:(NSString *)key
    eTag:(NSString *)eTag
    strData:(NSString *)strData;

Inserts or replaces an text item in the cache with no expiration date/time. The eTag is optional and may be set to a zero-length string. Applications may use it as a place to save additional information about the cached item.

Returns YES for success, NO for failure.

More Information and Examples
top
SaveTextStr
- (BOOL)SaveTextStr:(NSString *)key
    expireDateTimeStr:(NSString *)expireDateTimeStr
    eTag:(NSString *)eTag
    strData:(NSString *)strData;

The same as SaveText, except the expire date/time is passed as a string in RFC822 format.

Returns YES for success, NO for failure.

top
SaveToCache
- (BOOL)SaveToCache:(NSString *)key
    expire:(NSDate *)expire
    eTag:(NSString *)eTag
    data:(NSData *)data;
This method is deprecated. It will be removed in a future version.

Inserts or replaces an item in the cache. The eTag is optional and may be set to a zero-length string. Applications may use it as a place to save additional information about the cached item. (The Chilkat HTTP component, when caching a page, writes the eTag (entity-tag) from the HTTP response header to this field.)

The key may be any length and may include any characters. It should uniquely identify the cached item. (No two items in the cache should have the same key.)

Returns YES for success, NO for failure.

top
SaveToCacheDt
- (BOOL)SaveToCacheDt:(NSString *)key
    expire:(CkoDateTime *)expire
    eTag:(NSString *)eTag
    data:(NSData *)data;

The same as SaveToCache, except the expire date/time is passed as a CkDateTime object.

Returns YES for success, NO for failure.

top
SaveToCacheNoExpire
- (BOOL)SaveToCacheNoExpire:(NSString *)key
    eTag:(NSString *)eTag
    data:(NSData *)data;

Inserts or replaces an item in the cache. The cached item will have no expiration. The eTag is optional and may be set to a zero-length string. Applications may use it as a place to save additional information about the cached item.

Returns YES for success, NO for failure.

More Information and Examples
top
SaveToCacheStr
- (BOOL)SaveToCacheStr:(NSString *)url
    expireDateTimeStr:(NSString *)expireDateTimeStr
    eTag:(NSString *)eTag
    data:(NSData *)data;

The same as SaveToCache, except the expire date/time is passed in RFC822 string format.

Returns YES for success, NO for failure.

top
UpdateExpiration
- (BOOL)UpdateExpiration:(NSString *)key
    dt:(NSDate *)dt;
This method is deprecated. It will be removed in a future version.

Updates the expire date/time for a cached item.

Returns YES for success, NO for failure.

top
UpdateExpirationDt
- (BOOL)UpdateExpirationDt:(NSString *)key
    dt:(CkoDateTime *)dt;

The same as UpdateExpiration, except the expireDateTime is passed as a CkDateTime.

Returns YES for success, NO for failure.

top
UpdateExpirationStr
- (BOOL)UpdateExpirationStr:(NSString *)url
    dateTimeStr:(NSString *)dateTimeStr;

The same as UpdateExpiration, except the expireDateTime is passed in RFC822 string format.

Returns YES for success, NO for failure.

top