CacheSettings.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 <cstdint>
#include <string>
 
#include <olp/core/Config.h>
#include <olp/core/CoreApi.h>
#include <olp/core/porting/optional.h>
 
namespace olp {
namespace cache {
 
#ifdef OLP_SDK_ENABLE_DEFAULT_CACHE
 
enum OpenOptions : unsigned char {
  Default = 0x00,  
  ReadOnly = 0x01, 
  CheckCrc = 0x02  
};
 
enum class EvictionPolicy : unsigned char {
  kNone,             
  kLeastRecentlyUsed 
};
 
enum class CompressionType {
  kNoCompression,     
  kDefaultCompression 
};
 
struct CORE_API CacheSettings {
  porting::optional<std::string> disk_path_mutable = porting::none;
 
  std::uint64_t max_disk_storage = 1024ull * 1024ull * 32ull;
 
  size_t max_chunk_size = 1024u * 1024u * 32u;
 
  bool enforce_immediate_flush = true;
 
  size_t max_file_size = 1024u * 1024u * 2u;
 
  size_t max_memory_cache_size = 1024u * 1024u;
 
  OpenOptions openOptions = OpenOptions::Default;
 
  EvictionPolicy eviction_policy = EvictionPolicy::kLeastRecentlyUsed;
 
  CompressionType compression = CompressionType::kDefaultCompression;
 
  porting::optional<std::string> disk_path_protected = porting::none;
 
  bool extend_permissions = false;
};
 
#else
 
struct CORE_API CacheSettings {};
 
#endif  // OLP_SDK_ENABLE_DEFAULT_CACHE
 
}  // namespace cache
}  // namespace olp