From 4b2c2e9bb88599d749385cd6f61763db1e59dc8b Mon Sep 17 00:00:00 2001
From: Mykhailo Kuchma <ext-mykhailo.kuchma@here.com>
Date: Thu, 14 May 2020 11:13:25 +0300
Subject: [PATCH] Add default_cache_expiration to OlpClientSettings (#834)
This value is propagated to cache when something is stored by client.
Resolves: OLPEDGE-1914
Signed-off-by: Mykhailo Kuchma <ext-mykhailo.kuchma@here.com>
---
.../include/olp/core/client/OlpClientSettings.h | 14 ++++++++++++++
1 file changed, 14 insertions(+)
diff --git a/olp-cpp-sdk-core/include/olp/core/client/OlpClientSettings.h b/olp-cpp-sdk-core/include/olp/core/client/OlpClientSettings.h
index 470c79f1b..0fa40c199 100644
--- a/olp-cpp-sdk-core/include/olp/core/client/OlpClientSettings.h
+++ b/olp-cpp-sdk-core/include/olp/core/client/OlpClientSettings.h
@@ -258,6 +258,20 @@ struct CORE_API OlpClientSettings {
* To only use the memory LRU cache with limited size, set to `nullptr`.
*/
std::shared_ptr<cache::KeyValueCache> cache = nullptr;
+
+ /**
+ * @brief Set default expiration for any cache entry made by the according
+ * layer or catalog client.
+ *
+ * This setting only applies to the mutable cache and to the in-memory cache,
+ * but should not affect the protected cache as no entries are added to the
+ * protected cache in read-only mode. Set to std::chrono::seconds::max() to
+ * disable expiration. By default expiration is disabled.
+ *
+ * @note This only makes sense for data that has an expiration limit, e.g.
+ * volatile or versioned, and which is stored in cache.
+ */
+ std::chrono::seconds default_cache_expiration = std::chrono::seconds::max();
};
} // namespace client