components::DynamicConfigUpdatesSinkBase Class Reference

#include <userver/dynamic_config/updates_sink/component.hpp>

Detailed Description

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.

Warning

Unless explicitly stated, descendants of this class expect that SetConfig method calls are serialized.

Definition at line 42 of file component.hpp.

Inheritance diagram for components::DynamicConfigUpdatesSinkBase:

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
ComponentHealth	GetComponentHealth () const override
void	OnLoadingCancelled () override
void	OnAllComponentsLoaded () override
void	OnAllComponentsAreStopping () override

Static Public Member Functions
static yaml_config::Schema	GetStaticConfigSchema ()

Protected Types
using	LoggableComponentBase = ComponentBase
	Legacy alias, use ComponentBase instead.

Member Typedef Documentation

LoggableComponentBase

using components::ComponentBase::LoggableComponentBase = ComponentBase

protectedinherited

Legacy alias, use ComponentBase instead.

Definition at line 67 of file component_base.hpp.

Member Function Documentation

GetComponentHealth()

ComponentHealth components::ComponentBase::GetComponentHealth ( ) const

inlineoverridevirtualinherited

Override this function to inform the world of the state of your component.

Warning

The function is called concurrently from multiple threads.

Reimplemented from components::RawComponentBase.

Reimplemented in server::handlers::Restart.

Definition at line 35 of file component_base.hpp.

GetStaticConfigSchema()

static yaml_config::Schema components::ComponentBase::GetStaticConfigSchema ( )

staticinherited

If the component pulls more options from ComponentConfig than its parent component, then it needs to define GetStaticConfigSchema method and add its own options to the parent component's options.

NotifyLoadingFailed()

virtual void components::DynamicConfigUpdatesSinkBase::NotifyLoadingFailed ( std::string_view updater, std::string_view error )

pure virtual

Should be called when updater fails to load dynamic config. When the service starts up and dynamic config cache file is not found, components::DynamicConfig expects updater to provide the 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 to interrupt the service startup with proper diagnostics. This method should not typically throw any exceptions. If the config is already loaded, calling this method should do nothing.

Parameters

updater	updater name used for logging
error	error to be outputted to log

OnAllComponentsAreStopping()

void components::ComponentBase::OnAllComponentsAreStopping ( )

inlineoverridevirtualinherited

Component may use this function to stop doing work before the stop of the components that depend on it.

Base components may override it and make final to do some work before the derived object constructor is called. Don't use it otherwise.

Reimplemented from components::RawComponentBase.

Reimplemented in urabbitmq::ConsumerComponentBase, and components::Server.

Definition at line 58 of file component_base.hpp.

OnAllComponentsLoaded()

void components::ComponentBase::OnAllComponentsLoaded ( )

inlineoverridevirtualinherited

Component may use this function to finalize registration of other components that depend on it (for example, handler components register in server component, and the latter uses OnAllComponentsLoaded() to start processing requests).

Base components may override it and make final to do some work after the derived object constructor is called. Don't use it otherwise.

Reimplemented from components::RawComponentBase.

Reimplemented in urabbitmq::ConsumerComponentBase, components::Server, and server::handlers::Ping.

Definition at line 51 of file component_base.hpp.

OnLoadingCancelled()

void components::ComponentBase::OnLoadingCancelled ( )

inlineoverridevirtualinherited

Called once if the creation of any other component failed. If the current component expects some other component to take any action with the current component, this call is a signal that such action may never happen due to components loading was cancelled. Application components might not want to override it.

Reimplemented from components::RawComponentBase.

Definition at line 42 of file component_base.hpp.

SetConfig() [1/2]

virtual void components::DynamicConfigUpdatesSinkBase::SetConfig ( std::string_view updater, const dynamic_config::DocsMap & config )

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.

Parameters

updater	updater name used for logging
config	updated dynamic config

SetConfig() [2/2]

virtual void components::DynamicConfigUpdatesSinkBase::SetConfig ( std::string_view updater, dynamic_config::DocsMap && config )

pure virtual

Called by updaters to store new version of dynamic config.

Parameters

updater	updater name used for logging
config	updated dynamic config

---

The documentation for this class was generated from the following file:

• userver/dynamic_config/updates_sink/component.hpp