CacheMgr.h

// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License.  You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.  See the License for the
// specific language governing permissions and limitations
// under the License.

#pragma once

#include "Cache.h"
#include "metrics/Metrics.h"
#include "utils/Log.h"

#include <memory>
#include <string>

namespace milvus {
namespace cache {

template <typename ItemObj>
class CacheMgr {
 public:
    virtual uint64_t
    ItemCount() const;

    virtual bool
    ItemExists(const std::string& key);

    virtual ItemObj
    GetItem(const std::string& key);

    virtual void
    InsertItem(const std::string& key, const ItemObj& data);

    virtual void
    EraseItem(const std::string& key);

    virtual void
    PrintInfo();

    virtual void
    ClearCache();

    int64_t
    CacheUsage() const;
    int64_t
    CacheCapacity() const;
    void
    SetCapacity(int64_t capacity);

 protected:
    CacheMgr();
    virtual ~CacheMgr();

 protected:
    using CachePtr = std::shared_ptr<Cache<ItemObj>>;
    CachePtr cache_;
};

}  // namespace cache
}  // namespace milvus

#include "cache/CacheMgr.inl"