server::middlewares::PipelineBuilder Class Reference

Table of Contents

• Detailed Description
• Public Member Functions
• Static Public Member Functions
• Static Public Attributes
• Protected Member Functions
• Member Function Documentation
• BuildPipeline()
• Member Data Documentation
• kName

#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:

Collaboration 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.
Public Member Functions inherited from components::LoggableComponentBase
	LoggableComponentBase (const ComponentConfig &, const ComponentContext &)
	LoggableComponentBase (LoggableComponentBase &&)=delete
	LoggableComponentBase (const LoggableComponentBase &)=delete
	~LoggableComponentBase () override=default
ComponentHealth	GetComponentHealth () const override
void	OnLoadingCancelled () override
void	OnAllComponentsLoaded () override
void	OnAllComponentsAreStopping () override

Static Public Member Functions
static yaml_config::Schema	GetStaticConfigSchema ()
Static Public Member Functions inherited from components::LoggableComponentBase
static yaml_config::Schema	GetStaticConfigSchema ()

Static Public Attributes
static constexpr std::string_view	kName

Protected Member Functions
const MiddlewaresList &	GetMiddlewaresToAppend () const

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 64 of file configuration.hpp.

Member Data Documentation

kName

constexpr std::string_view server::middlewares::PipelineBuilder::kName

staticconstexpr

Initial value:

{
      "default-server-middleware-pipeline-builder"}

Definition at line 51 of file configuration.hpp.

---

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

• userver/server/middlewares/configuration.hpp