Common System 0.2.0
Common interfaces and patterns for system integration
Loading...
Searching...
No Matches
kcenon::common::interfaces::null_http_client Class Reference

Null implementation for when HTTP transport is disabled. More...

#include <http_client_interface.h>

Inheritance diagram for kcenon::common::interfaces::null_http_client:
Inheritance graph
Collaboration diagram for kcenon::common::interfaces::null_http_client:
Collaboration graph

Public Member Functions

::kcenon::common::Result< http_responsesend (const http_request &) override
 Send an HTTP request synchronously.
 
bool is_available () const override
 Check if the HTTP client is available and properly configured.
 
std::string get_implementation_name () const override
 Get the implementation name for logging/debugging.
 
- Public Member Functions inherited from kcenon::common::interfaces::IHttpClient
virtual ~IHttpClient ()=default
 

Detailed Description

Null implementation for when HTTP transport is disabled.

This implementation always returns errors, useful for testing or when HTTP functionality is intentionally disabled.

Definition at line 244 of file http_client_interface.h.

Member Function Documentation

◆ get_implementation_name()

std::string kcenon::common::interfaces::null_http_client::get_implementation_name ( ) const
inlinenodiscardoverridevirtual

Get the implementation name for logging/debugging.

Returns
Implementation identifier string

Implements kcenon::common::interfaces::IHttpClient.

Definition at line 257 of file http_client_interface.h.

257 {
258 return "null_http_client";
259 }

◆ is_available()

bool kcenon::common::interfaces::null_http_client::is_available ( ) const
inlinenodiscardoverridevirtual

Check if the HTTP client is available and properly configured.

Returns
true if client can make requests, false otherwise

Implements kcenon::common::interfaces::IHttpClient.

Definition at line 253 of file http_client_interface.h.

253 {
254 return false;
255 }

◆ send()

::kcenon::common::Result< http_response > kcenon::common::interfaces::null_http_client::send ( const http_request & request)
inlineoverridevirtual

Send an HTTP request synchronously.

Parameters
requestThe HTTP request to send
Returns
Result containing response or error information

Implements kcenon::common::interfaces::IHttpClient.

Definition at line 246 of file http_client_interface.h.

246 {
247 return ::kcenon::common::make_error<http_response>(
249 "HTTP client not available",
250 "null_http_client");
251 }
constexpr int NOT_INITIALIZED
Definition compat.h:36

References kcenon::common::error_codes::NOT_INITIALIZED.


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