DefaultCache.h

/*
 * Copyright (C) 2019-2024 HERE Europe B.V.
 *
 * Licensed 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.
 *
 * SPDX-License-Identifier: Apache-2.0
 * License-Filename: LICENSE
 */
 
#pragma once
 
#include <memory>
#include <mutex>
#include <string>
 
#include <olp/core/Config.h>
#include "CacheSettings.h"
#include "KeyValueCache.h"
 
#ifdef OLP_SDK_ENABLE_DEFAULT_CACHE
 
namespace olp {
namespace cache {
 
class DefaultCacheImpl;
 
class CORE_API DefaultCache : public KeyValueCache {
 public:
  enum StorageOpenResult {
    Success,                 
    OpenDiskPathFailure,     
    ProtectedCacheCorrupted, 
    NotReady                 
  };
 
  enum class CacheType {
    kMutable,  
    kProtected 
  };
 
  explicit DefaultCache(CacheSettings settings = {});
  ~DefaultCache() override;
 
  StorageOpenResult Open();
 
  StorageOpenResult Open(CacheType type);
 
  void Close();
 
  bool Close(CacheType type);
 
  bool Clear();
 
  void Compact();
 
  bool Put(const std::string& key, const olp::porting::any& value,
           const Encoder& encoder, time_t expiry) override;
 
  bool Put(const std::string& key, const KeyValueCache::ValueTypePtr value,
           time_t expiry) override;
 
  olp::porting::any Get(const std::string& key,
                        const Decoder& decoder) override;
 
  KeyValueCache::ValueTypePtr Get(const std::string& key) override;
 
  bool Remove(const std::string& key) override;
 
  bool RemoveKeysWithPrefix(const std::string& prefix) override;
 
  bool Contains(const std::string& key) const override;
 
  bool Protect(const KeyValueCache::KeyListType& keys) override;
 
  bool Release(const KeyValueCache::KeyListType& keys) override;
 
  bool IsProtected(const std::string& key) const override;
 
  void Promote(const std::string& key) override;
 
  OperationOutcome<ValueTypePtr> Read(const std::string& key) override;
 
  OperationOutcomeEmpty Write(const std::string& key, const ValueTypePtr& value,
                              time_t expiry) override;
 
  OperationOutcomeEmpty Delete(const std::string& key) override;
 
  OperationOutcomeEmpty DeleteByPrefix(const std::string& prefix) override;
 
  uint64_t Size(CacheType cache_type) const;
 
  uint64_t Size(uint64_t new_size);
 
 private:
  std::shared_ptr<DefaultCacheImpl> impl_;
};
 
}  // namespace cache
}  // namespace olp
 
#endif  // OLP_SDK_ENABLE_DEFAULT_CACHE