server::middlewares::HeadersPropagatorFactory Class Reference

Detailed Description

Definition at line 21 of file headers_propagator.hpp.

Inheritance diagram for server::middlewares::HeadersPropagatorFactory:

Public Member Functions
	HeadersPropagatorFactory (const components::ComponentConfig &, const components::ComponentContext &)
std::unique_ptr< HttpMiddlewareBase >	CreateChecked (const handlers::HttpHandlerBase &handler, yaml_config::YamlConfig middleware_config) const
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 = "headers-propagator"

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

Protected Member Functions
virtual yaml_config::Schema	GetMiddlewareConfigSchema () const
	This method should return the schema of a middleware configuration, if any. You may override it.

Member Typedef Documentation

LoggableComponentBase

using components::ComponentBase::LoggableComponentBase = ComponentBase

protectedinherited

Legacy alias, use ComponentBase instead.

Definition at line 69 of file component_base.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.

Definition at line 35 of file component_base.hpp.

GetMiddlewareConfigSchema()

virtual yaml_config::Schema server::middlewares::HttpMiddlewareFactoryBase::GetMiddlewareConfigSchema ( ) const

inlineprotectedvirtualinherited

This method should return the schema of a middleware configuration, if any. You may override it.

Definition at line 68 of file http_middleware_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 60 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 53 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 44 of file component_base.hpp.

Member Data Documentation

kName

constexpr std::string_view server::middlewares::HeadersPropagatorFactory::kName = "headers-propagator"

staticconstexpr

Definition at line 23 of file headers_propagator.hpp.

---

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

• userver/server/middlewares/headers_propagator.hpp