Cache C# WinRT Reference Documentation

Cache

Current Version: 9.5.0.73

Object Creation

Chilkat.Cache obj = new Chilkat.Cache();

Properties

DebugLogFilePath
public string DebugLogFilePath {get; set; }

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
public string LastErrorHtml {get; }

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
public string LastErrorText {get; }

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
public string LastErrorXml {get; }

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
public string LastEtagFetched {get; }

The ETag of the last item fetched from cache.

top
LastExpirationFetchedStr
public string LastExpirationFetchedStr {get; }

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

top
LastHitExpired
public bool LastHitExpired {get; }

true if the LastExpirationFetched is before the current date/time. Otherwise false.

top
LastKeyFetched
public string LastKeyFetched {get; }

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
public bool LastMethodSuccess {get; set; }
Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of true indicates success, a value of false 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 = true and failure = false.
  • 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 true. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
Level
public int Level {get; set; }

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
public int NumRoots {get; }

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

top
VerboseLogging
public bool VerboseLogging {get; set; }

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

top
Version
public string Version {get; }

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

top

Methods

AddRoot
public void AddRoot(string 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
public int 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
public int DeleteAllExpired();

Deletes all expired items from the cache.

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

top
DeleteFromCache
public bool DeleteFromCache(string key);

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

Returns true for success, false for failure.

top
DeleteOlderDt
public int DeleteOlderDt(CkDateTime dateTime);

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

top
DeleteOlderStr
public int DeleteOlderStr(string dateTimeStr);

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

top
FetchFromCache
public byte[] FetchFromCache(string 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 an empty byte array on failure

More Information and Examples
top
FetchText
public string FetchText(string 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 null on failure

More Information and Examples
top
GetEtag
public string GetEtag(string key);

Returns the eTag for an item in the cache.

Returns null on failure

top
GetExpirationDt
public CkDateTime GetExpirationDt(string key);

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

Returns null on failure

top
GetExpirationStr
public string GetExpirationStr(string url);

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

Returns null on failure

top
GetFilename
public string GetFilename(string key);

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

Returns null on failure

top
GetRoot
public string GetRoot(int index);

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

Returns null on failure

top
IsCached
public bool IsCached(string key);

Returns true if the item is found in the cache, otherwise returns false.

top
SaveTextDt
public bool SaveTextDt(string key, CkDateTime expireDateTime, string eTag, string itemTextData);

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

Returns true for success, false for failure.

top
SaveTextNoExpire
public bool SaveTextNoExpire(string key, string eTag, string itemTextData);

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 true for success, false for failure.

More Information and Examples
top
SaveTextStr
public bool SaveTextStr(string key, string expireDateTime, string eTag, string itemTextData);

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

Returns true for success, false for failure.

top
SaveToCacheDt
public bool SaveToCacheDt(string key, CkDateTime expireDateTime, string eTag, byte[] itemData);

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

Returns true for success, false for failure.

top
SaveToCacheNoExpire
public bool SaveToCacheNoExpire(string key, string eTag, byte[] itemData);

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 true for success, false for failure.

More Information and Examples
top
SaveToCacheStr
public bool SaveToCacheStr(string key, string expireDateTime, string eTag, byte[] itemData);

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

Returns true for success, false for failure.

top
UpdateExpirationDt
public bool UpdateExpirationDt(string key, CkDateTime expireDateTime);

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

Returns true for success, false for failure.

top
UpdateExpirationStr
public bool UpdateExpirationStr(string key, string expireDateTime);

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

Returns true for success, false for failure.

top