#include <userver/server/middlewares/configuration.hpp>
Base class to build a per-handler middleware pipeline. One may inherit from it and implement any custom logic, if desired. By default the behavior is to use the server-wide pipeline.
Definition at line 85 of file configuration.hpp.
Inheritance diagram for server::middlewares::HandlerPipelineBuilder:Public Member Functions | |
| HandlerPipelineBuilder (const components::ComponentConfig &, const components::ComponentContext &) | |
| virtual MiddlewaresList | BuildPipeline (MiddlewaresList server_middleware_pipeline) const |
| The method to configure build a per-handler 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-handler-middleware-pipeline-builder"} |
Protected Types | |
| using | LoggableComponentBase = ComponentBase |
| Legacy alias, use ComponentBase instead. | |
|
protectedinherited |
Legacy alias, use ComponentBase instead.
Definition at line 67 of file component_base.hpp.
|
inlinevirtual |
The method to configure build a per-handler middleware pipeline, one may override it if custom behavior is desired.
For example, a ping/ handler doesn't necessary need any business-logic related functionality, and could use just DefaultPipeline() for itself.
| server_middleware_pipeline | the server-wide middleware pipeline |
Definition at line 98 of file configuration.hpp.
|
inlineoverridevirtualinherited |
Override this function to inform the world of the state of your component.
Reimplemented from components::RawComponentBase.
Reimplemented in server::handlers::Restart.
Definition at line 35 of file component_base.hpp.
|
staticinherited |
If the component pulls more options from ComponentConfig than its parent component, then it needs to define GetStaticConfigSchema method and add its own options to the parent component's options.
|
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.
|
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.
|
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.
|
staticconstexpr |
Definition at line 87 of file configuration.hpp.
