Mastodon::API::http Class Reference

http class. Do not use this directly. More...

#include <mastodon-cpp.hpp>

Public Member Functions
	http (const API &api, const string &instance, const string &access_token)
	Constructs new http object. More...
return_call	request (const http_method &meth, const string &path)
return_call	request (const http_method &meth, const string &path, HTMLForm &formdata)
	HTTP Request. More...
void	request_stream (const string &path, string &stream)
	HTTP Request for streams. More...
void	get_headers (string &headers) const
	Get all headers in a string.
void	cancel_stream ()
	Cancels the stream. Use only with streams. More...
std::mutex &	get_mutex ()
	Gets the mutex guarding the string that is written to. More...
void	set_proxy (const string &hostport, const string &userpw="")
	Set proxy. Do not call this directly. More...

Detailed Description

http class. Do not use this directly.

Since

before 0.11.0

Constructor & Destructor Documentation

http()

API::http::http ( const API &  api, const string &  instance, const string &  access_token  )

explicit

Constructs new http object.

Parameters

API	Parent object.
instance	Instance domain name
access_token	Access token

Since

before 0.11.0

: parent(api)
, _instance(instance)
, _access_token(access_token)
, _cancel_stream(false)
{
    Poco::Net::initializeSSL();

    try
    {
        string env_proxy = Environment::get("http_proxy");
        size_t pos;

        // Only keep text between // and /.
        if ((pos = env_proxy.find("//")) != string::npos)
        {
            env_proxy = env_proxy.substr(pos + 2);
        }
        if ((pos = env_proxy.find('/')) != string::npos)
        {
            env_proxy = env_proxy.substr(0, pos);
        }

        if ((pos = env_proxy.find('@')) != string::npos)
        {
            string hostport = env_proxy.substr(pos + 1);
            string userpw = env_proxy.substr(0, pos);
            set_proxy(hostport, userpw);
        }
        else
        {
            set_proxy(env_proxy);
        }
    }
    catch (const std::exception &)
    {
        // No proxy found, no problem.
    }

}

Member Function Documentation

cancel_stream()

void API::http::cancel_stream

(

)

Cancels the stream. Use only with streams.

    Cancels the stream next time data comes in. Can take a
    few seconds.  This works only with streams, because only
    streams have an own http object.

Since

0.12.2

{
    _cancel_stream = true;
    _streamthread.join();
}

get_mutex()

std::mutex & API::http::get_mutex

(

)

Gets the mutex guarding the string that is written to.

    The mutex guards the function that writes to the string
    you specified in get_stream().

Returns

A reference of the mutex.

Since

0.12.3

{
    return _mutex;
}

request()

return_call API::http::request	(	const http_method &	meth,
		const string &	path,
		HTMLForm &	formdata
	)

HTTP Request.

Parameters

meth	A method defined in http::method.
path	The API call as string.
formdata	The form data for PATCH and POST requests.

Since

0.100.0

{
    string answer;
    return request_common(meth, path, formdata, answer);
}

request_stream()

void API::http::request_stream	(	const string &	path,
		string &	stream
	)

HTTP Request for streams.

Parameters

path	The API call as string.
stream	The stream of data that is returned.

Since

0.100.0

{
    static return_call ret;
    _streamthread = std::thread(
        [&, path]               // path is captured by value because it may be
        {                       // deleted before we access it.
            HTMLForm form;
            ret = request_common(http_method::GET_STREAM, path,
                                 form, stream);
            ttdebug << "Remaining content of the stream: " << stream << '\n';
            if (!ret)
            {
                // Embed the HTTP status code in stream on error.
                stream += "event: ERROR\ndata: {\"error_code\":"
                    + std::to_string(ret.error_code) +  ",\"http_error\":"
                    + std::to_string(ret.http_error_code) + "}\n";
            }
        });
}

set_proxy()

void API::http::set_proxy	(	const string &	hostport,
		const string &	userpw = ""
	)

Set proxy. Do not call this directly.

Parameters

hostport	host[:port]
userpw	user[:password] (optional)

Since

0.110.0

{
    try
    {
        HTTPSClientSession::ProxyConfig proxyconfig;
        size_t pos = hostport.find(':');

        proxyconfig.host = hostport.substr(0, pos);
        if (pos != string::npos)
        {
            proxyconfig.port = std::stoi(hostport.substr(pos + 1));
        }

        if (!userpw.empty())
        {
            string username;

            pos = userpw.find(':');
            Poco::URI::decode(userpw.substr(0, pos), username);
            proxyconfig.username = username;

            if (pos != string::npos)
            {
                string password;
                Poco::URI::decode(userpw.substr(pos + 1), password);
                proxyconfig.password = password;
            }
        }

        HTTPSClientSession::setGlobalProxyConfig(proxyconfig);
        ttdebug << "Set proxy to " << hostport << ".\n";
    }
    catch (const std::exception &e)
    {
        if (parent.exceptions())
        {
            std::rethrow_exception(std::current_exception());
        }
    }
}

---

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

• src/mastodon-cpp.hpp
• src/http.cpp