userver: middlewares::MiddlewareFactoryComponentBase< MiddlewareBaseType, HandlerInfo > Class Template Reference
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages Concepts
Public Types | Public Member Functions | Static Public Member Functions | Protected Types | List of all members
middlewares::MiddlewareFactoryComponentBase< MiddlewareBaseType, HandlerInfo > Class Template Referenceabstract
Base Classes

Your opinion will help to improve our service

Leave a feedback >

Table of Contents

#include <userver/middlewares/runner.hpp>

Detailed Description

template<typename MiddlewareBaseType, typename HandlerInfo>
class middlewares::MiddlewareFactoryComponentBase< MiddlewareBaseType, HandlerInfo >

Base class for middleware factory component.

Definition at line 52 of file runner.hpp.

+ Inheritance diagram for middlewares::MiddlewareFactoryComponentBase< MiddlewareBaseType, HandlerInfo >:

Public Types

using MiddlewareBase = MiddlewareBaseType
 

Public Member Functions

 MiddlewareFactoryComponentBase (const components::ComponentConfig &config, const components::ComponentContext &context, MiddlewareDependencyBuilder &&builder=impl::MakeDefaultUserDependency())
 
virtual std::shared_ptr< MiddlewareBase > CreateMiddleware (const HandlerInfo &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.
 
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
 

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

template<typename MiddlewareBaseType , typename HandlerInfo >
using middlewares::MiddlewareFactoryComponentBase< MiddlewareBaseType, HandlerInfo >::MiddlewareBase = MiddlewareBaseType

Definition at line 54 of file runner.hpp.

Constructor & Destructor Documentation

◆ MiddlewareFactoryComponentBase()

template<typename MiddlewareBaseType , typename HandlerInfo >
middlewares::MiddlewareFactoryComponentBase< MiddlewareBaseType, HandlerInfo >::MiddlewareFactoryComponentBase ( const components::ComponentConfig & config,
const components::ComponentContext & context,
MiddlewareDependencyBuilder && builder = impl::MakeDefaultUserDependency() )
inline

Definition at line 56 of file runner.hpp.

Member Function Documentation

◆ CreateMiddleware()

template<typename MiddlewareBaseType , typename HandlerInfo >
virtual std::shared_ptr< MiddlewareBase > middlewares::MiddlewareFactoryComponentBase< MiddlewareBaseType, HandlerInfo >::CreateMiddleware ( const HandlerInfo & info,
const yaml_config::YamlConfig & middleware_config ) const
pure virtual

Returns a middleware according to the component's settings.

Parameters
infois a handler info for the middleware.
middleware_configconfig 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()

template<typename MiddlewareBaseType , typename HandlerInfo >
virtual yaml_config::Schema middlewares::MiddlewareFactoryComponentBase< MiddlewareBaseType, HandlerInfo >::GetMiddlewareConfigSchema ( ) const
inlinevirtual

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

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

Definition at line 76 of file runner.hpp.

◆ GetStaticConfigSchema()

template<typename MiddlewareBaseType , typename HandlerInfo >
static yaml_config::Schema middlewares::MiddlewareFactoryComponentBase< MiddlewareBaseType, HandlerInfo >::GetStaticConfigSchema ( )
inlinestatic

Definition at line 78 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 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: