kcenon::common::interfaces::http_request Struct Reference

Represents an HTTP request. More...

#include <http_client_interface.h>

Collaboration diagram for kcenon::common::interfaces::http_request:

Public Member Functions
	http_request ()=default
	http_request (std::string url_)
	http_request (std::string url_, std::string method_)
	http_request (std::string url_, std::string method_, http_headers headers_)
	http_request (std::string url_, std::string method_, http_headers headers_, std::vector< uint8_t > body_)
http_request &	set_content_type (const std::string &content_type)
	Set Content-Type header.
http_request &	set_authorization (const std::string &auth)
	Set Authorization header.
http_request &	set_body (const std::string &str)
	Set body from string.

Public Attributes
std::string	url
	Request URL (must include scheme, e.g., "https://api.example.com/v1/data")
std::string	method = "GET"
	HTTP method (GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS)
http_headers	headers
	Request headers.
std::vector< uint8_t >	body
	Request body (for POST, PUT, PATCH)
std::chrono::milliseconds	timeout {30000}
	Request timeout (default: 30 seconds)
bool	follow_redirects = true
	Whether to follow redirects (default: true)
int	max_redirects = 5
	Maximum number of redirects to follow (default: 5)

Detailed Description

Represents an HTTP request.

Definition at line 37 of file http_client_interface.h.

Constructor & Destructor Documentation

http_request() [1/5]

kcenon::common::interfaces::http_request::http_request ( )

default

http_request() [2/5]

kcenon::common::interfaces::http_request::http_request ( std::string url_ )

inlineexplicit

Definition at line 63 of file http_client_interface.h.

        : url(std::move(url_)) {}

http_request() [3/5]

kcenon::common::interfaces::http_request::http_request ( std::string url_, std::string method_ )

inline

Definition at line 66 of file http_client_interface.h.

        : url(std::move(url_)), method(std::move(method_)) {}

http_request() [4/5]

kcenon::common::interfaces::http_request::http_request ( std::string url_, std::string method_, http_headers headers_ )

inline

Definition at line 69 of file http_client_interface.h.

        : url(std::move(url_))
        , method(std::move(method_))
        , headers(std::move(headers_)) {}

http_request() [5/5]

kcenon::common::interfaces::http_request::http_request ( std::string url_, std::string method_, http_headers headers_, std::vector< uint8_t > body_ )

inline

Definition at line 74 of file http_client_interface.h.

        : url(std::move(url_))
        , method(std::move(method_))
        , headers(std::move(headers_))
        , body(std::move(body_)) {}

Member Function Documentation

set_authorization()

http_request & kcenon::common::interfaces::http_request::set_authorization ( const std::string & auth )

inline

Set Authorization header.

Parameters

auth	Authorization value (e.g., "Bearer token123")

Returns

Reference to this for chaining

Definition at line 98 of file http_client_interface.h.

                                                           {
        headers["Authorization"] = auth;
        return *this;
    }

References headers.

set_body()

http_request & kcenon::common::interfaces::http_request::set_body ( const std::string & str )

inline

Set body from string.

Parameters

str	String body content

Returns

Reference to this for chaining

Definition at line 108 of file http_client_interface.h.

                                                 {
        body.assign(str.begin(), str.end());
        return *this;
    }

References body.

set_content_type()

http_request & kcenon::common::interfaces::http_request::set_content_type ( const std::string & content_type )

inline

Set Content-Type header.

Parameters

content_type

MIME type string

Returns

Reference to this for chaining

Definition at line 88 of file http_client_interface.h.

                                                                  {
        headers["Content-Type"] = content_type;
        return *this;
    }

References headers.

Member Data Documentation

body

std::vector<uint8_t> kcenon::common::interfaces::http_request::body

Request body (for POST, PUT, PATCH)

Definition at line 48 of file http_client_interface.h.

Referenced by set_body().

follow_redirects

bool kcenon::common::interfaces::http_request::follow_redirects = true

Whether to follow redirects (default: true)

Definition at line 54 of file http_client_interface.h.

headers

http_headers kcenon::common::interfaces::http_request::headers

Request headers.

Definition at line 45 of file http_client_interface.h.

Referenced by set_authorization(), and set_content_type().

max_redirects

int kcenon::common::interfaces::http_request::max_redirects = 5

Maximum number of redirects to follow (default: 5)

Definition at line 57 of file http_client_interface.h.

method

std::string kcenon::common::interfaces::http_request::method = "GET"

HTTP method (GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS)

Definition at line 42 of file http_client_interface.h.

timeout

std::chrono::milliseconds kcenon::common::interfaces::http_request::timeout {30000}

Request timeout (default: 30 seconds)

Definition at line 51 of file http_client_interface.h.

{30000};

url

std::string kcenon::common::interfaces::http_request::url

Request URL (must include scheme, e.g., "https://api.example.com/v1/data")

Definition at line 39 of file http_client_interface.h.

---

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

• include/kcenon/common/interfaces/transport/http_client_interface.h