components::HttpClient Class Reference

#include <userver/clients/http/component.hpp>

Detailed Description

Component that manages clients::http::Client.

Returned references to clients::http::Client live for a lifetime of the component and are safe for concurrent use.

Dynamic options:

• HTTP_CLIENT_CONNECT_THROTTLE
• HTTP_CLIENT_CONNECTION_POOL_SIZE
• USERVER_HTTP_PROXY

Static options:

Name	Description	Default value
pool-statistics-disable	set to true to disable statistics for connection pool	false
thread-name-prefix	set OS thread name to this value	''
threads	number of threads to process low level HTTP related IO system calls	8
fs-task-processor	task processor to run blocking HTTP related calls, like DNS resolving or hosts reading	-
destination-metrics-auto-max-size	set max number of automatically created destination metrics	100
user-agent	User-Agent HTTP header to show on all requests, result of utils::GetUserverIdentifier() if empty	empty
bootstrap-http-proxy	HTTP proxy to use at service start. Will be overridden by USERVER_HTTP_PROXY at runtime config update	''
testsuite-enabled	enable testsuite testing support	false
testsuite-timeout	if set, force the request timeout regardless of the value passed in code	-
testsuite-allowed-url-prefixes	if set, checks that all URLs start with any of the passed prefixes, asserts if not. Set for testing purposes only.	''
dns_resolver	server hostname resolver type (getaddrinfo or async)	'async'
set-deadline-propagation-header	whether to set http::common::kXYaTaxiClientTimeoutMs request header, see Deadline propagation	true
plugins	Plugin names to apply. A plugin component is called "http-client-plugin-" plus the plugin name.	[]
cancellation-policy	Cancellation policy for new requests.	cancel

Static configuration example:

# yaml
    http-client:
      pool-statistics-disable: false
      thread-name-prefix: http-client
      threads: 2
      fs-task-processor: fs-task-processor
      destination-metrics-auto-max-size: 100
      user-agent: common_component_list sample
      testsuite-enabled: true
      testsuite-timeout: 5s
      testsuite-allowed-url-prefixes: ['http://localhost:8083/', 'http://localhost:8084/']

Examples

samples/flatbuf_service/flatbuf_service.cpp, and samples/s3api/src/s3api_client.cpp.

Definition at line 57 of file component.hpp.

Inheritance diagram for components::HttpClient:

Public Member Functions
	HttpClient (const ComponentConfig &, const ComponentContext &)
clients::http::Client &	GetHttpClient ()
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 = "http-client"
	The default name of components::HttpClient component.

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

Member Typedef Documentation

LoggableComponentBase

using components::ComponentBase::LoggableComponentBase = ComponentBase

protectedinherited

Legacy alias, use ComponentBase instead.

Definition at line 67 of file component_base.hpp.

Member Function Documentation

GetComponentHealth()

ComponentHealth components::ComponentBase::GetComponentHealth ( ) const

inlineoverridevirtualinherited

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.

OnAllComponentsAreStopping()

void components::ComponentBase::OnAllComponentsAreStopping ( )

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.

OnAllComponentsLoaded()

void components::ComponentBase::OnAllComponentsLoaded ( )

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.

OnLoadingCancelled()

void components::ComponentBase::OnLoadingCancelled ( )

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.

---

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

• userver/clients/http/component.hpp