simple_client_component.hpp

Go to the documentation of this file.

#pragma once
 
/// @file userver/ugrpc/client/simple_client_component.hpp
/// @brief @copybrief ugrpc::client::SimpleClientComponent
 
#include <userver/components/component_config.hpp>
#include <userver/components/component_context.hpp>
 
#include <userver/ugrpc/client/client_factory_component.hpp>
 
USERVER_NAMESPACE_BEGIN
 
namespace ugrpc::client {
 
namespace impl {
 
class SimpleClientComponentAny : public components::LoggableComponentBase {
 public:
  using components::LoggableComponentBase::LoggableComponentBase;
 
  static yaml_config::Schema GetStaticConfigSchema();
};
 
}  // namespace impl
 
// clang-format off
 
/// @ingroup userver_components
///
/// @brief Template class for a simple gRPC client
///
/// The component is used as a storage of a gRPC client if you're OK with
/// generated client and don't need to wrap it. The client can be fetched using
/// `GetClient` method.
///
/// Example usage:
///
/// ```cpp
/// int main(...)
/// {
///    ...
///    component_list.Append<ugrpc::client::SimpleClientComponent<MyClient>>();
///    ...
/// }
///
/// MyComponent::MyComponent(const components::ComponentConfig& config,
///                          const components::ComponentContext& context)
/// {
///    auto& component = context.FindComponent<ugrpc::client::SimpleClientComponent<MyClient>>();
///    MyClient& client = component.GetClient();
///    ... use client ...
/// }
/// ```
 
// clang-format on
 
template <typename Client>
class SimpleClientComponent final : public impl::SimpleClientComponentAny {
 public:
  SimpleClientComponent(const components::ComponentConfig& config,
                        const components::ComponentContext& context)
      : SimpleClientComponentAny(config, context),
        client_(context
                    .FindComponent<ClientFactoryComponent>(
                        config["factory-component"].As<std::string>(
                            ClientFactoryComponent::kName))
                    .GetFactory()
                    .MakeClient<Client>(
                        config.Name(), config["endpoint"].As<std::string>())) {}
 
  /// @@brief Get gRPC service client
  Client& GetClient() { return client_; }
 
 private:
  Client client_;
};
 
}  // namespace ugrpc::client
 
namespace components {
 
template <typename Client>
inline constexpr bool
    kHasValidate<ugrpc::client::SimpleClientComponent<Client>> = true;
 
}  // namespace components
 
USERVER_NAMESPACE_END