mastodonpp::CURLWrapper Class Reference

Handles the details of network connections. More...

#include <mastodonpp/curl_wrapper.hpp>

Inheritance diagram for mastodonpp::CURLWrapper:

Public Member Functions
	CURLWrapper ()
	Initializes curl and sets up connection. More...
	CURLWrapper (const CURLWrapper &other)=delete
	Copy constructor. More...
	CURLWrapper (CURLWrapper &&other) noexcept=delete
	Move constructor. More...
virtual	~CURLWrapper () noexcept
	Cleans up curl and connection. More...
CURLWrapper &	operator= (const CURLWrapper &other)=delete
	Copy assignment operator. More...
CURLWrapper &	operator= (CURLWrapper &&other) noexcept=delete
	Move assignment operator. More...
CURL *	get_curl_easy_handle ()
	Returns pointer to the CURL easy handle. More...
void	set_proxy (string_view proxy)
	Set the proxy to use. More...
void	cancel_stream ()
	Cancel the stream. More...

Protected Member Functions
answer_type	make_request (const http_method &method, string uri, const parametermap &parameters)
	Make a HTTP request. More...
string &	get_buffer ()
	Returns a reference to the buffer libcurl writes into. More...

Protected Attributes
mutex	buffer_mutex
	Mutex for get_buffer a.k.a. _curl_buffer_body. More...

Detailed Description

Handles the details of network connections.

You don't need to use this.

Since

0.1.0

Constructor & Destructor Documentation

CURLWrapper() [1/3]

mastodonpp::CURLWrapper::CURLWrapper

(

)

Initializes curl and sets up connection.

The first time an instance of CURLWrapper is created, it calls curl_global_init, which is not thread-safe. For more information consult curl_global_init(3).

Since

0.1.0

    : _curl_buffer_error{}
    , _stream_cancelled(false)
{
    if (curlwrapper_instances == 0)
    {
        curl_global_init(CURL_GLOBAL_ALL); // NOLINT(hicpp-signed-bitwise)
    }
    ++curlwrapper_instances;
    debuglog << "CURLWrapper instances: " << curlwrapper_instances << " (+1)\n";
 
    _connection = curl_easy_init();
    setup_curl();
}

CURLWrapper() [2/3]

mastodonpp::CURLWrapper::CURLWrapper ( const CURLWrapper &  other )

delete

Copy constructor.

CURLWrapper() [3/3]

mastodonpp::CURLWrapper::CURLWrapper ( CURLWrapper &&  other )

deletenoexcept

Move constructor.

~CURLWrapper()

mastodonpp::CURLWrapper::~CURLWrapper ( )

virtualnoexcept

Cleans up curl and connection.

Calls curl_global_cleanup, which is not thread-safe. For more information consult curl_global_cleanup(3).

Since

0.1.0

{
    curl_easy_cleanup(_connection);
 
    --curlwrapper_instances;
    debuglog << "CURLWrapper instances: " << curlwrapper_instances << " (-1)\n";
    if (curlwrapper_instances == 0)
    {
        curl_global_cleanup();
    }
}

Member Function Documentation

cancel_stream()

void mastodonpp::CURLWrapper::cancel_stream

(

)

Cancel the stream.

The stream will be cancelled, usually whithin a second. The curl_error_code of the answer will be set to 42 (CURLE_ABORTED_BY_CALLBACK).

Since

0.1.0

{
    _stream_cancelled = true;
}

get_buffer()

string& mastodonpp::CURLWrapper::get_buffer ( )

inlineprotected

Returns a reference to the buffer libcurl writes into.

Since

0.1.0

    {
        return _curl_buffer_body;
    }

get_curl_easy_handle()

CURL* mastodonpp::CURLWrapper::get_curl_easy_handle ( )

inline

Returns pointer to the CURL easy handle.

You can use this handle to set or modify curl options. For more information consult curl_easy_setopt(3).

Since

0.1.0

    {
        return _connection;
    }

make_request()

answer_type mastodonpp::CURLWrapper::make_request ( const http_method &  method, string  uri, const parametermap &  parameters  )

protected

Make a HTTP request.

Parameters

method	The HTTP method.
uri	The full URI.
parameters	A map of parameters.

Since

0.1.0

