find.hpp

Go to the documentation of this file.

#pragma once
 
/// @file userver/dynamic_config/updates_sink/find.hpp
/// @brief Function for retrieving dynamic config updates sink specified in the
/// static config.
 
#include <type_traits>
 
#include <userver/components/component_fwd.hpp>
#include <userver/dynamic_config/fwd.hpp>
 
USERVER_NAMESPACE_BEGIN
 
namespace dynamic_config {
 
/// @brief Returns component to which incoming dynamic config updates should be
/// forwarded.
///
/// Component to be used as an updates sink is determined by the `updates-sink`
/// static config field. If this field is not set, then
/// components::DynamicConfig is used as a default sink.
///
/// @warning Can only be called from other component's constructor in a task
/// where that constructor was called. May block and asynchronously wait for the
/// creation of the requested component.
///
/// @note It is illegal to use the same updates sink from several components.
components::DynamicConfigUpdatesSinkBase& FindUpdatesSink(
    const components::ComponentConfig& config,
    const components::ComponentContext& context);
 
}  // namespace dynamic_config
 
USERVER_NAMESPACE_END