#include <Http.hpp>

Public Member Functions
	HTTP (std::string addr, int timeoutInMs=HTTP_TIMEOUT_MS)

	HTTP (const HTTP &)=delete
	Copy constructor.

	HTTP (HTTP &&)=delete
	Move constructor.

HTTP &	operator= (HTTP)=delete
	Copy assignment operator.

HTTP &	operator= (HTTP &&)=delete
	Move assignment operator.

template<typename T >
bool	setOption (CURLoption option, T value)

const std::string &	getHostAddress () const

CURLcode	sendGETRequest (const std::string &index, std::string &receivedData, HttpStatus::Code &statusCode)

CURLcode	sendHEADRequest (const std::string &index, std::string &receivedData, HttpStatus::Code &statusCode)

CURLcode	sendPOSTRequest (const std::string &index, const std::string &payload, std::string &receivedData, HttpStatus::Code &statusCode)

CURLcode	sendPUTRequest (const std::string &index, const std::string &payload, std::string &receivedData, HttpStatus::Code &statusCode)

HTTPStats	getStats ()

	~HTTP ()

Private Member Functions
void	setCommonFields (const std::string &fullURL, std::string &receivedData, CURLoption method)

void	setCommonFields (const std::string &fullURL, std::string &receivedData, CURLoption method, const std::string &payload)

CURLcode	performRequest (HttpStatus::Code &statusCode)

Static Private Member Functions
static size_t	writeDataCallback (const char contents, size_t size, size_t nmemb, std::string userp)

Private Attributes
CURL *	_curl = curl_easy_init()
	CURL handler.

std::string	_hostAddr
	Full path of server.

Detailed Description

Represents an HTTP client connection

Definition at line 43 of file Http.hpp.

Constructor & Destructor Documentation

◆ HTTP() [1/3]

HTTP::HTTP	(	std::string	addr,
		int	timeoutInMs = HTTP_TIMEOUT_MS )

explicit

Constructs a new HTTP object

Parameters

[in]	addr	The full path to the server
[in]	timeoutInMs	The connection timeout in milliseconds

Definition at line 46 of file Http.cpp.

                                          : _hostAddr(std::move(addr))
{
    if (_curl == nullptr)
    {
        throw std::invalid_argument("Can't init curl context");
    }
 
    curl_easy_setopt(_curl, CURLOPT_VERBOSE, 0L);
    curl_easy_setopt(_curl, CURLOPT_FOLLOWLOCATION, 1L);
    curl_easy_setopt(_curl, CURLOPT_TIMEOUT_MS, timeoutInMs);
    curl_easy_setopt(_curl, CURLOPT_CONNECTTIMEOUT_MS, timeoutInMs);
    curl_easy_setopt(_curl, CURLOPT_WRITEFUNCTION, writeDataCallback);
 
    curl_easy_setopt(_curl, CURLOPT_SSLENGINE_DEFAULT, 1L);
    curl_easy_setopt(_curl, CURLOPT_SSLVERSION, CURL_SSLVERSION_TLSv1_2); // At least TLSv1.2
}

Here is the call graph for this function:

◆ HTTP() [2/3]

HTTP::HTTP ( const HTTP & )

delete

Copy constructor.

◆ HTTP() [3/3]

HTTP::HTTP ( HTTP && )

delete

Move constructor.

◆ ~HTTP()

HTTP::~HTTP ( )

Destroys the HTTP object

Definition at line 126 of file Http.cpp.

126{ curl_easy_cleanup(_curl); }

Member Function Documentation

◆ getHostAddress()

const std::string & HTTP::getHostAddress ( ) const

inlinenodiscard

Gets the host address of the object

Returns: The host address

Definition at line 120 of file Http.hpp.

120{ return _hostAddr; }

◆ getStats()

HTTPStats HTTP::getStats ( )

Gets the statistics of the HTTP object

Returns: The produced statistics

Definition at line 93 of file Http.cpp.

