ugrpc::server::middlewares::congestion_control::Component Class Reference

#include <userver/ugrpc/server/middlewares/congestion_control/component.hpp>

Detailed Description

Component for gRPC server logging.

The component does not have any options for service config.

Static configuration example:

        grpc-server-congestion-control:
            # Nothing

See also

gRPC server middlewares

Definition at line 33 of file component.hpp.

Inheritance diagram for ugrpc::server::middlewares::congestion_control::Component:

Public Types
using	MiddlewareBase
using	MiddlewareBase

Public Member Functions
	Component (const components::ComponentConfig &config, const components::ComponentContext &context)
std::shared_ptr< const MiddlewareBase >	CreateMiddleware (const ugrpc::server::ServiceInfo &, const yaml_config::YamlConfig &middleware_config) const override
virtual std::shared_ptr< const MiddlewareBase >	CreateMiddleware (const ServiceInfo &info, const yaml_config::YamlConfig &middleware_config) const=0
	Returns a middleware according to the component's settings.
virtual yaml_config::Schema	GetMiddlewareConfigSchema () const
	This method should return the schema of a middleware configuration. Always write return GetStaticConfigSchema(); in this method.
virtual yaml_config::Schema	GetMiddlewareConfigSchema () const
	This method should return the schema of a middleware configuration. Always write return GetStaticConfigSchema(); in this method.
ComponentHealth	GetComponentHealth () const override
void	OnLoadingCancelled () override
void	OnAllComponentsLoaded () override
void	OnAllComponentsAreStopping () override

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

Static Public Attributes
static constexpr std::string_view	kName = "grpc-server-congestion-control"
	The default name of ugrpc::server::middlewares::congestion_control::Component.

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.

MiddlewareBase [1/2]

using middlewares::MiddlewareFactoryComponentBase< MiddlewareBase, ServiceInfo >::MiddlewareBase

inherited

Definition at line 62 of file runner.hpp.

MiddlewareBase [2/2]

using middlewares::MiddlewareFactoryComponentBase< MiddlewareBase, ServiceInfo >::MiddlewareBase

inherited

Definition at line 62 of file runner.hpp.

Member Function Documentation

CreateMiddleware()

virtual std::shared_ptr< const MiddlewareBase > middlewares::MiddlewareFactoryComponentBase< MiddlewareBase, ServiceInfo >::CreateMiddleware ( const ServiceInfo & info, const yaml_config::YamlConfig & middleware_config ) const

pure virtualinherited

Returns a middleware according to the component's settings.

Parameters

info	is a handler info for the middleware.
middleware_config	config for the middleware.

Warning

Don't store info by reference. info object will be dropped after the CreateMiddleware call.

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.

GetMiddlewareConfigSchema() [1/2]

virtual yaml_config::Schema middlewares::MiddlewareFactoryComponentBase< MiddlewareBase, ServiceInfo >::GetMiddlewareConfigSchema ( ) const

inlinevirtualinherited

This method should return the schema of a middleware configuration. Always write return GetStaticConfigSchema(); in this method.

Reimplemented in grpc_protovalidate::server::ValidatorComponent, ugrpc::server::middlewares::headers_propagator::Component, and ugrpc::server::middlewares::log::Component.

Definition at line 84 of file runner.hpp.

GetMiddlewareConfigSchema() [2/2]

virtual yaml_config::Schema middlewares::MiddlewareFactoryComponentBase< MiddlewareBase, ServiceInfo >::GetMiddlewareConfigSchema ( ) const

inlinevirtualinherited

This method should return the schema of a middleware configuration. Always write return GetStaticConfigSchema(); in this method.

Reimplemented in grpc_protovalidate::server::ValidatorComponent, ugrpc::server::middlewares::headers_propagator::Component, and ugrpc::server::middlewares::log::Component.

Definition at line 84 of file runner.hpp.

GetStaticConfigSchema() [1/2]

static yaml_config::Schema middlewares::MiddlewareFactoryComponentBase< MiddlewareBase, ServiceInfo >::GetStaticConfigSchema ( )

inlinestaticinherited

Definition at line 86 of file runner.hpp.

GetStaticConfigSchema() [2/2]

static yaml_config::Schema middlewares::MiddlewareFactoryComponentBase< MiddlewareBase, ServiceInfo >::GetStaticConfigSchema ( )

inlinestaticinherited

Definition at line 86 of file runner.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 components::Server, and urabbitmq::ConsumerComponentBase.

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

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/server/middlewares/congestion_control/component.hpp