CkCache Python Reference Documentation

CkCache

Current Version: 9.5.0.73

Object Creation

obj = chilkat.CkCache()

Properties

DebugLogFilePath
# strVal is a string
# ckStr is a CkString
cache.get_DebugLogFilePath(ckStr);
strVal = cache.debugLogFilePath();
cache.put_DebugLogFilePath(strVal);

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
# strVal is a string
# ckStr is a CkString
cache.get_LastErrorHtml(ckStr);
strVal = cache.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
# strVal is a string
# ckStr is a CkString
cache.get_LastErrorText(ckStr);
strVal = cache.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
# strVal is a string
# ckStr is a CkString
cache.get_LastErrorXml(ckStr);
strVal = cache.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
# strVal is a string
# ckStr is a CkString
cache.get_LastEtagFetched(ckStr);
strVal = cache.lastEtagFetched();

The ETag of the last item fetched from cache.

top
LastExpirationFetchedStr
# strVal is a string
# ckStr is a CkString
cache.get_LastExpirationFetchedStr(ckStr);
strVal = cache.lastExpirationFetchedStr();

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

top
LastHitExpired
# boolVal is a boolean
boolVal = cache.get_LastHitExpired();

True if the LastExpirationFetched is before the current date/time. Otherwise False.

top
LastKeyFetched
# strVal is a string
# ckStr is a CkString
cache.get_LastKeyFetched(ckStr);
strVal = cache.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
# boolVal is a boolean
boolVal = cache.get_LastMethodSuccess();
cache.put_LastMethodSuccess(boolVal);
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
# intVal is an integer
intVal = cache.get_Level();
cache.put_Level(intVal);

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
# intVal is an integer
intVal = cache.get_NumRoots();

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

top
Utf8
# boolVal is a boolean
boolVal = cache.get_Utf8();
cache.put_Utf8(boolVal);

When set to True, all "const char *" arguments are interpreted as utf-8 strings. If set to False (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to True, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to False, all "const char *" return values are ANSI strings.

top
VerboseLogging
# boolVal is a boolean
boolVal = cache.get_VerboseLogging();
cache.put_VerboseLogging(boolVal);

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
# strVal is a string
# ckStr is a CkString
cache.get_Version(ckStr);
strVal = cache.version();

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

top

Methods

AddRoot
# path is a string
cache.AddRoot(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
retInt = cache.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
retInt = cache.DeleteAllExpired();

Deletes all expired items from the cache.

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

top
DeleteFromCache
# key is a string
status = cache.DeleteFromCache(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
# dateTime is a CkDateTime
retInt = cache.DeleteOlderDt(dateTime);

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

top
DeleteOlderStr
# dateTimeStr is a string
retInt = cache.DeleteOlderStr(dateTimeStr);

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

top
FetchFromCache
# key is a string
# outBytes is a CkByteData (output)
status = cache.FetchFromCache(key, outData);

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 True for success, False for failure.

More Information and Examples
top
FetchText
# key is a string
# outStr is a CkString (output)
status = cache.FetchText(key, outStr);
retStr = cache.fetchText(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 True for success, False for failure.

More Information and Examples
top
GetEtag
# key is a string
# outStr is a CkString (output)
status = cache.GetEtag(key, outStr);
retStr = cache.getEtag(key);

Returns the eTag for an item in the cache.

Returns True for success, False for failure.

top
GetExpirationDt
# returns a CkDateTime
# key is a string
ret_ckDateTime = cache.GetExpirationDt(key);

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

Returns None on failure

top
GetExpirationStr
# url is a string
# outStr is a CkString (output)
status = cache.GetExpirationStr(url, outStr);
retStr = cache.getExpirationStr(url);

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

Returns True for success, False for failure.

top
GetFilename
# key is a string
# outStr is a CkString (output)
status = cache.GetFilename(key, outStr);
retStr = cache.getFilename(key);

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

Returns True for success, False for failure.

top
GetRoot
# index is an integer
# outStr is a CkString (output)
status = cache.GetRoot(index, outStr);
retStr = cache.getRoot(index);

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

Returns True for success, False for failure.

top
IsCached
# key is a string
retBool = cache.IsCached(key);

Returns True if the item is found in the cache, otherwise returns False.

top
SaveLastError
# path is a string
status = cache.SaveLastError(path);

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

Returns True for success, False for failure.

top
SaveTextDt
# key is a string
# expireDateTime is a CkDateTime
# eTag is a string
# itemTextData is a string
status = cache.SaveTextDt(key, expireDateTime, eTag, 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
# key is a string
# eTag is a string
# itemTextData is a string
status = cache.SaveTextNoExpire(key, eTag, 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
# key is a string
# expireDateTime is a string
# eTag is a string
# itemTextData is a string
status = cache.SaveTextStr(key, expireDateTime, eTag, 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
# key is a string
# expireDateTime is a CkDateTime
# eTag is a string
# itemData is a CkByteData
status = cache.SaveToCacheDt(key, expireDateTime, eTag, 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
# key is a string
# eTag is a string
# itemData is a CkByteData
status = cache.SaveToCacheNoExpire(key, eTag, 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
# key is a string
# expireDateTime is a string
# eTag is a string
# itemData is a CkByteData
status = cache.SaveToCacheStr(key, expireDateTime, eTag, 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
# key is a string
# expireDateTime is a CkDateTime
status = cache.UpdateExpirationDt(key, expireDateTime);

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

Returns True for success, False for failure.

top
UpdateExpirationStr
# key is a string
# expireDateTime is a string
status = cache.UpdateExpirationStr(key, expireDateTime);

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

Returns True for success, False for failure.

top