#include <userver/dynamic_config/updates_sink/component.hpp>
Base class for components acting as dynamic config updates sinks.
Dynamic config updaters (see components::DynamicConfigClientUpdater for example) internally look for updates sink object using dynamic_config::FindUpdatesSink function and use it to store received updates to the dynamic config. By default, this function returns components::DynamicConfig itself, however some user-defined components may inherit from components::DynamicConfigUpdatesSinkBase to apply various transformations to parameters before storing them to dynamic config.
SetConfig
method calls are serialized. Definition at line 40 of file component.hpp.
Public Member Functions | |
DynamicConfigUpdatesSinkBase (const components::ComponentConfig &, const components::ComponentContext &) | |
virtual void | SetConfig (std::string_view updater, dynamic_config::DocsMap &&config)=0 |
virtual void | SetConfig (std::string_view updater, const dynamic_config::DocsMap &config) |
virtual void | NotifyLoadingFailed (std::string_view updater, std::string_view error)=0 |
Public Member Functions inherited from components::LoggableComponentBase | |
LoggableComponentBase (const ComponentConfig &, const ComponentContext &) | |
LoggableComponentBase (LoggableComponentBase &&)=delete | |
LoggableComponentBase (const LoggableComponentBase &)=delete | |
~LoggableComponentBase () override=default | |
ComponentHealth | GetComponentHealth () const override |
void | OnLoadingCancelled () override |
void | OnAllComponentsLoaded () override |
void | OnAllComponentsAreStopping () override |
Additional Inherited Members | |
Static Public Member Functions inherited from components::LoggableComponentBase | |
static yaml_config::Schema | GetStaticConfigSchema () |
|
pure virtual |
Called when updater failed to load dynamic config. When service is started and dynamic config cache file is not found, components::DynamicConfig expects updater to provide current version of the dynamic config and blocks all reads until it is received. Updater is expected to call this method if it can't load dynamic config.
updater | updater name used for logging |
error | error to be outputted to log |
|
virtual |
Called by updaters to store new version of dynamic config. Default implementation creates a copy of config
and then uses it in the call to SetConfig
overload with an rvalue DocsMap
parameter.
updater | updater name used for logging |
config | updated dynamic config |
|
pure virtual |
Called by updaters to store new version of dynamic config.
updater | updater name used for logging |
config | updated dynamic config |