ugrpc::client::ClientFactoryComponent Class Reference

#include <userver/ugrpc/client/client_factory_component.hpp>

Detailed Description

Provides a ClientFactory in the component system.

Multiple ClientFactoryComponent instances may be created if different parameters are required for different clients.

Requires ugrpc::client::CommonComponent.

Authentication

Authentication is controlled by auth-type static config field. Possible values:

• insecure (InsecureChannelCredentials - default)
• ssl (SslCredentials)

Default (system) authentication keys are used regardless of the chosen auth-type.

Service config

As per https://github.com/grpc/grpc/blob/master/doc/service_config.md service config should be distributed via the name resolution process. We allow setting default service_config: pass desired JSON literal to default-service-config parameter

Static options:

The default component name for static config is "grpc-client-factory".

Name	Description	Default value
channel-args	a map of channel arguments, see gRPC Core docs	{}
auth-type	authentication method, see above	-
default-service-config	default service config, see above	-
channel-count	Number of underlying grpc::Channel objects	1
middlewares	middlewares names to use	-
disable-user-pipeline-middlewares	a flag to disable groups::User middlewares from pipeline	false
disable-all-pipeline-middlewares	a flag to disable all middlewares from the pipline	false

See also

https://grpc.github.io/grpc/core/group__grpc__arg__keys.html

Examples

grpc-generic-proxy/main.cpp, samples/grpc_middleware_service/main.cpp, and samples/grpc_service/main.cpp.

Definition at line 66 of file client_factory_component.hpp.

Inheritance diagram for ugrpc::client::ClientFactoryComponent:

Public Member Functions
	ClientFactoryComponent (const components::ComponentConfig &config, const components::ComponentContext &context)
ClientFactory &	GetFactory ()
ComponentHealth	GetComponentHealth () const override
void	OnLoadingCancelled () override
void	OnAllComponentsLoaded () override
void	OnAllComponentsAreStopping () override

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

Static Public Attributes
static constexpr std::string_view	kName = "grpc-client-factory"
	The default name of ugrpc::client::middlewares::log::Component.

Protected Types
using	MiddlewareFactory
using	LoggableComponentBase = ComponentBase

Member Typedef Documentation

LoggableComponentBase

using components::ComponentBase::LoggableComponentBase = ComponentBase

protectedinherited

Deprecated

use components::ComponentBase instead.

Definition at line 67 of file component_base.hpp.

MiddlewareFactory

using middlewares::RunnerComponentBase< MiddlewareBase, ClientInfo >::MiddlewareFactory

protectedinherited

Definition at line 152 of file runner.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 58 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.

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/ugrpc/client/client_factory_component.hpp