mastodonpp::Connection Class Reference

Represents a connection to an instance. Used for requests. More...

#include <mastodonpp/connection.hpp>

Inheritance diagram for mastodonpp::Connection:

Public Member Functions
	Connection (Instance &instance)
	Construct a new Connection object. More...
answer_type	get (const endpoint_variant &endpoint, const parametermap &parameters)
	Make a HTTP GET call with parameters. More...
answer_type	get (const endpoint_variant &endpoint)
	Make a HTTP GET call. More...
void	set_proxy (string_view proxy)
	Set the proxy to use. More...
string	get_new_stream_contents ()
	Copy new stream contents and delete the “original”. More...
Public Member Functions inherited from mastodonpp::CURLWrapper
	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...

Additional Inherited Members
Protected Member Functions inherited from mastodonpp::CURLWrapper
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 inherited from mastodonpp::CURLWrapper
mutex	buffer_mutex
	Mutex for get_buffer a.k.a. _curl_buffer_body. More...

Detailed Description

Represents a connection to an instance. Used for requests.

Since

0.1.0

Constructor & Destructor Documentation

Connection()

mastodonpp::Connection::Connection ( Instance &  instance )

explicit

Construct a new Connection object.

Parameters

instance

An Instance with the access data.

Since

0.1.0

    : _instance{instance}
    , _baseuri{instance.get_baseuri()}
{}

Member Function Documentation

get() [1/2]

answer_type mastodonpp::Connection::get ( const endpoint_variant &  endpoint )

inline

Make a HTTP GET call.

Example:

auto answer{connection.get("/api/v1/instance")};

Parameters

endpoint

Endpoint as API::endpoint_type or std::string_view.

Since

0.1.0

    {
        return get(endpoint, {});
    }

get() [2/2]

answer_type mastodonpp::Connection::get	(	const endpoint_variant &	endpoint,
		const parametermap &	parameters
	)

Make a HTTP GET call with parameters.

Example:

auto answer{connection.get(mastodonpp::API::v1::accounts_id_followers,
                           {
                               {"id", "12"},
                               {"limit", "10"}
                           })};

Parameters

endpoint	Endpoint as API::endpoint_type or std::string_view.
parameters	A map of parameters.

Since

0.1.0

{
    const string uri{[&]
    {
        if (holds_alternative<API::endpoint_type>(endpoint))
        {
            return string(_baseuri)
                += API{std::get<API::endpoint_type>(endpoint)}.to_string_view();
        }
        return string(std::get<string_view>(endpoint));
    }()};
 
    return make_request(http_method::GET, uri, parameters);
}

get_new_stream_contents()

string mastodonpp::Connection::get_new_stream_contents

(

)

Copy new stream contents and delete the “original”.

Note that the last event is not necessarily complete, it could happen that you are calling this function mid-transfer. You have to check the data integrity yourself.

Since

0.1.0

{
    buffer_mutex.lock();
    auto &buffer{get_buffer()};
    auto buffer_copy{buffer};
    buffer.clear();
    buffer_mutex.unlock();
    return buffer_copy;
}

set_proxy()

void mastodonpp::Connection::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

Sets also the proxy for the Instance you used to initialize this Connection.

{
    CURLWrapper::set_proxy(proxy);
    _instance.set_proxy(proxy);
}

---

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

• include/connection.hpp
• src/connection.cpp