NAME

TDcal::cache —

TDcal Perl programming library

SYNOPSIS

use TDcal::cache;

$tri =
cacheload($calref);

$tri =
cachesave($calref);

$bool =
cachelock($calref);

$bool =
cacheunlock($calref);

DESCRIPTION

TDcal::cache provides functions to manipulate a TDcal calendar's cache.

In these functions, the agrument $calref is a calendar reference as returned by tdcalref().

cacheload() loads the cache of the calendar referenced by $calref into TDcal's internal data structures. Once loaded, access to events in the calendar is available using tdcalevent().

cachesave() writes the internal calendar data to the stored cache file. It must be invoked to store all changes to a calendar and it must be invoked with the cache lock held.

cachelock() acquires the cache lock for the calendar. If the lock is already held by another process, cachelock() waits up to 10 seconds or until the lock is freed.

cacheunlock() releases the cache lock for the calendar.

RETURN VALUES

cacheload() and cacheunload() return a tri-value set to $error in the case of an error or the number of events loaded from or written to the cache if no error.

cachelock() and cacheunlock() return a boolean value to indicate success or failure.

STANDARDS

See TDcal(7).

HISTORY