mastodonpp::Instance Class Reference

Holds the access data of an instance. More...

#include <mastodonpp/instance.hpp>

Inheritance diagram for mastodonpp::Instance:

Public Member Functions
	Instance (string_view hostname, string_view access_token)
	Construct a new Instance object. More...
string_view	get_hostname () const
	Returns the hostname. More...
string_view	get_baseuri () const
	Returns the base URI. More...
string_view	get_access_token () const
	Returns the access token. More...
void	set_access_token (string access_token)
	Set OAuth 2.0 Bearer Access Token. More...
uint64_t	get_max_chars ()
	Returns the maximum number of characters per post. More...
void	set_proxy (const string_view proxy)
	Set the proxy to use. More...
string_view	get_proxy () const
	Returns the proxy string that was previously set. 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...

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...
void	cancel_stream ()
	Cancel the stream. More...
void	set_access_token (const string_view access_token)
	Set OAuth 2.0 Bearer Access Token. More...
Protected Attributes inherited from mastodonpp::CURLWrapper
mutex	buffer_mutex
	Mutex for get_buffer a.k.a. _curl_buffer_body. More...

Detailed Description

Holds the access data of an instance.

Since

0.1.0

Constructor & Destructor Documentation

Instance()

mastodonpp::Instance::Instance ( string_view  hostname, string_view  access_token  )

explicit

Construct a new Instance object.

Parameters

hostname	The hostname of the instance.
access_token	Your access token.

Since

0.1.0

    : _hostname{hostname}
    , _baseuri{"https://" + _hostname}
    , _access_token{access_token}
    , _max_chars{0}
{}

Member Function Documentation

get_access_token()

string_view mastodonpp::Instance::get_access_token ( ) const

inline

Returns the access token.

Since

0.1.0

    {
        return _access_token;
    }

get_baseuri()

string_view mastodonpp::Instance::get_baseuri ( ) const

inline

Returns the base URI.

The base URI is “https://” + the hostname.

Since

0.1.0

    {
        return _baseuri;
    }

get_hostname()

string_view mastodonpp::Instance::get_hostname ( ) const

inline

Returns the hostname.

Since

0.1.0

    {
        return _hostname;
    }

get_max_chars()

uint64_t mastodonpp::Instance::get_max_chars

(

)

Returns the maximum number of characters per post.

Queries /api/v1/instance for ‘max_toot_chars’. If the instance doesn't support it, the limit is assumed to be 500.

Since

0.1.0

{
    constexpr uint64_t default_max_chars{500};
 
    if (_max_chars == 0)
    {
        try
        {
            debuglog << "Querying " << _hostname << " for max_toot_chars…\n";
            const auto answer{make_request(http_method::GET,
                                           _baseuri + "/api/v1/instance", {})};
            if (!answer)
            {
                debuglog << "Could not get instance info.\n";
                return default_max_chars;
            }
 
            _max_chars = [&answer]
            {
                auto &body{answer.body};
                size_t pos_start{body.find("max_toot_chars")};
                if (pos_start == string::npos)
                {
                    debuglog << "max_toot_chars not found.\n";
                    return default_max_chars;
                }
                pos_start = body.find(':', pos_start) + 1;
                const size_t pos_end{body.find(',', pos_start)};
 
                const auto max_toot_chars{body.substr(pos_start,
                                                      pos_end - pos_start)};
                return static_cast<uint64_t>(stoull(max_toot_chars));
            }();
            debuglog << "Set _max_chars to: " << _max_chars << '\n';
        }
        catch (const exception &e)
        {
            debuglog << "Unexpected exception: " << e.what() << '\n';
        }
    }
 
    return _max_chars;
}

get_proxy()

string_view mastodonpp::Instance::get_proxy ( ) const

inline

Returns the proxy string that was previously set.

Does not return the proxy if it was set from an environment variable.

Since

0.1.0

    {
        return _proxy;
    }

set_access_token()

void mastodonpp::Instance::set_access_token ( string  access_token )

inline

Set OAuth 2.0 Bearer Access Token.

Sets also the access token for all Connections that are initialized with this Instance afterwards.

Since

0.1.0

    {
        _access_token = move(access_token);
    }

set_proxy()

void mastodonpp::Instance::set_proxy ( const string_view  proxy )

inline

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 all Connections that are initialized with this Instance afterwards.

    {
        _proxy = proxy;
        CURLWrapper::set_proxy(proxy);
    }

---

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

• include/instance.hpp
• src/instance.cpp