run.hpp

Go to the documentation of this file.

#pragma once
 
/// @file userver/components/run.hpp
/// @brief Functions to start a service or tool with the specified
/// config and components::ComponentList.
 
#include <string>
 
#include <userver/components/component_list.hpp>
#include <userver/utils/strong_typedef.hpp>
 
USERVER_NAMESPACE_BEGIN
 
/// Contains functions and types to start a userver based service/tool.
namespace components {
 
/// Data type to distinguish config path and in-memory config values in
/// components::Run() and components::RunOnce() functions.
struct InMemoryConfig : utils::StrongTypedef<InMemoryConfig, std::string> {
    using StrongTypedef::StrongTypedef;
};
 
/// Starts a server with the provided component list and config loaded from
/// file. Reopens the logging files on SIGUSR1.
///
/// @see utils::DaemonMain
void Run(
    const std::string& config_path,
    const std::optional<std::string>& config_vars_path,
    const std::optional<std::string>& config_vars_override_path,
    const ComponentList& component_list
);
 
/// Starts a server with the provided component list and config.
/// Reopens the logging files on SIGUSR1.
///
/// @see utils::DaemonMain
void Run(const InMemoryConfig& config, const ComponentList& component_list);
 
/// Runs the component list once with the config loaded from file.
///
/// @see utils::DaemonMain
void RunOnce(
    const std::string& config_path,
    const std::optional<std::string>& config_vars_path,
    const std::optional<std::string>& config_vars_override_path,
    const ComponentList& component_list
);
 
/// Runs the component list once with the config.
///
/// @see utils::DaemonMain
void RunOnce(const InMemoryConfig& config, const ComponentList& component_list);
 
/// Requests stop of the component system.
/// The service will be eventually stopped.
void RequestStop();
 
namespace impl {
 
// Composes a single static config schema from all components.
std::string GetStaticConfigSchema(const ComponentList& component_list);
 
std::string GetDynamicConfigDefaults();
 
}  // namespace impl
 
}  // namespace components
 
USERVER_NAMESPACE_END