ugrpc::server::ServerComponent Class Reference

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

Detailed Description

Component that configures and manages the gRPC server.

Static options of ugrpc::server::ServerComponent :

Name	Description	Default value
port	The port to use for all gRPC services, or 0 to pick any available.	–
unix-socket-path	Unix socket absolute path.	–
completion-queue-count	Completion queue count to create. Should be ~2 times less than worker threads for best RPS.	2
channel-args.*	A map of channel arguments, see gRPC Core docs. Each of the elements: value of channel argument, must be string or integer.	{}
native-log-level	Min log level for the native gRPC library. Possible values: trace, debug, info, warning, error, critical, none.	error
enable-channelz	Enable channelz.	false
tls	TLS settings.	–
tls.ca	Path to TLS client CA certificate.	–
tls.key	Path to TLS certificate key.	–
tls.cert	Path to TLS certificate.	–
service-defaults	Omitted options for service components will default to the corresponding option from here.	–
service-defaults.task-processor	The task processor to use for responses.	–

Options inherited from components::ComponentBase :

Name	Description	Default value
load-enabled	Set to false to disable loading of the component.	true

The component name for static config is "grpc-server".

See also

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

Definition at line 31 of file server_component.hpp.

Inheritance diagram for ugrpc::server::ServerComponent:

Public Member Functions
	ServerComponent (const components::ComponentConfig &config, const components::ComponentContext &context)
Server &	GetServer () noexcept
ComponentHealth	GetComponentHealth () const override
void	OnLoadingCancelled () override

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

Static Public Attributes
static constexpr std::string_view	kName = "grpc-server"
	The default name of ugrpc::server::ServerComponent.

Protected Types
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.

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.

GetServer()

Server & ugrpc::server::ServerComponent::GetServer ( )

noexcept

Returns

The contained Server instance

Note

All configuration must be performed at the components loading stage

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/server/server_component.hpp