{
    HTTPStats stats{};
 
    curl_off_t value = 0;
    curl_easy_getinfo(_curl, CURLINFO_SIZE_UPLOAD_T, &value);
    stats.uploadBytes = static_cast<size_t>(value);
    curl_easy_getinfo(_curl, CURLINFO_SIZE_DOWNLOAD_T, &value);
    stats.downloadBytes = static_cast<size_t>(value);
    curl_easy_getinfo(_curl, CURLINFO_HEADER_SIZE, &value);
    stats.headerBytes = static_cast<size_t>(value);
    curl_easy_getinfo(_curl, CURLINFO_REQUEST_SIZE, &value);
    stats.requestBytes = static_cast<size_t>(value);
    curl_easy_getinfo(_curl, CURLINFO_SPEED_UPLOAD_T, &value);
    stats.uploadSpeed = value;
    curl_easy_getinfo(_curl, CURLINFO_SPEED_DOWNLOAD_T, &value);
    stats.downloadSpeed = value;
    curl_easy_getinfo(_curl, CURLINFO_CONNECT_TIME_T, &value);
    stats.connectionTime = value;
    curl_easy_getinfo(_curl, CURLINFO_NAMELOOKUP_TIME_T, &value);
    stats.nameLookupTime = value;
    curl_easy_getinfo(_curl, CURLINFO_PRETRANSFER_TIME_T, &value);
    stats.preTransferTime = value;
    curl_easy_getinfo(_curl, CURLINFO_REDIRECT_TIME_T, &value);
    stats.redirectTime = value;
    curl_easy_getinfo(_curl, CURLINFO_STARTTRANSFER_TIME_T, &value);
    stats.startTransferTime = value;
    curl_easy_getinfo(_curl, CURLINFO_TOTAL_TIME_T, &value);
    stats.totalTime = value;
 
    return stats;
}

◆ operator=() [1/2]

HTTP & HTTP::operator= ( HTTP && )

delete

Move assignment operator.

◆ operator=() [2/2]

HTTP & HTTP::operator= ( HTTP )

delete

Copy assignment operator.

◆ performRequest()

CURLcode HTTP::performRequest ( HttpStatus::Code & statusCode )

private

Performs the request

Parameters

[out] statusCode The HTTP status code (set if CURLE_OK, otherwise unchanged)

Returns: The status of the operation. CURLE_OK if successful.

Definition at line 23 of file Http.cpp.

{
    // Perform request
    auto status = static_cast<long>(HttpStatus::Code::xxx_max);
    const CURLcode retval = curl_easy_perform(_curl);
    if (retval == CURLE_OK)
    {
        curl_easy_getinfo(_curl, CURLINFO_RESPONSE_CODE, &status);
    }
    statusCode = static_cast<HttpStatus::Code>(status);
 
    return retval;
}

Here is the caller graph for this function:

◆ sendGETRequest()

CURLcode HTTP::sendGETRequest	(	const std::string &	index,
		std::string &	receivedData,
		HttpStatus::Code &	statusCode )

Sends a GET request

Parameters

[in]	index	The value to append to the server address
[out]	receivedData	The received reply from the server
[out]	statusCode	The HTTP status code (set if CURLE_OK, otherwise unchanged)

Returns: The status of the operation. CURLE_OK if successful.

Definition at line 63 of file Http.cpp.

{
    // Prepare request specific options
    setCommonFields(_hostAddr + index, receivedData, CURLOPT_HTTPGET);
    return performRequest(statusCode);
}

Here is the call graph for this function:

◆ sendHEADRequest()

CURLcode HTTP::sendHEADRequest	(	const std::string &	index,
		std::string &	receivedData,
		HttpStatus::Code &	statusCode )

Sends a HEAD request

Parameters

[in]	index	The value to append to the server address
[out]	receivedData	The received reply from the server
[out]	statusCode	The HTTP status code (set if CURLE_OK, otherwise unchanged)

Returns: The status of the operation. CURLE_OK if successful.

Definition at line 70 of file Http.cpp.

{
    // Prepare request specific options
    setCommonFields(_hostAddr + index, receivedData, CURLOPT_NOBODY);
    return performRequest(statusCode);
}

Here is the call graph for this function:

◆ sendPOSTRequest()

CURLcode HTTP::sendPOSTRequest	(	const std::string &	index,
		const std::string &	payload,
		std::string &	receivedData,
		HttpStatus::Code &	statusCode )

Sends a POST request

Parameters

[in]	index	The value to append to the server address
[in]	payload	The payload to send to the server
[out]	receivedData	The received reply from the server
[out]	statusCode	The HTTP status code (set if CURLE_OK, otherwise unchanged)

Returns: The status of the operation. CURLE_OK if successful.

Definition at line 77 of file Http.cpp.

{
    // Prepare request specific options
    setCommonFields(_hostAddr + index, receivedData, CURLOPT_POST, payload);
    return performRequest(statusCode);
}

Here is the call graph for this function:

◆ sendPUTRequest()

