#include <userver/ugrpc/client/client_factory_component.hpp>
Provides a ClientFactory in the component system.
Multiple ClientFactoryComponent instances may be created if different parameters are required for different clients.
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.
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
The default component name for static config is "grpc-client-factory".
| Name | Description | Default value |
|---|---|---|
| task-processor | the task processor for blocking channel creation | - |
| channel-args | a map of channel arguments, see gRPC Core docs | {} |
| native-log-level | min log level for the native gRPC library | 'error' |
| 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 | [] |
Definition at line 57 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 | LoggableComponentBase = ComponentBase |
| Legacy alias, use ComponentBase instead. | |
|
protectedinherited |
Legacy alias, use ComponentBase instead.
Definition at line 69 of file component_base.hpp.
|
inlineoverridevirtualinherited |
Override this function to inform the world of the state of your component.
Reimplemented from components::RawComponentBase.
Definition at line 35 of file component_base.hpp.
|
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 urabbitmq::ConsumerComponentBase, and components::Server.
Definition at line 60 of file component_base.hpp.
|
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 urabbitmq::ConsumerComponentBase, components::Server, and server::handlers::Ping.
Definition at line 53 of file component_base.hpp.
|
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 44 of file component_base.hpp.