ugrpc::client::SimpleClientComponent< Client > Class Template Reference

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

Detailed Description

template<typename Client>
class ugrpc::client::SimpleClientComponent< Client >

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:

int main(...)
{
   ...
   component_list.Append<ugrpc::client::SimpleClientComponent<HelloClient>>("hello-client");
   ...
}
 
MyComponent::MyComponent(const components::ComponentConfig& config,
                         const components::ComponentContext& context)
{
   HelloClient& client = context.FindComponent<
       ugrpc::client::SimpleClientComponent<HelloClient>>("hello-client").GetClient();
   ... use client ...
}

Static config options:

Name	Description	Default value
endpoint	URL of the gRPC service	–
client-name	name of the gRPC server we talk to, for diagnostics	<uses the component name>
dedicated-channel-counts	a map of a full rpc name (full.service.Name/MethodName) in channel count. Used for high-load methods	-
factory-component	ClientFactoryComponent name to use for client creation	–

Examples

samples/grpc_service/src/greeter_client.hpp.

Definition at line 73 of file simple_client_component.hpp.

Inheritance diagram for ugrpc::client::SimpleClientComponent< Client >:

Public Member Functions
	SimpleClientComponent (const components::ComponentConfig &config, const components::ComponentContext &context)
	Main component's constructor.
	SimpleClientComponent (const components::ComponentConfig &config, const components::ComponentContext &context, const dynamic_config::Key< ClientQos > &client_qos)
	To use a ClientQos config,.
Client &	GetClient ()
	@brief Get gRPC service client
ComponentHealth	GetComponentHealth () const override
void	OnLoadingCancelled () override
void	OnAllComponentsLoaded () override
void	OnAllComponentsAreStopping () override

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

Protected Types
using	LoggableComponentBase = ComponentBase
	Legacy alias, use ComponentBase instead.

Member Typedef Documentation

LoggableComponentBase

using components::ComponentBase::LoggableComponentBase = ComponentBase

protectedinherited

Legacy alias, use ComponentBase instead.

Definition at line 67 of file component_base.hpp.

Constructor & Destructor Documentation

SimpleClientComponent() [1/2]

template<typename Client >

ugrpc::client::SimpleClientComponent< Client >::SimpleClientComponent ( const components::ComponentConfig & config, const components::ComponentContext & context )

inline

Main component's constructor.

Definition at line 76 of file simple_client_component.hpp.

SimpleClientComponent() [2/2]

template<typename Client >

ugrpc::client::SimpleClientComponent< Client >::SimpleClientComponent ( const components::ComponentConfig & config, const components::ComponentContext & context, const dynamic_config::Key< ClientQos > & client_qos )

inline

To use a ClientQos config,.

Definition at line 81 of file simple_client_component.hpp.

Member Function Documentation

GetClient()

template<typename Client >

Client & ugrpc::client::SimpleClientComponent< Client >::GetClient ( )

inline

@brief Get gRPC service client

Definition at line 90 of file simple_client_component.hpp.

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.

GetStaticConfigSchema()

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

staticinherited

If the component pulls more options from 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 urabbitmq::ConsumerComponentBase, and components::Server.

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 urabbitmq::ConsumerComponentBase, components::Server, and server::handlers::Ping.

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