#include <userver/components/component_base.hpp>
Base class for all application components, it depends on components::Logger and components::Tracer.
Definition at line 19 of file component_base.hpp.
Inherits components::RawComponentBase.
Inherited by components::CachingComponentBase< DataCacheContainerType< PostgreCachePolicy > >, components::CachingComponentBase< dynamic_config::DocsMap >, components::CachingComponentBase< MongoCacheTraits::DataType >, middlewares::RunnerComponentBase< MiddlewareBase, ServiceInfo >, middlewares::RunnerComponentBase< MiddlewareBase, ClientInfo >, , , , , , , baggage::BaggageManagerComponent, cache::LruCacheComponent< Key, Value, Hash, Equal >, clients::dns::Component, clients::http::MiddlewarePipelineComponent, clients::http::middlewares::ComponentBase, components::AuthCheckerSettings, components::CachingComponentBase< T >, components::ClickHouse, components::Container< T >, components::DefaultSecdistProvider, components::DumpConfigurator, components::DynamicConfigClient, components::DynamicConfigUpdatesSinkBase, components::DynamicRedis, components::FsCache, components::HttpClient, components::HttpClientCore, components::Mongo, components::MultiMongo, components::Postgres, components::ProcessStarter, components::RabbitMQ, components::Redis, components::SQLite, components::Secdist, components::Server, components::SingleThreadedTaskProcessors, components::SystemStatisticsCollector, components::TcpAcceptorBase, congestion_control::Component, easy::impl::DependenciesBase, engine::TaskProcessorsLoadMonitor, kafka::ConsumerComponent, kafka::ProducerComponent, middlewares::RunnerComponentBase< MiddlewareBase, HandlerInfo >, middlewares::impl::AnyMiddlewarePipelineComponent, middlewares::impl::WithMiddlewareDependencyComponentBase, server::handlers::HandlerBase, server::handlers::auth::digest::AuthCheckerSettingsComponent, server::middlewares::HandlerPipelineBuilder, server::middlewares::HttpMiddlewareFactoryBase, server::middlewares::PipelineBuilder, storages::mongo::DistLockComponentBase, storages::mysql::Component, storages::postgres::DistLockComponentBase, tracing::DefaultTracingManagerLocator, tracing::TracingManagerComponentBase, and ugrpc::client::CommonComponent.
Public Member Functions | |
| ComponentBase (const ComponentConfig &, const ComponentContext &) | |
| ComponentBase (ComponentBase &&)=delete | |
| ComponentBase (const ComponentBase &)=delete | |
| ~ComponentBase () override=default | |
| ComponentHealth | GetComponentHealth () const override |
| void | OnLoadingCancelled () override |
| void | OnAllComponentsLoaded () override |
| void | OnGracefulShutdown (engine::Deadline) override |
| void | OnAllComponentsAreStopping () override |
Static Public Member Functions | |
| static yaml_config::Schema | GetStaticConfigSchema () |
Protected Types | |
| using | LoggableComponentBase = ComponentBase |
|
protected |
Definition at line 79 of file component_base.hpp.
|
overridedefault |
It is a good place to stop your work here. All components dependent on the current component were destroyed. All components on which the current component depends are still alive.
|
inlineoverridevirtual |
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.
|
static |
If the component pulls more options from components::ComponentConfig than its parent component, then it needs to define GetStaticConfigSchema method and add its own options to the parent component's options.
|
inlineoverridevirtual |
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 components::Server, and urabbitmq::ConsumerComponentBase.
Definition at line 70 of file component_base.hpp.
|
inlineoverridevirtual |
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 components::Server, server::handlers::Ping, and urabbitmq::ConsumerComponentBase.
Definition at line 51 of file component_base.hpp.
|
overridevirtual |
Serving components like HTTP and gRPC servers may use this function to stop accepting new requests and shutdown serving in the given time interval. Application components likely do not need to override it.
| [in] | serving_shutdown_deadline | The deadline until already running requests should be allowed to complete. The component is supposed to stop accepting new requests and continue processing of already active requests until this deadline (unless those requests finish earlier). And it might completely shutdown requests processing when the deadline is reached (or when no active requests left). |
Reimplemented from components::RawComponentBase.
Reimplemented in components::Server.
|
inlineoverridevirtual |
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.
