clients::http::Client Class Reference

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

Detailed Description

HTTP client interface that returns a HTTP request builder from CreateRequest().

Usually retrieved from components::HttpClient component. You can also create a client manually using clients::http::CreateStandaloneHttpClient()

Example usage:

    const auto response = http_client_ptr->CreateRequest().post(url, data).timeout(std::chrono::seconds(1)).perform();
 
    EXPECT_TRUE(response->IsOk());

Examples

libraries/easy/samples/4_custom_dependency/main.cpp, libraries/easy/samples/5_pg_service_template/src/main.cpp, and samples/s3api/src/s3api_client.hpp.

Definition at line 27 of file client.hpp.

Inheritance diagram for clients::http::Client:

Public Member Functions
	Client (const Client &)=delete
	Client (Client &&)=delete
Client &	operator= (const Client &)=delete
Client &	operator= (Client &&)=delete
virtual Request	CreateRequest ()=0
	Returns a HTTP request builder type with some preset values.
Request	CreateNotSignedRequest ()
	Providing CreateNonSignedRequest() function for the clients::Http alias.

Member Function Documentation

CreateNotSignedRequest()

Request clients::http::Client::CreateNotSignedRequest ( )

inline

Providing CreateNonSignedRequest() function for the clients::Http alias.

Note

This method is thread-safe despite being non-const.

Definition at line 46 of file client.hpp.

CreateRequest()

virtual Request clients::http::Client::CreateRequest ( )

pure virtual

Returns a HTTP request builder type with some preset values.

Note

This method is thread-safe despite being non-const.

Implemented in clients::http::ClientCore, and clients::http::ClientWithPlugins.

Examples

libraries/easy/samples/4_custom_dependency/main.cpp, and libraries/easy/samples/5_pg_service_template/src/main.cpp.

---

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

• userver/clients/http/client.hpp