userver: server::middlewares::HttpMiddlewareFactoryBase Class Reference
Loading...
Searching...
No Matches
server::middlewares::HttpMiddlewareFactoryBase Class Referenceabstract

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

Detailed Description

Base class for a http middleware-factory.

Definition at line 55 of file http_middleware_base.hpp.

+ Inheritance diagram for server::middlewares::HttpMiddlewareFactoryBase:
+ Collaboration diagram for server::middlewares::HttpMiddlewareFactoryBase:

Public Member Functions

 HttpMiddlewareFactoryBase (const components::ComponentConfig &, const components::ComponentContext &)
 
std::unique_ptr< HttpMiddlewareBaseCreateChecked (const handlers::HttpHandlerBase &handler, yaml_config::YamlConfig middleware_config) const
 
- 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
 

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.
 
virtual std::unique_ptr< HttpMiddlewareBaseCreate (const handlers::HttpHandlerBase &, yaml_config::YamlConfig middleware_config) const =0
 Override this method to create an instance of a middleware.
 

Additional Inherited Members

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

Member Function Documentation

◆ GetMiddlewareConfigSchema()

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

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

Definition at line 67 of file http_middleware_base.hpp.


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