userver: grpc_reflection::ReflectionServiceComponent Class Reference
Loading...
Searching...
No Matches
grpc_reflection::ReflectionServiceComponent Class Referencefinal

Detailed Description

Definition at line 22 of file reflection_service_component.hpp.

Inheritance diagram for grpc_reflection::ReflectionServiceComponent:

Public Member Functions

 ReflectionServiceComponent (const components::ComponentConfig &config, const components::ComponentContext &context)
void OnLoadingCancelled () override
void OnGracefulShutdown (engine::Deadline serving_shutdown_deadline) override
void OnAllComponentsAreStopping () override

Static Public Member Functions

static yaml_config::Schema GetStaticConfigSchema ()

Static Public Attributes

static constexpr std::string_view kName = "grpc-reflection-service"

Protected Types

using MiddlewareFactory
using LoggableComponentBase = ComponentBase

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
Deprecated
use components::ComponentBase instead.

Definition at line 79 of file component_base.hpp.

◆ MiddlewareFactory

using middlewares::RunnerComponentBase< MiddlewareBase, ServiceInfo >::MiddlewareFactory
protectedinherited

Definition at line 139 of file runner.hpp.

Constructor & Destructor Documentation

◆ ReflectionServiceComponent()

grpc_reflection::ReflectionServiceComponent::ReflectionServiceComponent ( const components::ComponentConfig & config,
const components::ComponentContext & context )

Definition at line 13 of file reflection_service_component.cpp.

Member Function Documentation

◆ 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 70 of file component_base.hpp.

◆ OnGracefulShutdown()

void components::ComponentBase::OnGracefulShutdown ( engine::Deadline serving_shutdown_deadline)
overridevirtualinherited

Serving components like HTTP and gRPC servers may use this function to stop accepting new requests and shutdown serving in the given time interval. Application components likely do not need to override it.

Parameters
[in]serving_shutdown_deadlineThe deadline until already running requests should be allowed to complete. The component is supposed to stop accepting new requests and continue processing of already active requests until this deadline (unless those requests finish earlier). And it might completely shutdown requests processing when the deadline is reached (or when no active requests left).

Reimplemented from components::RawComponentBase.

Reimplemented in components::Server.

◆ 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)
protectedinherited

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

Member Data Documentation

◆ kName

std::string_view grpc_reflection::ReflectionServiceComponent::kName = "grpc-reflection-service"
staticconstexpr

Definition at line 24 of file reflection_service_component.hpp.

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