SubCachePlugin.h

Go to the documentation of this file.

 
#pragma once
#include "catapult/types.h"
#include <memory>
#include <string>
 
namespace catapult {
    namespace cache {
        class CacheChangesStorage;
        class CacheStorage;
        class CatapultCache;
    }
}
 
namespace catapult { namespace cache {
 
    // region SubCacheViewIdentifier
 
    enum class SubCacheViewType {
        View,
 
        Delta,
 
        DetachedDelta
    };
 
    struct SubCacheViewIdentifier {
        std::array<char, 16> CacheName;
 
        size_t CacheId;
 
        SubCacheViewType ViewType;
    };
 
    // endregion
 
    // region SubCacheView / DetachedSubCacheView
 
    class SubCacheView {
    public:
        virtual ~SubCacheView() = default;
 
    public:
        virtual const SubCacheViewIdentifier& id() const = 0;
 
        virtual const void* get() const = 0;
 
        virtual void* get() = 0;
 
        virtual bool supportsMerkleRoot() const = 0;
 
        virtual bool tryGetMerkleRoot(Hash256& merkleRoot) const = 0;
 
        virtual bool trySetMerkleRoot(const Hash256& merkleRoot) = 0;
 
        virtual void updateMerkleRoot(Height height) = 0;
 
        virtual const void* asReadOnly() const = 0;
    };
 
    class DetachedSubCacheView {
    public:
        virtual ~DetachedSubCacheView() = default;
 
    public:
        virtual std::unique_ptr<SubCacheView> tryLock() = 0;
    };
 
    // endregion
 
    // region SubCachePlugin
 
    class SubCachePlugin {
    public:
        virtual ~SubCachePlugin() = default;
 
    public:
        virtual const std::string& name() const = 0;
 
        virtual size_t id() const = 0;
 
    public:
        virtual std::unique_ptr<const SubCacheView> createView() const = 0;
 
        virtual std::unique_ptr<SubCacheView> createDelta() = 0;
 
        virtual std::unique_ptr<DetachedSubCacheView> createDetachedDelta() const = 0;
 
        virtual void commit() = 0;
 
    public:
        virtual const void* get() const = 0;
 
    public:
        virtual std::unique_ptr<CacheStorage> createStorage() = 0;
 
        virtual std::unique_ptr<CacheChangesStorage> createChangesStorage() const = 0;
    };
 
    // endregion
}}