server::middlewares::PipelineBuilder Class Reference

#include <userver/server/middlewares/configuration.hpp>

Detailed Description

Base class to build a server-wide middleware pipeline. One may inherit from it and implement any custom logic, if desired.

Definition at line 49 of file configuration.hpp.

Inheritance diagram for server::middlewares::PipelineBuilder:

Public Member Functions
	PipelineBuilder (const components::ComponentConfig &, const components::ComponentContext &)
virtual MiddlewaresList	BuildPipeline (MiddlewaresList userver_middleware_pipeline) const
	The method to build a server-wide middleware pipeline, one may override it if custom behavior is desired.
ComponentHealth	GetComponentHealth () const override
void	OnLoadingCancelled () override
void	OnAllComponentsLoaded () override
void	OnAllComponentsAreStopping () override

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

Static Public Attributes
static constexpr std::string_view	kName {"default-server-middleware-pipeline-builder"}

Protected Types
using	LoggableComponentBase = ComponentBase
	Legacy alias, use ComponentBase instead.

Protected Member Functions
const MiddlewaresList &	GetMiddlewaresToAppend () const

Member Typedef Documentation

LoggableComponentBase

using components::ComponentBase::LoggableComponentBase = ComponentBase

protectedinherited

Legacy alias, use ComponentBase instead.

Definition at line 67 of file component_base.hpp.

Member Function Documentation

BuildPipeline()

virtual MiddlewaresList server::middlewares::PipelineBuilder::BuildPipeline ( MiddlewaresList userver_middleware_pipeline ) const

inlinevirtual

The method to build a server-wide middleware pipeline, one may override it if custom behavior is desired.

Parameters

userver_middleware_pipeline

default userver-provided middleware pipeline

Note

We recommend against omitting/modifying default userver pipeline, but leave a possibility to do so.

Definition at line 62 of file configuration.hpp.

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.

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.

Member Data Documentation

kName

constexpr std::string_view server::middlewares::PipelineBuilder::kName {"default-server-middleware-pipeline-builder"}

staticconstexpr

Definition at line 51 of file configuration.hpp.

---

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

• userver/server/middlewares/configuration.hpp