#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.
Requires ugrpc::client::CommonComponent.
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
| Name | Description | Default value |
|---|---|---|
| auth-type | An optional authentication method. Possible values: insecure, ssl. | insecure |
| ssl-credentials-options | SSL options for cases when auth-type is ssl. | {} |
| ssl-credentials-options.pem-root-certs | The path to file containing the PEM encoding of the server root certificates. | absent |
| ssl-credentials-options.pem-private-key | The path to file containing the PEM encoding of the client's private key. | absent |
| ssl-credentials-options.pem-cert-chain | The path to file containing the PEM encoding of the client's certificate chain. | absent |
| retry-config | Retry configuration for outgoing RPCs. | {} |
| retry-config.attempts | The maximum number of RPC attempts, including the original attempt. | 1 |
| channel-args.* | A map of channel arguments, see gRPC Core docs. Each of the elements: value of channel argument, must be a string or an integer. | {} |
| default-service-config | Default value for gRPC service config. See https://github.com/grpc/grpc/blob/master/doc/service_config.md This value is used if the name resolution process can't get value from DNS. | absent |
| channel-count | Number of channels created for each endpoint. | 1 |
Options inherited from middlewares::RunnerComponentBase :
| Name | Description | Default value |
|---|---|---|
| disable-user-pipeline-middlewares | Flag to disable groups::User middlewares from pipeline. | false |
| disable-all-pipeline-middlewares | Flag to disable all middlewares from pipeline. | false |
| middlewares.*.enabled | Enable middleware in the list. | – |
| middlewares.*.* | A middleware config. | – |
Options inherited from components::ComponentBase :
| Name | Description | Default value |
|---|---|---|
| load-enabled | Set to false to disable loading of the component. | true |
The default component name for static config is "grpc-client-factory".
Definition at line 58 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 |
|
protectedinherited |
Definition at line 67 of file component_base.hpp.
|
protectedinherited |
Definition at line 139 of file runner.hpp.
|
inlineoverridevirtualinherited |
Override this function to inform the world of the state of your component.
Reimplemented from components::RawComponentBase.
Reimplemented in server::handlers::Restart.
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 components::Server, and urabbitmq::ConsumerComponentBase.
Definition at line 58 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 components::Server, server::handlers::Ping, and urabbitmq::ConsumerComponentBase.
Definition at line 51 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 42 of file component_base.hpp.