components::ComponentBase Class Reference

#include <userver/components/component_base.hpp>

Detailed Description

Base class for all application components, it depends on components::Logger and components::Tracer.

Examples

components/component_sample_test.cpp, components/component_sample_test.hpp, samples/flatbuf_service/flatbuf_service.cpp, samples/kafka_service/src/consumer_handler.hpp, samples/s3api/src/s3api_client.hpp, and samples/testsuite-support/src/tasks.cpp.

Definition at line 19 of file component_base.hpp.

Inherits components::RawComponentBase.

Inherited by components::CachingComponentBase< dynamic_config::DocsMap >, components::CachingComponentBase< MongoCacheTraits::DataType >, baggage::BaggageManagerComponent, cache::LruCacheComponent< Key, Value, Hash, Equal >, clients::dns::Component, clients::http::plugin::ComponentBase, components::AuthCheckerSettings, components::CachingComponentBase< T >, components::ClickHouse, components::DefaultSecdistProvider, components::DumpConfigurator, components::DynamicConfigClient, components::DynamicConfigUpdatesSinkBase, components::FsCache, components::HttpClient, components::Mongo, components::MultiMongo, components::Postgres, components::ProcessStarter, components::RabbitMQ, components::Redis, components::Secdist, components::Server, components::SingleThreadedTaskProcessors, components::SystemStatisticsCollector, components::TcpAcceptorBase, congestion_control::Component, engine::TaskProcessorsLoadMonitor, kafka::ConsumerComponent, kafka::ProducerComponent, 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, ugrpc::client::ClientFactoryComponent, ugrpc::client::CommonComponent, ugrpc::client::MiddlewareComponentBase, ugrpc::client::impl::SimpleClientComponentAny, ugrpc::server::MiddlewareComponentBase, ugrpc::server::ServerComponent, ugrpc::server::ServiceComponentBase, urabbitmq::ConsumerComponentBase, ydb::CredentialsProviderComponent, ydb::DistLockComponentBase, and ydb::YdbComponent.

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	OnAllComponentsAreStopping () override

Static Public Member Functions
static yaml_config::Schema	GetStaticConfigSchema ()

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

Member Typedef Documentation

LoggableComponentBase

using components::ComponentBase::LoggableComponentBase = ComponentBase

protected

Legacy alias, use ComponentBase instead.

Definition at line 67 of file component_base.hpp.

Constructor & Destructor Documentation

~ComponentBase()

components::ComponentBase::~ComponentBase ( )

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.

Member Function Documentation

GetComponentHealth()

ComponentHealth components::ComponentBase::GetComponentHealth ( ) const

inlineoverridevirtual

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.

Reimplemented in server::handlers::Restart.

Definition at line 35 of file component_base.hpp.

GetStaticConfigSchema()

static yaml_config::Schema components::ComponentBase::GetStaticConfigSchema ( )

static

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.

OnAllComponentsAreStopping()

void components::ComponentBase::OnAllComponentsAreStopping ( )

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 urabbitmq::ConsumerComponentBase, and components::Server.

Definition at line 58 of file component_base.hpp.

OnAllComponentsLoaded()

void components::ComponentBase::OnAllComponentsLoaded ( )

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 urabbitmq::ConsumerComponentBase, components::Server, and server::handlers::Ping.

Definition at line 51 of file component_base.hpp.

OnLoadingCancelled()

void components::ComponentBase::OnLoadingCancelled ( )

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.

---

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

• userver/components/component_base.hpp