Cache Perl Reference Documentation

CkCache

Current Version: 10.1.2

Requires Chilkat Bundle License

Object Creation

$obj = chilkat::CkCache->new();

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, 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

Example showing how to use DebugLogFilePath.

LastErrorHtml

# $strVal is a string
# $ckStr is a CkString
$cache->get_LastErrorHtml($ckStr);
$strVal = $cache->lastErrorHtml();

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.

LastErrorText

# $strVal is a string
# $ckStr is a CkString
$cache->get_LastErrorText($ckStr);
$strVal = $cache->lastErrorText();

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.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

# $strVal is a string
# $ckStr is a CkString
$cache->get_LastErrorXml($ckStr);
$strVal = $cache->lastErrorXml();

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.

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.

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.

LastHitExpired

# $boolVal is a boolean
$boolVal = $cache->get_LastHitExpired();

1 if the LastExpirationFetched is before the current date/time. Otherwise 0.

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

LastMethodSuccess

# $boolVal is a boolean
$boolVal = $cache->get_LastMethodSuccess();
$cache->put_LastMethodSuccess($boolVal);

Indicates the success or failure of the most recent method call: 1 means success, 0 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.

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.

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.

Utf8

# $boolVal is a boolean
$boolVal = $cache->get_Utf8();
$cache->put_Utf8($boolVal);

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

VerboseLogging

# $boolVal is a boolean
$boolVal = $cache->get_VerboseLogging();
$cache->put_VerboseLogging($boolVal);

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

Version

# $strVal is a string
# $ckStr is a CkString
$cache->get_Version($ckStr);
$strVal = $cache->version();

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

More Information and Examples

How to get the Chilkat version at runtime.

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

Large Persistent Hash Table Stored on Filesystem

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.

DeleteAllExpired

$retInt = $cache->DeleteAllExpired();

Deletes all expired items from the cache.

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

DeleteFromCache

# $key is a string
$status = $cache->DeleteFromCache($key);

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

Returns 1 for success, 0 for failure.

DeleteOlderDt

# $dateTime is a CkDateTime
$retInt = $cache->DeleteOlderDt($dateTime);

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

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.

FetchBd

# $key is a string
# $bd is a CkBinData
$status = $cache->FetchBd($key, $bd);

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 1 for success, 0 for failure.

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 1 for success, 0 for failure.

FetchSb

# $key is a string
# $sb is a CkStringBuilder
$status = $cache->FetchSb($key, $sb);

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 1 for success, 0 for failure.

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 1 for success, 0 for failure.

More Information and Examples

Large Persistent Hash Table Stored on Filesystem

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 1 for success, 0 for failure.

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 null on failure

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 1 for success, 0 for failure.

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 1 for success, 0 for failure.

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 1 for success, 0 for failure.

IsCached

# $key is a string
$retBool = $cache->IsCached($key);

Returns 1 if the item is found in the cache, otherwise returns 0.

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 1 for success, 0 for failure.

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 1 for success, 0 for failure.

More Information and Examples

Large Persistent Hash Table Stored on Filesystem

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 1 for success, 0 for failure.

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 1 for success, 0 for failure.

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 1 for success, 0 for failure.

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 1 for success, 0 for failure.

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 1 for success, 0 for failure.

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 1 for success, 0 for failure.