CURLcode HTTP::sendPUTRequest	(	const std::string &	index,
		const std::string &	payload,
		std::string &	receivedData,
		HttpStatus::Code &	statusCode )

Sends a PUT request

Parameters

[in]	index	The value to append to the server address
[in]	payload	The payload to send to the server
[out]	receivedData	The received reply from the server
[out]	statusCode	The HTTP status code (set if CURLE_OK, otherwise unchanged)

Returns: The status of the operation. CURLE_OK if successful.

Definition at line 85 of file Http.cpp.

{
    // Prepare request specific options
    setCommonFields(_hostAddr + index, receivedData, CURLOPT_UPLOAD, payload);
    return performRequest(statusCode);
}

Here is the call graph for this function:

◆ setCommonFields() [1/2]

void HTTP::setCommonFields	(	const std::string &	fullURL,
		std::string &	receivedData,
		CURLoption	method )

private

Sets common fields for HTTP requests

Parameters

[in]	fullURL	The full URL of the request
[out]	receivedData	The received data from the server
[in]	method	The HTTP method to use

Definition at line 6 of file Http.cpp.

{
    curl_easy_setopt(_curl, CURLOPT_URL, fullURL.c_str());
    curl_easy_setopt(_curl, CURLOPT_WRITEDATA, static_cast<void *>(&receivedData)); // Register user-supplied memory
    curl_easy_setopt(_curl, method, 1L);
}

Here is the caller graph for this function:

◆ setCommonFields() [2/2]

void HTTP::setCommonFields	(	const std::string &	fullURL,
		std::string &	receivedData,
		CURLoption	method,
		const std::string &	payload )

private

Sets common fields for HTTP requests with payload

Parameters

[in]	fullURL	The full URL of the request
[out]	receivedData	The received data from the server
[in]	method	The HTTP method to use
[in]	payload	The payload to send to the server

Definition at line 13 of file Http.cpp.

{
    curl_easy_setopt(_curl, CURLOPT_POSTFIELDS, payload.c_str());
    curl_easy_setopt(_curl, CURLOPT_POSTFIELDSIZE_LARGE, payload.size());
    curl_easy_setopt(_curl, CURLOPT_URL, fullURL.c_str());
    curl_easy_setopt(_curl, CURLOPT_WRITEDATA, static_cast<void *>(&receivedData)); // Register user-supplied memory
    curl_easy_setopt(_curl, method, 1L);
}

◆ setOption()

template<typename T >

bool HTTP::setOption	(	CURLoption	option,
		T	value )

inline

Sets an option for the HTTP object

Parameters

[in]	option	The CURL option to set
[in]	value	The corresponding value

Returns: true if the option was set successfully, false otherwise

Definition at line 111 of file Http.hpp.

    {
        return curl_easy_setopt(_curl, option, value) == CURLE_OK;
    }

◆ writeDataCallback()

size_t HTTP::writeDataCallback	(	const char *	contents,
		size_t	size,
		size_t	nmemb,
		std::string *	userp )

staticprivate

Callback function for writing received data

Parameters

[in]	contents	The received data
[in]	size	The size of each element
[in]	nmemb	The number of elements
[in]	userp	User pointer to a string

Returns: The total size of the received data

Definition at line 37 of file Http.cpp.

{
    const size_t recvSize = size * nmemb;
    // Userp always referenced, there is no possibility of userp is nullptr. Directly use without checking
    userp->assign(contents, contents + recvSize);
 
    return recvSize;
}

Here is the caller graph for this function:

Member Data Documentation

◆ _curl

CURL* HTTP::_curl = curl_easy_init()

private

CURL handler.

Definition at line 46 of file Http.hpp.

◆ _hostAddr

std::string HTTP::_hostAddr

private

Full path of server.

Definition at line 48 of file Http.hpp.

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

/__w/Repo-Init/Repo-Init/include/connection/Http.hpp
/__w/Repo-Init/Repo-Init/src/connection/Http.cpp

Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ HTTP() [1/3]

◆ HTTP() [2/3]

◆ HTTP() [3/3]

◆ ~HTTP()

Member Function Documentation

◆ getHostAddress()

◆ getStats()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ performRequest()

◆ sendGETRequest()

◆ sendHEADRequest()

◆ sendPOSTRequest()

◆ sendPUTRequest()

◆ setCommonFields() [1/2]

◆ setCommonFields() [2/2]

◆ setOption()

◆ writeDataCallback()

Member Data Documentation

◆ _curl

◆ _hostAddr