{
    _stream_cancelled = false;
    _curl_buffer_headers.clear();
    _curl_buffer_body.clear();
 
    CURLcode code;
    switch (method)
    {
    case http_method::GET:
    {
        // NOLINTNEXTLINE(cppcoreguidelines-pro-type-vararg)
        code = curl_easy_setopt(_connection, CURLOPT_HTTPGET, 1L);
 
        add_parameters_to_uri(uri, parameters);
 
        break;
    }
    case http_method::POST:
    {
        // NOLINTNEXTLINE(cppcoreguidelines-pro-type-vararg)
        code = curl_easy_setopt(_connection, CURLOPT_POST, 1L);
        break;
    }
    case http_method::PATCH:
    {
        // NOLINTNEXTLINE(cppcoreguidelines-pro-type-vararg)
        code = curl_easy_setopt(_connection, CURLOPT_CUSTOMREQUEST, "PATCH");
        break;
    }
    case http_method::PUT:
    {
        // NOLINTNEXTLINE(cppcoreguidelines-pro-type-vararg)
        code = curl_easy_setopt(_connection, CURLOPT_UPLOAD, 1L);
        break;
    }
    case http_method::DELETE:
    {
        // NOLINTNEXTLINE(cppcoreguidelines-pro-type-vararg)
        code = curl_easy_setopt(_connection, CURLOPT_CUSTOMREQUEST, "DELETE");
        break;
    }
    }
    if (code != CURLE_OK)
    {
        throw CURLException{code, "Failed to set HTTP method",
                _curl_buffer_error};
    }
    debuglog << "Making request to: " << uri << '\n';
 
    // NOLINTNEXTLINE(cppcoreguidelines-pro-type-vararg)
    code = curl_easy_setopt(_connection, CURLOPT_URL, uri.data());
    if (code != CURLE_OK)
    {
        throw CURLException{code, "Failed to set URI", _curl_buffer_error};
    }
 
    answer_type answer;
    code = curl_easy_perform(_connection);
    if (code == CURLE_OK
        || (code == CURLE_ABORTED_BY_CALLBACK && _stream_cancelled))
    {
        long http_status;       // NOLINT(google-runtime-int)
        // NOLINTNEXTLINE(cppcoreguidelines-pro-type-vararg)
        curl_easy_getinfo(_connection, CURLINFO_RESPONSE_CODE, &http_status);
        answer.http_status = static_cast<uint16_t>(http_status);
        debuglog << "HTTP status code: " << http_status << '\n';
 
        answer.headers = _curl_buffer_headers;
        answer.body = _curl_buffer_body;
    }
    else
    {
        answer.curl_error_code = static_cast<uint8_t>(code);
        answer.error_message = _curl_buffer_error;
        debuglog << "libcurl error: " << code << '\n';
        debuglog << _curl_buffer_error << '\n';
    }
 
    return answer;
}

operator=() [1/2]

CURLWrapper& mastodonpp::CURLWrapper::operator= ( const CURLWrapper &  other )

delete

Copy assignment operator.

operator=() [2/2]

CURLWrapper& mastodonpp::CURLWrapper::operator= ( CURLWrapper &&  other )

deletenoexcept

Move assignment operator.

set_proxy()

void mastodonpp::CURLWrapper::set_proxy

(

string_view

proxy

)

Set the proxy to use.

See CURLOPT_PROXY(3).

Parameters

proxy

Examples: "socks4a://127.0.0.1:9050", "http://[::1]:3128".

Since

0.1.0

{
    // NOLINTNEXTLINE(cppcoreguidelines-pro-type-vararg)
    CURLcode code = curl_easy_setopt(_connection, CURLOPT_PROXY, proxy);
    if (code != CURLE_OK)
    {
        throw CURLException{code, "Failed to set proxy", _curl_buffer_error};
    }
}

Member Data Documentation

buffer_mutex

mutex mastodonpp::CURLWrapper::buffer_mutex

protected

Mutex for get_buffer a.k.a. _curl_buffer_body.

This mutex is locked in writer_body() and Connection::get_new_stream_contents before anything is read or written from/to _curl_buffer_body.

Since

0.1.0

---

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

• include/curl_wrapper.hpp
• src/curl_wrapper.cpp