322 lines
11 KiB
C
322 lines
11 KiB
C
|
// CkCache.h: interface for the CkCache class.
|
||
|
|
//
|
||
|
|
//////////////////////////////////////////////////////////////////////
|
||
|
|
|
||
|
|
// This header is generated for Chilkat 11.3.0
|
||
|
|
|
||
|
|
#define _CkVersion 11.3.0
|
||
|
|
|
||
|
|
#ifndef _CkCache_H
|
||
|
|
#define _CkCache_H
|
||
|
|
|
||
|
|
#include "chilkatDefs.h"
|
||
|
|
#include "CkString.h"
|
||
|
|
#include "CkMultiByteBase.h"
|
||
|
|
|
||
|
|
class CkDateTime;
|
||
|
|
class CkBinData;
|
||
|
|
class CkByteData;
|
||
|
|
class CkStringBuilder;
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
#if !defined(__sun__) && !defined(__sun)
|
||
|
|
#pragma pack (push, 8)
|
||
|
|
#endif
|
||
|
|
|
||
|
|
|
||
|
|
#undef Copy
|
||
|
|
|
||
|
|
// CLASS: CkCache
|
||
|
|
class CK_VISIBLE_PUBLIC CkCache : public CkMultiByteBase
|
||
|
|
{
|
||
|
|
private:
|
||
|
|
|
||
|
|
// Don't allow assignment or copying these objects.
|
||
|
|
CkCache(const CkCache &);
|
||
|
|
CkCache &operator=(const CkCache &);
|
||
|
|
|
||
|
|
public:
|
||
|
|
CkCache(void);
|
||
|
|
virtual ~CkCache(void);
|
||
|
|
|
||
|
|
static CkCache *createNew(void);
|
||
|
|
static CkCache *createNew2(int progLang);
|
||
|
|
void CK_VISIBLE_PRIVATE inject(void *impl);
|
||
|
|
|
||
|
|
// May be called when finished with the object to free/dispose of any
|
||
|
|
// internal resources held by the object.
|
||
|
|
void dispose(void);
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
// BEGIN PUBLIC INTERFACE
|
||
|
|
|
||
|
|
// ----------------------
|
||
|
|
// Properties
|
||
|
|
// ----------------------
|
||
|
|
// The ETag of the last item fetched from cache.
|
||
|
|
void get_LastEtagFetched(CkString &str);
|
||
|
|
// The ETag of the last item fetched from cache.
|
||
|
|
const char *lastEtagFetched(void);
|
||
|
|
|
||
|
|
// Expiration date/time of the last item fetched from cache in RFC822 string
|
||
|
|
// format.
|
||
|
|
void get_LastExpirationFetchedStr(CkString &str);
|
||
|
|
// Expiration date/time of the last item fetched from cache in RFC822 string
|
||
|
|
// format.
|
||
|
|
const char *lastExpirationFetchedStr(void);
|
||
|
|
|
||
|
|
// true if the LastExpirationFetched is before the current date/time. Otherwise
|
||
|
|
// false.
|
||
|
|
bool get_LastHitExpired(void);
|
||
|
|
|
||
|
|
// 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.)
|
||
|
|
void get_LastKeyFetched(CkString &str);
|
||
|
|
// 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.)
|
||
|
|
const char *lastKeyFetched(void);
|
||
|
|
|
||
|
|
// 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.
|
||
|
|
//
|
||
|
|
int get_Level(void);
|
||
|
|
// 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.
|
||
|
|
//
|
||
|
|
void put_Level(int newVal);
|
||
|
|
|
||
|
|
// The number of root directories composing the cache. A typical multi-root cache
|
||
|
|
// would place each root on a separate hard drive.
|
||
|
|
int get_NumRoots(void);
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
// ----------------------
|
||
|
|
// Methods
|
||
|
|
// ----------------------
|
||
|
|
// 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 .
|
||
|
|
void AddRoot(const char *path);
|
||
|
|
|
||
|
|
|
||
|
|
// 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.
|
||
|
|
//
|
||
|
|
int DeleteAll(void);
|
||
|
|
|
||
|
|
|
||
|
|
// Deletes all expired items from the cache.
|
||
|
|
//
|
||
|
|
// Returns the number of items (i.e. cache files) deleted.
|
||
|
|
//
|
||
|
|
int DeleteAllExpired(void);
|
||
|
|
|
||
|
|
|
||
|
|
// Deletes a single item from the disk cache. Returns false if the item exists in
|
||
|
|
// cache but could not be deleted. Otherwise returns true.
|
||
|
|
bool DeleteFromCache(const char *key);
|
||
|
|
|
||
|
|
|
||
|
|
// Deletes all items older than a specified date/time.
|
||
|
|
//
|
||
|
|
// Returns the number of items (i.e. cache files) deleted. Returns -1 on error.
|
||
|
|
//
|
||
|
|
int DeleteOlderDt(CkDateTime &dateTime);
|
||
|
|
|
||
|
|
|
||
|
|
// Deletes all items older than a specified date/time.
|
||
|
|
//
|
||
|
|
// Returns the number of items (i.e. cache files) deleted. The dateTimeStr is passed as a
|
||
|
|
// date/time in RFC822 format. Returns -1 on error.
|
||
|
|
//
|
||
|
|
int DeleteOlderStr(const char *dateTimeStr);
|
||
|
|
|
||
|
|
|
||
|
|
// 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.)
|
||
|
|
//
|
||
|
|
bool FetchBd(const char *key, CkBinData &bd);
|
||
|
|
|
||
|
|
|
||
|
|
// 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.)
|
||
|
|
//
|
||
|
|
bool FetchFromCache(const char *key, CkByteData &outBytes);
|
||
|
|
|
||
|
|
|
||
|
|
// 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.)
|
||
|
|
//
|
||
|
|
bool FetchSb(const char *key, CkStringBuilder &sb);
|
||
|
|
|
||
|
|
|
||
|
|
// 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.)
|
||
|
|
//
|
||
|
|
bool FetchText(const char *key, CkString &outStr);
|
||
|
|
|
||
|
|
// 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.)
|
||
|
|
//
|
||
|
|
const char *fetchText(const char *key);
|
||
|
|
|
||
|
|
// Returns the eTag for an item in the cache.
|
||
|
|
bool GetEtag(const char *key, CkString &outStr);
|
||
|
|
|
||
|
|
// Returns the eTag for an item in the cache.
|
||
|
|
const char *getEtag(const char *key);
|
||
|
|
// Returns the eTag for an item in the cache.
|
||
|
|
const char *etag(const char *key);
|
||
|
|
|
||
|
|
|
||
|
|
// Returns the expiration date/time for an item in the cache as a CkDateTime
|
||
|
|
// object.
|
||
|
|
// The caller is responsible for deleting the object returned by this method.
|
||
|
|
CkDateTime *GetExpirationDt(const char *key);
|
||
|
|
|
||
|
|
|
||
|
|
// Returns the expiration date/time for an item in the cache in RFC822 string
|
||
|
|
// format.
|
||
|
|
bool GetExpirationStr(const char *url, CkString &outStr);
|
||
|
|
|
||
|
|
// Returns the expiration date/time for an item in the cache in RFC822 string
|
||
|
|
// format.
|
||
|
|
const char *getExpirationStr(const char *url);
|
||
|
|
// Returns the expiration date/time for an item in the cache in RFC822 string
|
||
|
|
// format.
|
||
|
|
const char *expirationStr(const char *url);
|
||
|
|
|
||
|
|
|
||
|
|
// Returns the absolute file path of the cache file associated with the key.
|
||
|
|
bool GetFilename(const char *key, CkString &outStr);
|
||
|
|
|
||
|
|
// Returns the absolute file path of the cache file associated with the key.
|
||
|
|
const char *getFilename(const char *key);
|
||
|
|
// Returns the absolute file path of the cache file associated with the key.
|
||
|
|
const char *filename(const char *key);
|
||
|
|
|
||
|
|
|
||
|
|
// Returns the directory path of the Nth cache root. (Indexing begins at 0.)
|
||
|
|
bool GetRoot(int index, CkString &outStr);
|
||
|
|
|
||
|
|
// Returns the directory path of the Nth cache root. (Indexing begins at 0.)
|
||
|
|
const char *getRoot(int index);
|
||
|
|
// Returns the directory path of the Nth cache root. (Indexing begins at 0.)
|
||
|
|
const char *root(int index);
|
||
|
|
|
||
|
|
|
||
|
|
// Returns true if the item is found in the cache, otherwise returns false.
|
||
|
|
bool IsCached(const char *key);
|
||
|
|
|
||
|
|
|
||
|
|
// Saves the contents of bd to the cache. expiration is the expiration date/time in
|
||
|
|
// RFC822 format; use an empty string if there is no expiration date. etag is
|
||
|
|
// optional metadata called an entity tag that can also be an empty string. key is
|
||
|
|
// a unique identifier for the cached item; it can be of any length and contain any
|
||
|
|
// characters, but must be unique to prevent duplication in the cache.
|
||
|
|
bool SaveBd(const char *key, const char *expiration, const char *etag, CkBinData &bd);
|
||
|
|
|
||
|
|
|
||
|
|
// Inserts or replaces an text item in the cache. 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. 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.)
|
||
|
|
bool SaveTextDt(const char *key, CkDateTime &expireDateTime, const char *eTag, const char *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.
|
||
|
|
bool SaveTextNoExpire(const char *key, const char *eTag, const char *itemTextData);
|
||
|
|
|
||
|
|
|
||
|
|
// The same as SaveText, except the expire date/time is passed as a string in
|
||
|
|
// RFC822 format.
|
||
|
|
bool SaveTextStr(const char *key, const char *expireDateTime, const char *eTag, const char *itemTextData);
|
||
|
|
|
||
|
|
|
||
|
|
// Inserts or replaces an item in the cache. 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. (Chilkat.Http when caching a page, writes the
|
||
|
|
// eTag (entity-tag) from the HTTP response header to this field.)
|
||
|
|
//
|
||
|
|
// 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.)
|
||
|
|
//
|
||
|
|
bool SaveToCacheDt(const char *key, CkDateTime &expireDateTime, const char *eTag, CkByteData &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.
|
||
|
|
bool SaveToCacheNoExpire(const char *key, const char *eTag, CkByteData &itemData);
|
||
|
|
|
||
|
|
|
||
|
|
// The same as SaveToCache, except the expire date/time is passed in RFC822 string
|
||
|
|
// format.
|
||
|
|
bool SaveToCacheStr(const char *key, const char *expireDateTime, const char *eTag, CkByteData &itemData);
|
||
|
|
|
||
|
|
|
||
|
|
// Updates the expire date/time for a cached item.
|
||
|
|
bool UpdateExpirationDt(const char *key, CkDateTime &expireDateTime);
|
||
|
|
|
||
|
|
|
||
|
|
// The same as UpdateExpiration, except the expireDateTime is passed in RFC822 string format.
|
||
|
|
bool UpdateExpirationStr(const char *key, const char *expireDateTime);
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
// END PUBLIC INTERFACE
|
||
|
|
|
||
|
|
|
||
|
|
};
|
||
|
|
#if !defined(__sun__) && !defined(__sun)
|
||
|
|
#pragma pack (pop)
|
||
|
|
#endif
|
||
|
|
|
||
|
|
#endif
|