components::DynamicConfigClient Class Reference

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

Detailed Description

Component that starts a clients::dynamic_config::Client client.

Returned references to clients::dynamic_config::Client live for a lifetime of the component and are safe for concurrent use.

The component must be configured in service config.

Static options of components::DynamicConfigClient :

Name	Description	Default value
get-configs-overrides-for-service	Send service-name field.	true
service-name	Name of the service to send if the get-configs-overrides-for-service is true.	–
http-client	Name of components::HttpClient to use.	–
http-timeout	HTTP request timeout to the remote in utils::StringToDuration() suitable format.	–
http-retries	String HTTP retries before reporting the request failure.	–
config-url	HTTP URL to request configs via POST request.	–
configs-stage-filepath	File to read stage name from, overrides static "configs-stage" if both are provided, expected format: json file with "env_name" property.	–
configs-stage	Stage name provided statically, can be overridden from file.	–
append-path-to-url	Add default path '/configs/values' to 'config-url'.	true

Options inherited from components::ComponentBase :

Name	Description	Default value
load-enabled	Set to false to disable loading of the component.	true

Static configuration example:

# yaml
    dynamic-config-client:
      get-configs-overrides-for-service: true
      service-name: common_component_list-service
      http-timeout: 20s
      http-retries: 5
      config-url: http://localhost:8083/
      configs-stage: $configs_stage

Definition at line 31 of file component.hpp.

Inheritance diagram for components::DynamicConfigClient:

Public Member Functions
	DynamicConfigClient (const ComponentConfig &, const ComponentContext &)
dynamic_config::Client &	GetClient () const
ComponentHealth	GetComponentHealth () const override
void	OnLoadingCancelled () override
void	OnAllComponentsLoaded () override
void	OnGracefulShutdown (engine::Deadline) override
void	OnAllComponentsAreStopping () override

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

Static Public Attributes
static constexpr std::string_view	kName = "dynamic-config-client"
	The default name of components::DynamicConfigClient.

Protected Types
using	LoggableComponentBase = ComponentBase

Member Typedef Documentation

LoggableComponentBase

using components::ComponentBase::LoggableComponentBase = ComponentBase

protectedinherited

Deprecated

use components::ComponentBase instead.

Definition at line 79 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.

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 components::Server, and urabbitmq::ConsumerComponentBase.

Definition at line 70 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 components::Server, server::handlers::Ping, and urabbitmq::ConsumerComponentBase.

Definition at line 51 of file component_base.hpp.

OnGracefulShutdown()

void components::ComponentBase::OnGracefulShutdown ( engine::Deadline )

overridevirtualinherited

Serving components like HTTP and gRPC servers may use this function to stop accepting new requests and shutdown serving in the given time interval. Application components likely do not need to override it.

Parameters

[in]

serving_shutdown_deadline

The deadline until already running requests should be allowed to complete. The component is supposed to stop accepting new requests and continue processing of already active requests until this deadline (unless those requests finish earlier). And it might completely shutdown requests processing when the deadline is reached (or when no active requests left).

Reimplemented from components::RawComponentBase.

Reimplemented in components::Server.

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.

---

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

• userver/dynamic_config/client/component.hpp