ugrpc::server::ServiceComponentBase Class Reference

#include <userver/ugrpc/server/service_component_base.hpp>

Detailed Description

Base class for all the gRPC service components.

Static options:

Name	Description	Default value
task-processor	the task processor to use for responses	taken from grpc-server.service-defaults
middlewares	middleware component names to use for each RPC call, can be empty array ([])	taken from grpc-server.service-defaults

Examples

samples/grpc_service/src/greeter_service.cpp, and samples/grpc_service/src/greeter_service.hpp.

Definition at line 35 of file service_component_base.hpp.

Inheritance diagram for ugrpc::server::ServiceComponentBase:

Public Member Functions
	ServiceComponentBase (const components::ComponentConfig &config, const components::ComponentContext &context)
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.

Protected Member Functions
void	RegisterService (ServiceBase &service)
void	RegisterService (GenericServiceBase &service)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Member Typedef Documentation

LoggableComponentBase

using components::ComponentBase::LoggableComponentBase = ComponentBase

protectedinherited

Legacy alias, use ComponentBase instead.

Definition at line 67 of file component_base.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 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.

RegisterService()

void ugrpc::server::ServiceComponentBase::RegisterService ( ServiceBase & service )

protected

Derived classes must store the actual service class in a field and call RegisterService with it

---

The documentation for this class was generated from the following file:

• userver/ugrpc/server/service_component_base.hpp