Cache Lianja Reference Documentation

Cache

Current Version: 10.1.2

Object Creation

loObject = createobject("CkCache")

Properties

DebugLogFilePath
DebugLogFilePath As Character

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

  • A timeout property set to 0, indicating an infinite timeout.
  • A hang occurring within an event callback in the application code.
  • An internal bug in the Chilkat code causing the hang.

More Information and Examples
top
LastErrorHtml
LastErrorHtml As Character (read-only)

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top
LastErrorText
LastErrorText As Character (read-only)

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top
LastErrorXml
LastErrorXml As Character (read-only)

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top
LastEtagFetched
LastEtagFetched As Character (read-only)

The ETag of the last item fetched from cache.

top
LastExpirationFetchedStr
LastExpirationFetchedStr As Character (read-only)

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

top
LastHitExpired
LastHitExpired As Boolean (read-only)

.T. if the LastExpirationFetched is before the current date/time. Otherwise .F..

top
LastKeyFetched
LastKeyFetched As Character (read-only)

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
LastMethodSuccess As Boolean

Indicates the success or failure of the most recent method call: .T. means success, .F. means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.

top
Level
Level As Numeric

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
NumRoots As Numeric (read-only)

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

top
VerboseLogging
VerboseLogging As Boolean

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

top
Version
Version As Character (read-only)

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

More Information and Examples
top

Methods

AddRoot
AddRoot(path As Character)

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".

top
DeleteAll
DeleteAll() As Numeric

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
DeleteAllExpired() As Numeric

Deletes all expired items from the cache.

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

top
DeleteFromCache
DeleteFromCache(key As Character) As Boolean

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

Returns .T. for success, .F. for failure.

top
DeleteOlderDt
DeleteOlderDt(dateTime As CkDateTime) As Numeric

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

top
DeleteOlderStr
DeleteOlderStr(dateTimeStr As Character) As Numeric

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

top
FetchBd
FetchBd(key As Character, bd As CkBinData) As Boolean
Introduced in version 9.5.0.91

Fetches an item from cache and returns in bd.

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 .T. for success, .F. for failure.

top
FetchSb
FetchSb(key As Character, sb As CkStringBuilder) As Boolean
Introduced in version 9.5.0.91

Fetches a text item from the cache and returns in sb.

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 .T. for success, .F. for failure.

top
FetchText
FetchText(key As Character) As Character

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 .F. on failure

top
GetEtag
GetEtag(key As Character) As Character

Returns the eTag for an item in the cache.

Returns .F. on failure

top
GetExpirationDt
GetExpirationDt(key As Character) As CkDateTime

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

Returns .F. on failure

top
GetExpirationStr
GetExpirationStr(url As Character) As Character

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

Returns .F. on failure

top
GetFilename
GetFilename(key As Character) As Character

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

Returns .F. on failure

top
GetRoot
GetRoot(index As Numeric) As Character

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

Returns .F. on failure

top
IsCached
IsCached(key As Character) As Boolean

Returns .T. if the item is found in the cache, otherwise returns .F..

top
SaveTextDt
SaveTextDt(key As Character, expireDateTime As CkDateTime, eTag As Character, itemTextData As Character) As Boolean

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

Returns .T. for success, .F. for failure.

top
SaveTextNoExpire
SaveTextNoExpire(key As Character, eTag As Character, itemTextData As Character) As Boolean

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 .T. for success, .F. for failure.

top
SaveTextStr
SaveTextStr(key As Character, expireDateTime As Character, eTag As Character, itemTextData As Character) As Boolean

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

Returns .T. for success, .F. for failure.

top
UpdateExpirationDt
UpdateExpirationDt(key As Character, expireDateTime As CkDateTime) As Boolean

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

Returns .T. for success, .F. for failure.

top
UpdateExpirationStr
UpdateExpirationStr(key As Character, expireDateTime As Character) As Boolean

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

Returns .T. for success, .F. for failure.

top