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

Your opinion will help to improve our service

Leave a feedback >

Table of Contents

#include <userver/middlewares/runner.hpp>

Detailed Description

template<typename MiddlewareBase, typename HandlerInfo>
class middlewares::RunnerComponentBase< MiddlewareBase, HandlerInfo >

Base class for a component that runs middlewares.

There are a local and global configs of middlewares. Global config of middleware is a classic config in components_manager.components. You can override the global config for the specific service/client by the local config in the config of this component: see the 'middlewares' option.

RunnerComponentBase creates middleware instances using MiddlewareFactoryComponentBase. The Ordered list of middlewares RunnerComponentBase takes from Pipeline component. So, 'Pipeline' is responsible for the order of middlewares. RunnerComponentBase is responsible for creating middlewares and overriding configs.

Definition at line 117 of file runner.hpp.

+ Inheritance diagram for middlewares::RunnerComponentBase< MiddlewareBase, HandlerInfo >:

Public Member Functions

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 MiddlewareFactory = MiddlewareFactoryComponentBase<MiddlewareBase, HandlerInfo>
 
using LoggableComponentBase = ComponentBase
 

Protected Member Functions

 RunnerComponentBase (const components::ComponentConfig &config, const components::ComponentContext &context, std::string_view pipeline_name)
 

Member Typedef Documentation

◆ LoggableComponentBase

using components::ComponentBase::LoggableComponentBase = ComponentBase
protectedinherited
Deprecated
use components::ComponentBase instead.

Definition at line 67 of file component_base.hpp.

◆ MiddlewareFactory

template<typename MiddlewareBase , typename HandlerInfo >
using middlewares::RunnerComponentBase< MiddlewareBase, HandlerInfo >::MiddlewareFactory = MiddlewareFactoryComponentBase<MiddlewareBase, HandlerInfo>
protected

Definition at line 150 of file runner.hpp.

Constructor & Destructor Documentation

◆ RunnerComponentBase()

template<typename MiddlewareBase , typename HandlerInfo >
middlewares::RunnerComponentBase< MiddlewareBase, HandlerInfo >::RunnerComponentBase ( const components::ComponentConfig & config,
const components::ComponentContext & context,
std::string_view pipeline_name )
protected

Definition at line 173 of file runner.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.

◆ GetStaticConfigSchema()

template<typename MiddlewareBase , typename HandlerInfo >
static yaml_config::Schema middlewares::RunnerComponentBase< MiddlewareBase, HandlerInfo >::GetStaticConfigSchema ( )
inlinestatic

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