117template <
typename K,
typename V,
typename M = std::
string>
124 typedef std::unique_ptr<PersistentCache<K, V, M>>
UPtr;
266 std::chrono::time_point<std::chrono::system_clock> expiry_time = std::chrono::system_clock::time_point());
275 std::chrono::time_point<std::chrono::system_clock> expiry_time = std::chrono::system_clock::time_point());
321 template <typename It>
339 std::chrono::time_point<std::chrono::system_clock> expiry_time = std::chrono::system_clock::time_point());
393template <typename K, typename V, typename M>
401template <
typename K,
typename V,
typename M>
407template <
typename K,
typename V,
typename M>
409 int64_t max_size_in_bytes,
415template <
typename K,
typename V,
typename M>
421template <
typename K,
typename V,
typename M>
428template <
typename K,
typename V,
typename M>
434 return OptionalData();
439template <
typename K,
typename V,
typename M>
446template <
typename K,
typename V,
typename M>
452template <
typename K,
typename V,
typename M>
458template <
typename K,
typename V,
typename M>
461 return p_->size_in_bytes();
464template <
typename K,
typename V,
typename M>
467 return p_->max_size_in_bytes();
470template <
typename K,
typename V,
typename M>
473 return p_->disk_size_in_bytes();
476template <
typename K,
typename V,
typename M>
479 return p_->discard_policy();
482template <
typename K,
typename V,
typename M>
488template <
typename K,
typename V,
typename M>
491 std::chrono::time_point<std::chrono::system_clock> expiry_time)
496template <
typename K,
typename V,
typename M>
500 std::chrono::time_point<std::chrono::system_clock> expiry_time)
506template <
typename K,
typename V,
typename M>
511 auto sload_func = [&](std::string
const&, PersistentStringCache
const&)
513 load_func(key, *
this);
515 auto svalue = p_->get_or_put(skey, sload_func);
519template <
typename K,
typename V,
typename M>
524 auto sload_func = [&](std::string
const&, PersistentStringCache
const&)
526 load_func(key, *
this);
528 auto sdata = p_->get_or_put_data(skey, sload_func);
531 return OptionalData();
536template <
typename K,
typename V,
typename M>
542template <
typename K,
typename V,
typename M>
549template <
typename K,
typename V,
typename M>
555 return OptionalData();
560template <
typename K,
typename V,
typename M>
566template <
typename K,
typename V,
typename M>
572template <
typename K,
typename V,
typename M>
573template <
typename It>
576 std::vector<std::string> skeys;
577 for (
auto&& it = begin; it < end; ++it)
581 p_->invalidate(skeys.begin(), skeys.end());
584template <
typename K,
typename V,
typename M>
590template <
typename K,
typename V,
typename M>
596template <
typename K,
typename V,
typename M>
602template <
typename K,
typename V,
typename M>
608template <
typename K,
typename V,
typename M>
611 p_->resize(size_in_bytes);
614template <
typename K,
typename V,
typename M>
617 p_->trim_to(used_size_in_bytes);
620template <
typename K,
typename V,
typename M>
626template <
typename K,
typename V,
typename M>
629 auto scb = [cb](std::string
const& key,
CacheEvent ev, PersistentCacheStats
const& c)
633 p_->set_handler(events, scb);
648template <
typename V,
typename M>
649class PersistentCache<std::string, V, M>
652 typedef std::unique_ptr<PersistentCache<std::string, V, M>>
UPtr;
674 static UPtr open(std::string
const& cache_path);
680 int64_t
size() const noexcept;
685 PersistentCacheStats
stats() const;
687 bool put(std::
string const& key,
689 std::chrono::time_point<std::chrono::system_clock> expiry_time = std::chrono::system_clock::time_point());
690 bool put(std::
string const& key,
693 std::chrono::time_point<std::chrono::system_clock> expiry_time = std::chrono::system_clock::time_point());
695 typedef std::function<
void(std::
string const& key, PersistentCache<std::
string, V, M>& cache)>
Loader;
700 bool put_metadata(std::
string const& key, M const& metadata);
704 void invalidate(std::vector<std::
string> const& keys);
705 template <typename It>
707 void invalidate(std::initializer_list<std::
string> const& keys);
710 std::
string const& key,
711 std::chrono::time_point<std::chrono::system_clock> expiry_time = std::chrono::system_clock::time_point());
714 void trim_to(int64_t used_size_in_bytes);
723 PersistentCache(std::
string const& cache_path);
725 std::unique_ptr<PersistentStringCache> p_;
728template <typename V, typename M>
729PersistentCache<std::
string, V, M>::PersistentCache(std::
string const& cache_path,
736template <
typename V,
typename M>
738 : p_(PersistentStringCache::
open(cache_path))
742template <
typename V,
typename M>
747 new PersistentCache<std::string, V, M>(cache_path, max_size_in_bytes, policy));
750template <
typename V,
typename M>
752 std::string
const& cache_path)
757template <
typename V,
typename M>
759 std::string
const& key)
const
761 auto const& svalue = p_->get(key);
765template <
typename V,
typename M>
767 std::string
const& key)
const
769 auto sdata = p_->get_data(key);
772 return OptionalData();
777template <
typename V,
typename M>
779 std::string
const& key)
const
781 auto smeta = p_->get_metadata(key);
785template <
typename V,
typename M>
788 return p_->contains_key(key);
791template <
typename V,
typename M>
797template <
typename V,
typename M>
800 return p_->size_in_bytes();
803template <
typename V,
typename M>
806 return p_->max_size_in_bytes();
809template <
typename V,
typename M>
812 return p_->disk_size_in_bytes();
815template <
typename V,
typename M>
818 return p_->discard_policy();
821template <
typename V,
typename M>
827template <
typename V,
typename M>
830 std::chrono::time_point<std::chrono::system_clock> expiry_time)
835template <
typename V,
typename M>
839 std::chrono::time_point<std::chrono::system_clock> expiry_time)
844template <
typename V,
typename M>
848 auto sload_func = [&](std::string
const&, PersistentStringCache
const&)
850 load_func(key, *
this);
852 auto svalue = p_->get_or_put(key, sload_func);
856template <
typename V,
typename M>
860 auto sload_func = [&](std::string
const&, PersistentStringCache
const&)
862 load_func(key, *
this);
864 auto sdata = p_->get_or_put_data(key, sload_func);
867 return OptionalData();
872template <
typename V,
typename M>
878template <
typename V,
typename M>
880 std::string
const& key)
882 auto svalue = p_->take(key);
886template <
typename V,
typename M>
888 std::string
const& key)
890 auto sdata = p_->take_data(key);
893 return OptionalData();
898template <
typename V,
typename M>
901 return p_->invalidate(key);
904template <
typename V,
typename M>
910template <
typename V,
typename M>
911template <
typename It>
914 std::vector<std::string> skeys;
915 for (
auto&& it = begin; it < end; ++it)
917 skeys.push_back(*it);
919 p_->invalidate(skeys.begin(), skeys.end());
922template <
typename V,
typename M>
928template <
typename V,
typename M>
934template <
typename V,
typename M>
936 std::chrono::time_point<std::chrono::system_clock> expiry_time)
938 return p_->touch(key, expiry_time);
941template <
typename V,
typename M>
947template <
typename V,
typename M>
950 p_->resize(size_in_bytes);
953template <
typename V,
typename M>
956 p_->trim_to(used_size_in_bytes);
959template <
typename V,
typename M>
965template <
typename V,
typename M>
968 p_->set_handler(events, cb);
973template <
typename K,
typename M>
974class PersistentCache<K, std::string, M>
977 typedef std::unique_ptr<PersistentCache<K, std::string, M>>
UPtr;
999 static UPtr open(std::string
const& cache_path);
1005 int64_t
size() const noexcept;
1010 PersistentCacheStats
stats() const;
1012 bool put(K const& key,
1013 std::
string const& value,
1014 std::chrono::time_point<std::chrono::system_clock> expiry_time = std::chrono::system_clock::time_point());
1015 bool put(K const& key,
1018 std::chrono::time_point<std::chrono::system_clock> expiry_time = std::chrono::system_clock::time_point());
1019 bool put(K const& key,
1020 std::
string const& value,
1022 std::chrono::time_point<std::chrono::system_clock> expiry_time = std::chrono::system_clock::time_point());
1023 bool put(K const& key,
1027 std::chrono::time_point<std::chrono::system_clock> expiry_time = std::chrono::system_clock::time_point());
1029 typedef std::function<
void(K const& key, PersistentCache<K, std::
string, M>& cache)>
Loader;
1039 template <typename It>
1041 void invalidate(std::initializer_list<K> const& keys);
1045 std::chrono::time_point<std::chrono::system_clock> expiry_time = std::chrono::system_clock::time_point());
1048 void trim_to(int64_t used_size_in_bytes);
1057 PersistentCache(std::
string const& cache_path);
1059 std::unique_ptr<PersistentStringCache> p_;
1062template <typename K, typename M>
1063PersistentCache<K, std::
string, M>::PersistentCache(std::
string const& cache_path,
1070template <
typename K,
typename M>
1072 : p_(PersistentStringCache::
open(cache_path))
1076template <
typename K,
typename M>
1081 new PersistentCache<K, std::string, M>(cache_path, max_size_in_bytes, policy));
1084template <
typename K,
typename M>
1086 std::string
const& cache_path)
1091template <
typename K,
typename M>
1095 return svalue ? OptionalValue(*svalue) : OptionalValue();
1098template <
typename K,
typename M>
1105 return OptionalData();
1110template <
typename K,
typename M>
1118template <
typename K,
typename M>
1124template <
typename K,
typename M>
1130template <
typename K,
typename M>
1133 return p_->size_in_bytes();
1136template <
typename K,
typename M>
1139 return p_->max_size_in_bytes();
1142template <
typename K,
typename M>
1145 return p_->disk_size_in_bytes();
1148template <
typename K,
typename M>
1151 return p_->discard_policy();
1154template <
typename K,
typename M>
1160template <
typename K,
typename M>
1162 std::string
const& value,
1163 std::chrono::time_point<std::chrono::system_clock> expiry_time)
1168template <
typename K,
typename M>
1172 std::chrono::time_point<std::chrono::system_clock> expiry_time)
1177template <
typename K,
typename M>
1179 std::string
const& value,
1181 std::chrono::time_point<std::chrono::system_clock> expiry_time)
1186template <
typename K,
typename M>
1191 std::chrono::time_point<std::chrono::system_clock> expiry_time)
1197template <
typename K,
typename M>
1202 auto sload_func = [&](std::string
const&, PersistentStringCache
const&)
1204 load_func(key, *
this);
1206 auto svalue = p_->get_or_put(skey, sload_func);
1207 return svalue ? OptionalValue(*svalue) : OptionalValue();
1210template <
typename K,
typename M>
1215 auto sload_func = [&](std::string
const&, PersistentStringCache
const&)
1217 load_func(key, *
this);
1219 auto sdata = p_->get_or_put_data(skey, sload_func);
1222 return OptionalData();
1227template <
typename K,
typename M>
1233template <
typename K,
typename M>
1237 return svalue ? OptionalValue(*svalue) : OptionalValue();
1240template <
typename K,
typename M>
1247 return OptionalData();
1252template <
typename K,
typename M>
1258template <
typename K,
typename M>
1264template <
typename K,
typename M>
1265template <
typename It>
1268 std::vector<std::string> skeys;
1269 for (
auto&& it = begin; it < end; ++it)
1273 p_->invalidate(skeys.begin(), skeys.end());
1276template <
typename K,
typename M>
1282template <
typename K,
typename M>
1288template <
typename K,
typename M>
1290 std::chrono::time_point<std::chrono::system_clock> expiry_time)
1295template <
typename K,
typename M>
1301template <
typename K,
typename M>
1304 p_->resize(size_in_bytes);
1307template <
typename K,
typename M>
1310 p_->trim_to(used_size_in_bytes);
1313template <
typename K,
typename M>
1319template <
typename K,
typename M>
1322 auto scb = [cb](std::string
const& key,
CacheEvent ev, PersistentCacheStats
const& c)
1326 p_->set_handler(events, scb);
1331template <
typename K,
typename V>
1332class PersistentCache<K, V, std::string>
1335 typedef std::unique_ptr<PersistentCache<K, V, std::string>>
UPtr;
1357 static UPtr open(std::string
const& cache_path);
1363 int64_t
size() const noexcept;
1368 PersistentCacheStats
stats() const;
1370 bool put(K const& key,
1372 std::chrono::time_point<std::chrono::system_clock> expiry_time = std::chrono::system_clock::time_point());
1373 bool put(K const& key,
1375 std::
string const& metadata,
1376 std::chrono::time_point<std::chrono::system_clock> expiry_time = std::chrono::system_clock::time_point());
1377 bool put(K const& key,
1379 char const* metadata,
1381 std::chrono::time_point<std::chrono::system_clock> expiry_time = std::chrono::system_clock::time_point());
1383 typedef std::function<
void(K const& key, PersistentCache<K, V, std::
string>& cache)>
Loader;
1388 bool put_metadata(K const& key, std::
string const& metadata);
1394 template <typename It>
1396 void invalidate(std::initializer_list<K> const& keys);
1400 std::chrono::time_point<std::chrono::system_clock> expiry_time = std::chrono::system_clock::time_point());
1403 void trim_to(int64_t used_size_in_bytes);
1412 PersistentCache(std::
string const& cache_path);
1414 std::unique_ptr<PersistentStringCache> p_;
1417template <typename K, typename V>
1418PersistentCache<K, V, std::
string>::PersistentCache(std::
string const& cache_path,
1425template <
typename K,
typename V>
1427 : p_(PersistentStringCache::
open(cache_path))
1431template <
typename K,
typename V>
1436 new PersistentCache<K, V, std::string>(cache_path, max_size_in_bytes, policy));
1439template <
typename K,
typename V>
1441 std::string
const& cache_path)
1446template <
typename K,
typename V>
1453template <
typename K,
typename V>
1460 return OptionalData();
1465template <
typename K,
typename V>
1470 return smeta ? OptionalMetadata(*smeta) : OptionalMetadata();
1473template <
typename K,
typename V>
1479template <
typename K,
typename V>
1485template <
typename K,
typename V>
1488 return p_->size_in_bytes();
1491template <
typename K,
typename V>
1494 return p_->max_size_in_bytes();
1497template <
typename K,
typename V>
1500 return p_->disk_size_in_bytes();
1503template <
typename K,
typename V>
1506 return p_->discard_policy();
1509template <
typename K,
typename V>
1515template <
typename K,
typename V>
1518 std::chrono::time_point<std::chrono::system_clock> expiry_time)
1523template <
typename K,
typename V>
1526 std::string
const& metadata,
1527 std::chrono::time_point<std::chrono::system_clock> expiry_time)
1530 return p_->put(
CacheCodec<K>::encode(key), v.data(), v.size(), metadata.data(), metadata.size(), expiry_time);
1533template <
typename K,
typename V>
1536 char const* metadata,
1538 std::chrono::time_point<std::chrono::system_clock> expiry_time)
1544template <
typename K,
typename V>
1549 auto sload_func = [&](std::string
const&, PersistentStringCache
const&)
1551 load_func(key, *
this);
1553 auto svalue = p_->get_or_put(skey, sload_func);
1557template <
typename K,
typename V>
1562 auto sload_func = [&](std::string
const&, PersistentStringCache
const&)
1564 load_func(key, *
this);
1566 auto sdata = p_->get_or_put_data(skey, sload_func);
1569 return OptionalData();
1574template <
typename K,
typename V>
1580template <
typename K,
typename V>
1586template <
typename K,
typename V>
1593template <
typename K,
typename V>
1600 return OptionalData();
1605template <
typename K,
typename V>
1611template <
typename K,
typename V>
1617template <
typename K,
typename V>
1618template <
typename It>
1621 std::vector<std::string> skeys;
1622 for (
auto&& it = begin; it < end; ++it)
1626 p_->invalidate(skeys.begin(), skeys.end());
1629template <
typename K,
typename V>
1635template <
typename K,
typename V>
1641template <
typename K,
typename V>
1643 std::chrono::time_point<std::chrono::system_clock> expiry_time)
1648template <
typename K,
typename V>
1654template <
typename K,
typename V>
1657 p_->resize(size_in_bytes);
1660template <
typename K,
typename V>
1663 p_->trim_to(used_size_in_bytes);
1666template <
typename K,
typename V>
1672template <
typename K,
typename V>
1675 auto scb = [cb](std::string
const& key,
CacheEvent ev, PersistentCacheStats
const& c)
1679 p_->set_handler(events, scb);
1684template <
typename M>
1685class PersistentCache<std::string, std::string, M>
1688 typedef std::unique_ptr<PersistentCache<std::string, std::string, M>>
UPtr;
1710 static UPtr open(std::string
const& cache_path);
1716 int64_t
size() const noexcept;
1721 PersistentCacheStats
stats() const;
1723 bool put(std::
string const& key,
1724 std::
string const& value,
1725 std::chrono::time_point<std::chrono::system_clock> expiry_time = std::chrono::system_clock::time_point());
1726 bool put(std::
string const& key,
1729 std::chrono::time_point<std::chrono::system_clock> expiry_time = std::chrono::system_clock::time_point());
1730 bool put(std::
string const& key,
1731 std::
string const& value,
1733 std::chrono::time_point<std::chrono::system_clock> expiry_time = std::chrono::system_clock::time_point());
1734 bool put(std::
string const& key,
1738 std::chrono::time_point<std::chrono::system_clock> expiry_time = std::chrono::system_clock::time_point());
1740 typedef std::function<
void(std::
string const& key, PersistentCache<std::
string, std::
string, M>& cache)>
Loader;
1745 bool put_metadata(std::
string const& key, M const& metadata);
1749 void invalidate(std::vector<std::
string> const& keys);
1750 template <typename It>
1752 void invalidate(std::initializer_list<std::
string> const& keys);
1755 std::
string const& key,
1756 std::chrono::time_point<std::chrono::system_clock> expiry_time = std::chrono::system_clock::time_point());
1759 void trim_to(int64_t used_size_in_bytes);
1768 PersistentCache(std::
string const& cache_path);
1770 std::unique_ptr<PersistentStringCache> p_;
1773template <typename M>
1774PersistentCache<std::
string, std::
string, M>::PersistentCache(std::
string const& cache_path,
1781template <
typename M>
1783 : p_(PersistentStringCache::
open(cache_path))
1787template <
typename M>
1792 new PersistentCache<std::string, std::string, M>(cache_path, max_size_in_bytes, policy));
1795template <
typename M>
1797 std::string
const& cache_path)
1800 new PersistentCache<std::string, std::string, M>(cache_path));
1803template <
typename M>
1805 std::string
const& key)
const
1807 auto const& svalue = p_->get(key);
1808 return svalue ? OptionalValue(*svalue) : OptionalValue();
1811template <
typename M>
1815 auto sdata = p_->get_data(key);
1818 return OptionalData();
1823template <
typename M>
1827 auto smeta = p_->get_metadata(key);
1831template <
typename M>
1834 return p_->contains_key(key);
1837template <
typename M>
1843template <
typename M>
1846 return p_->size_in_bytes();
1849template <
typename M>
1852 return p_->max_size_in_bytes();
1855template <
typename M>
1858 return p_->disk_size_in_bytes();
1861template <
typename M>
1864 return p_->discard_policy();
1867template <
typename M>
1873template <
typename M>
1875 std::string
const& value,
1876 std::chrono::time_point<std::chrono::system_clock> expiry_time)
1878 return p_->put(key, value, expiry_time);
1881template <
typename M>
1885 std::chrono::time_point<std::chrono::system_clock> expiry_time)
1887 return p_->put(key, value, size,
nullptr, 0, expiry_time);
1890template <
typename M>
1892 std::string
const& value,
1894 std::chrono::time_point<std::chrono::system_clock> expiry_time)
1899template <
typename M>
1904 std::chrono::time_point<std::chrono::system_clock> expiry_time)
1907 return p_->put(key, value, size, md.data(), md.size(), expiry_time);
1910template <
typename M>
1915 auto sload_func = [&](std::string
const&, PersistentStringCache
const&)
1917 load_func(key, *
this);
1919 auto svalue = p_->get_or_put(key, sload_func);
1920 return svalue ? OptionalValue(*svalue) : OptionalValue();
1923template <
typename M>
1928 auto sload_func = [&](std::string
const&, PersistentStringCache
const&)
1930 load_func(key, *
this);
1932 auto sdata = p_->get_or_put_data(key, sload_func);
1935 return OptionalData();
1940template <
typename M>
1946template <
typename M>
1948 std::string
const& key)
1950 auto svalue = p_->take(key);
1951 return svalue ? OptionalValue(*svalue) : OptionalValue();
1954template <
typename M>
1958 auto sdata = p_->take_data(key);
1961 return OptionalData();
1966template <
typename M>
1969 return p_->invalidate(key);
1972template <
typename M>
1978template <
typename M>
1979template <
typename It>
1982 std::vector<std::string> skeys;
1983 for (
auto&& it = begin; it < end; ++it)
1985 skeys.push_back(*it);
1987 p_->invalidate(skeys.begin(), skeys.end());
1990template <
typename M>
1996template <
typename M>
2002template <
typename M>
2004 std::chrono::time_point<std::chrono::system_clock> expiry_time)
2006 return p_->touch(key, expiry_time);
2009template <
typename M>
2015template <
typename M>
2018 p_->resize(size_in_bytes);
2021template <
typename M>
2024 p_->trim_to(used_size_in_bytes);
2027template <
typename M>
2033template <
typename M>
2036 p_->set_handler(events, cb);
2041template <
typename V>
2042class PersistentCache<std::string, V, std::string>
2045 typedef std::unique_ptr<PersistentCache<std::string, V, std::string>>
UPtr;
2067 static UPtr open(std::string
const& cache_path);
2073 int64_t
size() const noexcept;
2078 PersistentCacheStats
stats() const;
2080 bool put(std::
string const& key,
2082 std::chrono::time_point<std::chrono::system_clock> expiry_time = std::chrono::system_clock::time_point());
2083 bool put(std::
string const& key,
2085 std::
string const& metadata,
2086 std::chrono::time_point<std::chrono::system_clock> expiry_time = std::chrono::system_clock::time_point());
2087 bool put(std::
string const& key,
2089 char const* metadata,
2091 std::chrono::time_point<std::chrono::system_clock> expiry_time = std::chrono::system_clock::time_point());
2093 typedef std::function<
void(std::
string const& key, PersistentCache<std::
string, V, std::
string>& cache)>
Loader;
2098 bool put_metadata(std::
string const& key, std::
string const& metadata);
2099 bool put_metadata(std::
string const& key,
char const* metadata, int64_t
size);
2103 void invalidate(std::vector<std::
string> const& keys);
2104 template <typename It>
2106 void invalidate(std::initializer_list<std::
string> const& keys);
2109 std::
string const& key,
2110 std::chrono::time_point<std::chrono::system_clock> expiry_time = std::chrono::system_clock::time_point());
2113 void trim_to(int64_t used_size_in_bytes);
2122 PersistentCache(std::
string const& cache_path);
2124 std::unique_ptr<PersistentStringCache> p_;
2127template <typename V>
2128PersistentCache<std::
string, V, std::
string>::PersistentCache(std::
string const& cache_path,
2135template <
typename V>
2137 : p_(PersistentStringCache::
open(cache_path))
2141template <
typename V>
2146 new PersistentCache<std::string, V, std::string>(cache_path, max_size_in_bytes, policy));
2149template <
typename V>
2151 std::string
const& cache_path)
2154 new PersistentCache<std::string, V, std::string>(cache_path));
2157template <
typename V>
2159 std::string
const& key)
const
2161 auto const& svalue = p_->get(key);
2165template <
typename V>
2169 auto sdata = p_->get_data(key);
2172 return OptionalData();
2177template <
typename V>
2181 auto smeta = p_->get_metadata(key);
2182 return smeta ? OptionalMetadata(*smeta) : OptionalMetadata();
2185template <
typename V>
2188 return p_->contains_key(key);
2191template <
typename V>
2197template <
typename V>
2200 return p_->size_in_bytes();
2203template <
typename V>
2206 return p_->max_size_in_bytes();
2209template <
typename V>
2212 return p_->disk_size_in_bytes();
2215template <
typename V>
2218 return p_->discard_policy();
2221template <
typename V>
2227template <
typename V>
2230 std::chrono::time_point<std::chrono::system_clock> expiry_time)
2235template <
typename V>
2238 std::string
const& metadata,
2239 std::chrono::time_point<std::chrono::system_clock> expiry_time)
2242 return p_->put(key, v.data(), v.size(), metadata.data(), metadata.size(), expiry_time);
2245template <
typename V>
2248 char const* metadata,
2250 std::chrono::time_point<std::chrono::system_clock> expiry_time)
2253 return p_->put(key, v.data(), v.size(), metadata, size, expiry_time);
2256template <
typename V>
2261 auto sload_func = [&](std::string
const&, PersistentStringCache
const&)
2263 load_func(key, *
this);
2265 auto svalue = p_->get_or_put(key, sload_func);
2269template <
typename V>
2274 auto sload_func = [&](std::string
const&, PersistentStringCache
const&)
2276 load_func(key, *
this);
2278 auto sdata = p_->get_or_put_data(key, sload_func);
2281 return OptionalData();
2286template <
typename V>
2289 return p_->put_metadata(key, metadata);
2292template <
typename V>
2294 char const* metadata,
2297 return p_->put_metadata(key, metadata, size);
2300template <
typename V>
2302 std::string
const& key)
2304 auto svalue = p_->take(key);
2308template <
typename V>
2312 auto sdata = p_->take_data(key);
2315 return OptionalData();
2320template <
typename V>
2323 return p_->invalidate(key);
2326template <
typename V>
2332template <
typename V>
2333template <
typename It>
2336 std::vector<std::string> skeys;
2337 for (
auto&& it = begin; it < end; ++it)
2339 skeys.push_back(*it);
2341 p_->invalidate(skeys.begin(), skeys.end());
2344template <
typename V>
2350template <
typename V>
2356template <
typename V>
2358 std::chrono::time_point<std::chrono::system_clock> expiry_time)
2360 return p_->touch(key, expiry_time);
2363template <
typename V>
2369template <
typename V>
2372 p_->resize(size_in_bytes);
2375template <
typename V>
2378 p_->trim_to(used_size_in_bytes);
2381template <
typename V>
2387template <
typename V>
2390 p_->set_handler(events, cb);
2395template <
typename K>
2396class PersistentCache<K, std::string, std::string>
2399 typedef std::unique_ptr<PersistentCache<K, std::string, std::string>>
UPtr;
2421 static UPtr open(std::string
const& cache_path);
2427 int64_t
size() const noexcept;
2432 PersistentCacheStats
stats() const;
2434 bool put(K const& key,
2435 std::
string const& value,
2436 std::chrono::time_point<std::chrono::system_clock> expiry_time = std::chrono::system_clock::time_point());
2437 bool put(K const& key,
2440 std::chrono::time_point<std::chrono::system_clock> expiry_time = std::chrono::system_clock::time_point());
2441 bool put(K const& key,
2442 std::
string const& value,
2443 std::
string const& metadata,
2444 std::chrono::time_point<std::chrono::system_clock> expiry_time = std::chrono::system_clock::time_point());
2445 bool put(K const& key,
2448 char const* metadata,
2449 int64_t metadata_size,
2450 std::chrono::time_point<std::chrono::system_clock> expiry_time = std::chrono::system_clock::time_point());
2452 typedef std::function<
void(K const& key, PersistentCache<K, std::
string, std::
string>& cache)>
Loader;
2457 bool put_metadata(K const& key, std::
string const& metadata);
2463 template <typename It>
2465 void invalidate(std::initializer_list<K> const& keys);
2469 std::chrono::time_point<std::chrono::system_clock> expiry_time = std::chrono::system_clock::time_point());
2472 void trim_to(int64_t used_size_in_bytes);
2481 PersistentCache(std::
string const& cache_path);
2483 std::unique_ptr<PersistentStringCache> p_;
2486template <typename K>
2487PersistentCache<K, std::
string, std::
string>::PersistentCache(std::
string const& cache_path,
2494template <
typename K>
2496 : p_(PersistentStringCache::
open(cache_path))
2500template <
typename K>
2505 new PersistentCache<K, std::string, std::string>(cache_path, max_size_in_bytes, policy));
2508template <
typename K>
2510 std::string
const& cache_path)
2513 new PersistentCache<K, std::string, std::string>(cache_path));
2516template <
typename K>
2521 return svalue ? OptionalValue(*svalue) : OptionalValue();
2524template <
typename K>
2531 return OptionalData();
2533 return OptionalData({sdata->value, sdata->metadata});
2536template <
typename K>
2541 return smeta ? OptionalMetadata(*smeta) : OptionalMetadata();
2544template <
typename K>
2550template <
typename K>
2556template <
typename K>
2559 return p_->size_in_bytes();
2562template <
typename K>
2565 return p_->max_size_in_bytes();
2568template <
typename K>
2571 return p_->disk_size_in_bytes();
2574template <
typename K>
2577 return p_->discard_policy();
2580template <
typename K>
2586template <
typename K>
2588 std::string
const& value,
2589 std::chrono::time_point<std::chrono::system_clock> expiry_time)
2594template <
typename K>
2598 std::chrono::time_point<std::chrono::system_clock> expiry_time)
2603template <
typename K>
2605 std::string
const& value,
2606 std::string
const& metadata,
2607 std::chrono::time_point<std::chrono::system_clock> expiry_time)
2612template <
typename K>
2616 char const* metadata,
2617 int64_t metadata_size,
2618 std::chrono::time_point<std::chrono::system_clock> expiry_time)
2620 return p_->put(
CacheCodec<K>::encode(key), value, value_size, metadata, metadata_size, expiry_time);
2623template <
typename K>
2629 auto sload_func = [&](std::string
const&, PersistentStringCache
const&)
2631 load_func(key, *
this);
2633 auto svalue = p_->get_or_put(skey, sload_func);
2634 return svalue ? OptionalValue(*svalue) : OptionalValue();
2637template <
typename K>
2643 auto sload_func = [&](std::string
const&, PersistentStringCache
const&)
2645 load_func(key, *
this);
2647 auto sdata = p_->get_or_put_data(skey, sload_func);
2650 return OptionalData();
2652 return OptionalData({sdata->value, sdata->metadata});
2655template <
typename K>
2661template <
typename K>
2667template <
typename K>
2672 return svalue ? OptionalValue(*svalue) : OptionalValue();
2675template <
typename K>
2682 return OptionalData();
2684 return OptionalData({sdata->value, sdata->metadata});
2687template <
typename K>
2693template <
typename K>
2699template <
typename K>
2700template <
typename It>
2703 std::vector<std::string> skeys;
2704 for (
auto&& it = begin; it < end; ++it)
2708 p_->invalidate(skeys.begin(), skeys.end());
2711template <
typename K>
2717template <
typename K>
2723template <
typename K>
2725 std::chrono::time_point<std::chrono::system_clock> expiry_time)
2730template <
typename K>
2736template <
typename K>
2739 p_->resize(size_in_bytes);
2742template <
typename K>
2745 p_->trim_to(used_size_in_bytes);
2748template <
typename K>
2754template <
typename K>
2757 auto scb = [cb](std::string
const& key,
CacheEvent ev, PersistentCacheStats
const& c)
2761 p_->set_handler(events, scb);
2767class PersistentCache<std::string, std::string, std::string>
2770 typedef std::unique_ptr<PersistentCache<std::string, std::string, std::string>>
UPtr;
2792 static UPtr open(std::string
const& cache_path);
2798 int64_t
size() const noexcept;
2803 PersistentCacheStats
stats() const;
2805 bool put(std::
string const& key,
2806 std::
string const& value,
2807 std::chrono::time_point<std::chrono::system_clock> expiry_time = std::chrono::system_clock::time_point());
2808 bool put(std::
string const& key,
2811 std::chrono::time_point<std::chrono::system_clock> expiry_time = std::chrono::system_clock::time_point());
2812 bool put(std::
string const& key,
2813 std::
string const& value,
2814 std::
string const& metadata,
2815 std::chrono::time_point<std::chrono::system_clock> expiry_time = std::chrono::system_clock::time_point());
2816 bool put(std::
string const& key,
2819 char const* metadata,
2820 int64_t metadata_size,
2821 std::chrono::time_point<std::chrono::system_clock> expiry_time = std::chrono::system_clock::time_point());
2823 typedef std::function<
void(std::
string const& key, PersistentCache<std::
string, std::
string, std::
string>& cache)>
2829 bool put_metadata(std::
string const& key, std::
string const& metadata);
2830 bool put_metadata(std::
string const& key,
char const* metadata, int64_t
size);
2834 void invalidate(std::vector<std::
string> const& keys);
2835 template <typename It>
2837 void invalidate(std::initializer_list<std::
string> const& keys);
2840 std::
string const& key,
2841 std::chrono::time_point<std::chrono::system_clock> expiry_time = std::chrono::system_clock::time_point());
2844 void trim_to(int64_t used_size_in_bytes);
2853 PersistentCache(std::
string const& cache_path);
2855 std::unique_ptr<PersistentStringCache> p_;
2858PersistentCache<std::
string, std::
string, std::
string>::PersistentCache(std::
string const& cache_path,
2866 : p_(PersistentStringCache::
open(cache_path))
2872 int64_t max_size_in_bytes,
2876 new PersistentCache<std::string, std::string, std::string>(cache_path, max_size_in_bytes, policy));
2883 new PersistentCache<std::string, std::string, std::string>(cache_path));
2889 auto const& svalue = p_->get(key);
2890 return svalue ? OptionalValue(*svalue) : OptionalValue();
2896 auto sdata = p_->get_data(key);
2899 return OptionalData();
2901 return OptionalData({sdata->value, sdata->metadata});
2907 auto smeta = p_->get_metadata(key);
2908 return smeta ? OptionalMetadata(*smeta) : OptionalMetadata();
2913 return p_->contains_key(key);
2923 return p_->size_in_bytes();
2928 return p_->max_size_in_bytes();
2933 return p_->disk_size_in_bytes();
2938 return p_->discard_policy();
2947 std::string
const& key, std::string
const& value, std::chrono::time_point<std::chrono::system_clock> expiry_time)
2949 return p_->put(key, value, expiry_time);
2953 std::string
const& key,
2956 std::chrono::time_point<std::chrono::system_clock> expiry_time)
2958 return p_->put(key, value, size, expiry_time);
2962 std::string
const& key,
2963 std::string
const& value,
2964 std::string
const& metadata,
2965 std::chrono::time_point<std::chrono::system_clock> expiry_time)
2967 return p_->put(key, value, metadata, expiry_time);
2971 std::string
const& key,
2974 char const* metadata,
2975 int64_t metadata_size,
2976 std::chrono::time_point<std::chrono::system_clock> expiry_time)
2978 return p_->put(key, value, value_size, metadata, metadata_size, expiry_time);
2985 auto sload_func = [&](std::string
const&, PersistentStringCache
const&)
2987 load_func(key, *
this);
2989 auto svalue = p_->get_or_put(key, sload_func);
2990 return svalue ? OptionalValue(*svalue) : OptionalValue();
2997 auto sload_func = [&](std::string
const&, PersistentStringCache
const&)
2999 load_func(key, *
this);
3001 auto sdata = p_->get_or_put_data(key, sload_func);
3004 return OptionalData();
3006 return OptionalData({sdata->value, sdata->metadata});
3010 std::string
const& metadata)
3012 return p_->put_metadata(key, metadata);
3016 char const* metadata,
3019 return p_->put_metadata(key, metadata, size);
3025 auto svalue = p_->take(key);
3026 return svalue ? OptionalValue(*svalue) : OptionalValue();
3032 auto sdata = p_->take_data(key);
3035 return OptionalData();
3037 return OptionalData({sdata->value, sdata->metadata});
3042 return p_->invalidate(key);
3050template <
typename It>
3053 std::vector<std::string> skeys;
3054 for (
auto&& it = begin; it < end; ++it)
3056 skeys.push_back(*it);
3058 p_->invalidate(skeys.begin(), skeys.end());
3072 std::string
const& key, std::chrono::time_point<std::chrono::system_clock> expiry_time)
3074 return p_->touch(key, expiry_time);
3084 p_->resize(size_in_bytes);
3089 p_->trim_to(used_size_in_bytes);
3099 p_->set_handler(events, cb);
Class that provides (read-only) access to cache statistics and settings.
Definition persistent_cache_stats.h:43
A persistent cache of key-value pairs and metadata of user-defined type.
Definition persistent_cache.h:119
CacheDiscardPolicy discard_policy() const noexcept
Returns the discard policy of the cache.
OptionalData get_data(K const &key) const
Returns the data for an entry in the cache, provided the entry has not expired.
bool touch(K const &key, std::chrono::time_point< std::chrono::system_clock > expiry_time=std::chrono::system_clock::time_point())
Updates the access time of an entry.
OptionalValue get(K const &key) const
Returns the value of an entry in the cache, provided the entry has not expired.
OptionalData take_data(K const &key)
Removes an entry and returns its value and metadata.
Optional< K > OptionalKey
Convenience typedefs for returning nullable values.
Definition persistent_cache.h:155
std::unique_ptr< PersistentCache< K, V, M > > UPtr
Definition persistent_cache.h:124
int64_t size() const noexcept
Returns the number of entries in the cache.
static UPtr open(std::string const &cache_path)
Opens an existing PersistentCache.
void trim_to(int64_t used_size_in_bytes)
Expires entries.
void set_handler(CacheEvent events, EventCallback cb)
Installs a handler for one or more events.
Optional< M > OptionalMetadata
Definition persistent_cache.h:157
static UPtr open(std::string const &cache_path, int64_t max_size_in_bytes, CacheDiscardPolicy policy)
Creates or opens a PersistentCache.
void compact()
Compacts the database.
OptionalData get_or_put_data(K const &key, Loader const &load_func)
Atomically retrieves or stores a cache entry.
Optional< Data > OptionalData
Definition persistent_cache.h:158
int64_t max_size_in_bytes() const noexcept
Returns the maximum size of the cache in bytes.
int64_t disk_size_in_bytes() const
Returns an estimate of the disk space consumed by the cache.
std::function< void(K const &key, CacheEvent ev, PersistentCacheStats const &stats)> EventCallback
The type of a handler function.
Definition persistent_cache.h:371
bool contains_key(K const &key) const
Tests if an (unexpired) entry is in the cache.
PersistentCache & operator=(PersistentCache &&)=default
PersistentCache(PersistentCache const &)=delete
PersistentCache & operator=(PersistentCache const &)=delete
std::function< void(K const &key, PersistentCache< K, V, M > &cache)> Loader
Function called by the cache to load an entry after a cache miss.
Definition persistent_cache.h:280
bool put_metadata(K const &key, M const &metadata)
Adds or replaces the metadata for an entry. If M = std::string, an overload that accepts const char* ...
OptionalMetadata get_metadata(K const &key) const
Returns the metadata for an entry in the cache, provided the entry has not expired.
PersistentCacheStats stats() const
Returns statistics for the cache.
PersistentCache(PersistentCache &&)=default
OptionalValue take(K const &key)
Removes an entry and returns its value.
void invalidate()
Deletes all entries from the cache.
OptionalValue get_or_put(K const &key, Loader const &load_func)
Atomically retrieves or stores a cache entry.
int64_t size_in_bytes() const noexcept
Returns the number of bytes consumed by entries in the cache.
void resize(int64_t size_in_bytes)
Changes the maximum size of the cache.
Optional< V > OptionalValue
Definition persistent_cache.h:156
bool put(K const &key, V const &value, std::chrono::time_point< std::chrono::system_clock > expiry_time=std::chrono::system_clock::time_point())
Adds or updates an entry. If V = std::string, the method is also overloaded to to accept char const* ...
void clear_stats()
Resets all statistics counters.
~PersistentCache()=default
A cache of key-value pairs with persistent storage.
Definition persistent_string_cache.h:69
Top-level namespace for core functionality.
Definition cache_codec.h:24
CacheDiscardPolicy
Indicates the discard policy to make room for entries when the cache is full.
Definition cache_discard_policy.h:36
CacheEvent
Event types that can be monitored.
Definition cache_events.h:39
@ put
An entry was added by a call to put() or get_or_put().
@ get
An entry was returned by a call to get(), get_or_put(), take(), or take_data().
@ touch
An entry was refreshed by a call to touch().
@ invalidate
An entry was removed by a call to invalidate(), take(), or take_data().
boost::optional< T > Optional
Convenience typedef for nullable values.
Definition optional.h:39
static T decode(std::string const &s)
Converts a string into a value of custom type T.
static std::string encode(T const &value)
Converts a value of custom type T into a string.
Simple pair of value and metadata.
Definition persistent_cache.h:130
V value
Stores the value of an entry.
Definition persistent_cache.h:134
M metadata
Stores the metadata of an entry. If no metadata exists for an entry, metadata is returned as the empt...
Definition persistent_cache.h:140