Common System 0.2.0
Common interfaces and patterns for system integration
Loading...
Searching...
No Matches
kcenon::common::interfaces::IHttpClientProvider Interface Referenceabstract

Interface for modules that provide HTTP client implementations. More...

#include <http_client_interface.h>

Collaboration diagram for kcenon::common::interfaces::IHttpClientProvider:
Collaboration graph

Public Member Functions

virtual ~IHttpClientProvider ()=default
 
virtual std::shared_ptr< IHttpClientget_http_client ()=0
 Get the default HTTP client instance.
 
virtual std::shared_ptr< IHttpClientcreate_http_client (std::chrono::milliseconds timeout=std::chrono::milliseconds{30000})=0
 Create a new HTTP client with specific configuration.
 

Detailed Description

Interface for modules that provide HTTP client implementations.

Definition at line 271 of file http_client_interface.h.

Constructor & Destructor Documentation

◆ ~IHttpClientProvider()

virtual kcenon::common::interfaces::IHttpClientProvider::~IHttpClientProvider ( )
virtualdefault

Member Function Documentation

◆ create_http_client()

virtual std::shared_ptr< IHttpClient > kcenon::common::interfaces::IHttpClientProvider::create_http_client ( std::chrono::milliseconds timeout = std::chrono::milliseconds{30000})
pure virtual

Create a new HTTP client with specific configuration.

Parameters
timeoutDefault timeout for all requests
Returns
Shared pointer to the new HTTP client

◆ get_http_client()

virtual std::shared_ptr< IHttpClient > kcenon::common::interfaces::IHttpClientProvider::get_http_client ( )
pure virtual

Get the default HTTP client instance.

Returns
Shared pointer to the HTTP client

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