atsavecache(3) [debian man page]

atcache(3)						       AtFS Toolkit Library							atcache(3)

NAME

       atSaveCache, atCacheKey - derived object cache handling

SYNOPSIS

       #include <atfs.h>
       #include <atfstk.h>

       int  atSaveCache (Af_key *aso, Af_key *cachedAso, char *uniqAttribute, int storeType);

       char*atCacheKey (Af_key *aso);

DESCRIPTION

       atSaveCache  adds  the  given  busy  object  aso  to  the  current  derived object cache. It does this by calling af_savecache (manual page
       af_cache(3)). Prior to that, atSaveCache attaches a key attribute with the name __CacheKey__ to aso, by which the resulting  cached  object
       can be uniquely identified within the cache. Return values are the same as from af_savecache (manual page af_cache(3)).

       atCacheKey  returns  an attribute string consisting of the attribute name __CacheKey__ and an attribute value built of the aso modification
       date, the process number and a (per process unique) serial number. This attribute can (and will) be used to  uniquely  identify	attributed
       software objects in derived object caches.

SEE ALSO

       af_cache(3)

AtFStk-1.12						     Fri Jun 25 16:39:33 1993							atcache(3)

af_cache(3)						    Attribute Filesystem (AtFS) 					       af_cache(3)

NAME

       af_savecache, af_cachesize - AtFS derived object cache handling

SYNOPSIS

       #include <atfs.h>

       int af_savecache (Af_key *busyAso, Af_key* cachedAso, char *attr, int mode)

       int af_cachesize (char path, int totalMax, int maxPerName, int maxPerGivenAttr);

DESCRIPTION

       af_savecache  copies  a busy attributed software object (busyAso) to a derived object cache. A key for the resulting cached ASO is returned
       in the buffer cachedAso.  Derived object caches are intended to hold derived objects that can be reproduced at any time. Reproducibility is
       important, because cached ASOs may be deleted automatically due to storage limitations for derived object caches.  A cache allows a certain
       number of versions per name (see function af_cachesize described below) to be stored. When this number is reached, each time a new  version
       arrives, the oldest version (access date) gets cleaned out.

       The strategy of cleaning out old versions when space is needed for new ones is influenced by the attr argument. When this is given af_save-
       cache searches for cached versions (with the same name as the new one) carrying the given attribute. If it finds one or more such versions,
       the oldest (access date) of them will be eliminated.

       The mode argument may have one of the following values

       AF_STORE_COMPLETE
		   (default) The cached file is stored unmodified.

       AF_STORE_COMPRESSED
		   The cached file will be stored in a compressed format.

       ASOs  that  are	saved in derived object caches do not automatically get a version number. By means of af_svnum (manual page af_version(3))
       you can attach any version number to an ASO stored in a derived object cache.

       af_cachesize defines the size strategy of the cache in directory path. It sets the maximum cache size for the whole  directory  (totalMax),
       the  maximum number of versions per name (maxPerName), and the number of versions allowed simultaneously carrying the elimination attribute
       (see before). A value less or equal zero given for any of the arguments of af_cachesize will cause this argument to be ignored.

DIAGNOSTICS

       Upon error, -1 is returned and af_errno is set to the corresponding error number.

BUGS

       Compression of cached files (mode AF_STORE_COMPRESSED) is not yet supported.

       af_cachesize cannot shrink derived object caches yet. Values given must be greater or equal the prevoius size.

AtFS-1.71						     Mon Jul 19 18:19:37 1993						       af_cache(3)