easy::DependenciesComponent< Dependencies > Class Template Reference

#include <userver/easy.hpp>

Detailed Description

template<class Dependencies>
class easy::DependenciesComponent< Dependencies >

Factory component for the dependencies from easy library.

This component can be registered in the component list and used by any client. For example:

using Deps = easy::Dependencies<ActionDep, easy::PgDep>;
using DepsComponent = easy::DependenciesComponent<Deps>;
 
class MyHandler final : public server::handlers::HttpHandlerBase {
public:
    MyHandler(const components::ComponentConfig& config, const components::ComponentContext& component_context)
        : HttpHandlerBase(config, component_context),
          deps_(component_context.FindComponent<DepsComponent>().GetDependencies())
    {}
 
    std::string HandleRequestThrow(const server::http::HttpRequest& request, server::request::RequestContext&)
        const override {
        const auto& action = request.GetArg("action");
        deps_.pg().Execute(
            storages::postgres::ClusterHostType::kMaster,
            "INSERT INTO events_table(action) VALUES($1)",
            action
        );
        return deps_.CreateActionRequest(action)->body();
    }
 
private:
    const Deps deps_;
};
 
int main(int argc, char* argv[]) {
    auto component_list =
        components::MinimalServerComponentList()
            .Append<components::TestsuiteSupport>()
            .AppendComponentList(clients::http::ComponentList())
            .Append<clients::dns::Component>()
            .Append<ActionClient>()
            .Append<DepsComponent>()
            .Append<components::Postgres>("postgres")
            .Append<MyHandler>("/log-POST");
 
    return utils::DaemonMain(argc, argv, component_list);
}

Definition at line 90 of file easy.hpp.

Inheritance diagram for easy::DependenciesComponent< Dependencies >:

Public Member Functions
	DependenciesComponent (const components::ComponentConfig &config, const components::ComponentContext &context)
Dependencies	GetDependencies () 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 = "easy-dependencies"
	The default name of easy::DependenciesComponent.

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.

Constructor & Destructor Documentation

DependenciesComponent()

template<class Dependencies>

easy::DependenciesComponent< Dependencies >::DependenciesComponent ( const components::ComponentConfig & config, const components::ComponentContext & context )

inline

Definition at line 96 of file easy.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.

GetDependencies()

template<class Dependencies>

Dependencies easy::DependenciesComponent< Dependencies >::GetDependencies ( ) const

inline

Definition at line 101 of file easy.hpp.

GetStaticConfigSchema()

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

staticinherited

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

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/easy.hpp