Cache.h

/*
  COPYRIGHT (c) 2012-2024 Esri R&D Center Zurich
  TRADE SECRETS: ESRI PROPRIETARY AND CONFIDENTIAL
  Unpublished material - all rights reserved under the
  Copyright Laws of the United States and applicable international
  laws, treaties, and conventions.

  For additional information, contact:
  Environmental Systems Research Institute, Inc.
  Attn: Contracts and Legal Services Department
  380 New York Street
  Redlands, California, 92373
  USA

  email: contracts@esri.com
*/

#ifndef PRT_CACHE_H_
#define PRT_CACHE_H_

#include "prt/Object.h"
#include "prt/ContentType.h"


namespace prt {

class PRT_EXPORTS_API Cache {
public:
    enum PersistentBlobType {
        CACHE_TYPE_IMAGE_METADATA,
        CACHE_TYPE_PIXELDATA
    };

    virtual const void* insertAndGetTransientBlob(ContentType type, const wchar_t* key, const void* ptr) = 0;

    virtual const void* getTransientBlob(ContentType type, const wchar_t* key) const = 0;

    virtual void releaseTransientBlob(ContentType type, const wchar_t* key) = 0;

    virtual bool tryLockPersistentBlobs(ContentType type, const wchar_t* key) = 0;

    virtual void insertPersistentBlobAndLock(PersistentBlobType type, const wchar_t* key, const void* data, size_t size) = 0;

    virtual const void* getPersistentBlob(PersistentBlobType type, const wchar_t* key, size_t* size) const = 0;

    virtual void releasePersistentBlob(PersistentBlobType type, const wchar_t* key) = 0;

    virtual void unlockPersistentBlob(PersistentBlobType type, const wchar_t* key) = 0;

    virtual void flushAll() = 0;

    virtual void flushContentType(ContentType type) = 0;

    virtual void flushEntry(ContentType type, const wchar_t* key) = 0;

protected:
    static void deleteTransientBlob(const void *ptr);

protected:
    Cache();
    virtual ~Cache();
};

class PRT_EXPORTS_API CacheObject : public Object, public Cache {
public:
    enum CacheType {
        CACHE_TYPE_DEFAULT,         
        CACHE_TYPE_NONREDUNDANT,    
        CACHE_TYPE_COUNT            
    };
    static CacheObject* create(CacheType type);
};

} // namespace prt

#endif /* PRT_CACHE_H_ */