Your opinion will help to improve our service
Leave a feedback >#include <userver/middlewares/runner.hpp>
Base class for middleware factory component.
Definition at line 52 of file runner.hpp.
Public Types | |
using | MiddlewareBase = MiddlewareBaseType |
Public Member Functions | |
MiddlewareFactoryComponentBase (const components::ComponentConfig &config, const components::ComponentContext &context, MiddlewareDependencyBuilder &&builder=impl::MakeDefaultUserDependency()) | |
virtual std::shared_ptr< MiddlewareBase > | CreateMiddleware (const HandlerInfo &info, const yaml_config::YamlConfig &middleware_config) const =0 |
Returns a middleware according to the component's settings. | |
virtual yaml_config::Schema | GetMiddlewareConfigSchema () const |
This method should return the schema of a middleware configuration. Always write return GetStaticConfigSchema(); in this method. | |
ComponentHealth | GetComponentHealth () const override |
void | OnLoadingCancelled () override |
void | OnAllComponentsLoaded () override |
void | OnAllComponentsAreStopping () override |
Static Public Member Functions | |
static yaml_config::Schema | GetStaticConfigSchema () |
Protected Types | |
using | LoggableComponentBase = ComponentBase |
|
protectedinherited |
Definition at line 67 of file component_base.hpp.
using middlewares::MiddlewareFactoryComponentBase< MiddlewareBaseType, HandlerInfo >::MiddlewareBase = MiddlewareBaseType |
Definition at line 54 of file runner.hpp.
|
inline |
Definition at line 56 of file runner.hpp.
|
pure virtual |
Returns a middleware according to the component's settings.
info | is a handler info for the middleware. |
middleware_config | config for the middleware. |
info
by reference. info
object will be dropped after the CreateMiddleware
call.
|
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.
|
inlinevirtual |
This method should return the schema of a middleware configuration. Always write return GetStaticConfigSchema();
in this method.
Reimplemented in ugrpc::client::middlewares::log::Component, ugrpc::server::middlewares::headers_propagator::Component, and ugrpc::server::middlewares::log::Component.
Definition at line 76 of file runner.hpp.
|
inlinestatic |
Definition at line 78 of file runner.hpp.
|
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.