userver: cache Namespace Reference
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages Concepts
Classes | Enumerations | Functions | Variables
cache Namespace Reference

Table of Contents

Utilities for caching. More...

Classes

class  CacheUpdateTrait
 Base class for periodically updated caches. More...
 
struct  Config
 
class  ConfigError
 
struct  ConfigPatch
 
class  DataError
 
class  EmptyCacheError
 
class  EmptyDataError
 
class  ExpirableLruCache
 Class for expirable LRU cache. Use cache::LruMap for not expirable LRU Cache. More...
 
class  LruCacheComponent
 Base class for LRU-cache components. More...
 
struct  LruCacheConfig
 
struct  LruCacheConfigStatic
 
class  LruCacheWrapper
 
class  LruMap
 
class  LruSet
 
class  NWayLRU
 
class  UpdateStatisticsScope
 Allows a specific cache to fill cache statistics during an Update More...
 
class  UpdateStatisticsScopeMock
 Allows to test helper functions of CacheUpdateTrait::Update that use UpdateStatisticsScope. More...
 

Enumerations

enum class  FirstUpdateMode {
  kRequired ,
  kBestEffort ,
  kSkip
}
 
enum class  FirstUpdateType {
  kFull ,
  kIncremental ,
  kIncrementalThenAsyncFull
}
 
enum class  BackgroundUpdateMode {
  kEnabled ,
  kDisabled
}
 
enum class  UpdateType {
  kFull ,
  kIncremental
}
 Type of CachingComponentBase update. More...
 
enum class  AllowedUpdateTypes {
  kFullAndIncremental ,
  kOnlyFull ,
  kOnlyIncremental
}
 Update types allowed for a CachingComponentBase instance by static config. More...
 

Functions

FirstUpdateMode Parse (const yaml_config::YamlConfig &config, formats::parse::To< FirstUpdateMode >)
 
std::string_view ToString (FirstUpdateMode)
 
FirstUpdateType Parse (const yaml_config::YamlConfig &config, formats::parse::To< FirstUpdateType >)
 
std::string_view ToString (FirstUpdateType)
 
ConfigPatch Parse (const formats::json::Value &value, formats::parse::To< ConfigPatch >)
 
std::unordered_map< std::string, ConfigPatch > ParseCacheConfigSet (const dynamic_config::DocsMap &docs_map)
 
template<typename Key , typename Value , typename Hash , typename Equal >
void DumpMetric (utils::statistics::Writer &writer, const ExpirableLruCache< Key, Value, Hash, Equal > &cache)
 
LruCacheConfig Parse (const formats::json::Value &value, formats::parse::To< LruCacheConfig >)
 
std::unordered_map< std::string, LruCacheConfig > ParseLruCacheConfigSet (const dynamic_config::DocsMap &docs_map)
 
std::optional< LruCacheConfig > GetLruConfig (const dynamic_config::Snapshot &config, const std::string &cache_name)
 
UpdateType Parse (const formats::json::Value &value, formats::parse::To< UpdateType >)
 
std::string_view ToString (UpdateType update_type)
 
AllowedUpdateTypes Parse (const yaml_config::YamlConfig &value, formats::parse::To< AllowedUpdateTypes >)
 
std::string_view ToString (AllowedUpdateTypes allowed_update_types)
 

Variables

constexpr dynamic_config::Key< ParseCacheConfigSet > kCacheConfigSet
 
constexpr dynamic_config::Key< ParseLruCacheConfigSet > kLruCacheConfigSet
 

Detailed Description

Utilities for caching.

Enumeration Type Documentation

◆ AllowedUpdateTypes

enum class cache::AllowedUpdateTypes
strong

Update types allowed for a CachingComponentBase instance by static config.

Definition at line 27 of file update_type.hpp.

◆ BackgroundUpdateMode

enum class cache::BackgroundUpdateMode
strong

Definition at line 17 of file lru_cache_config.hpp.

◆ FirstUpdateMode

enum class cache::FirstUpdateMode
strong

Definition at line 27 of file cache_config.hpp.

◆ FirstUpdateType

enum class cache::FirstUpdateType
strong

Definition at line 38 of file cache_config.hpp.

◆ UpdateType

enum class cache::UpdateType
strong

Type of CachingComponentBase update.

Enumerator
kFull 

requests all the items, starting from scratch

kIncremental 

requests only newly updated items

Definition at line 16 of file update_type.hpp.

Function Documentation

◆ DumpMetric()

template<typename Key , typename Value , typename Hash , typename Equal >
void cache::DumpMetric ( utils::statistics::Writer &  writer,
const ExpirableLruCache< Key, Value, Hash, Equal > &  cache 
)

Definition at line 437 of file expirable_lru_cache.hpp.

Variable Documentation

◆ kCacheConfigSet

constexpr dynamic_config::Key<ParseCacheConfigSet> cache::kCacheConfigSet
inlineconstexpr

Definition at line 89 of file cache_config.hpp.

◆ kLruCacheConfigSet

constexpr dynamic_config::Key<ParseLruCacheConfigSet> cache::kLruCacheConfigSet
inlineconstexpr

Definition at line 52 of file lru_cache_config.hpp.