1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
|
/* This file is part of mastodonpp.
* Copyright © 2020 tastytea <tastytea@tastytea.de>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, version 3.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef MASTODONPP_CONNECTION_HPP
#define MASTODONPP_CONNECTION_HPP
#include "answer.hpp"
#include "api.hpp"
#include "curl_wrapper.hpp"
#include "instance.hpp"
#include <string>
#include <string_view>
#include <variant>
#include <vector>
namespace mastodonpp
{
using std::string;
using std::string_view;
using std::variant;
using std::vector;
/*!
* @brief An endpoint. Either API::endpoint_type or `std::string_view`.
*
* @since 0.1.0
*/
using endpoint_variant = variant<API::endpoint_type,string_view>;
/*!
* @brief A stream event.
*
* @since 0.1.0
*
* @headerfile connection.hpp mastodonpp/connection.hpp
*/
struct event_type
{
/*!
* @brief The type of the event.
*
* Can be: “update”, “notification”, “delete” or “filters_changed”. For
* more information consult [the Mastodon documentation]
* (https://docs.joinmastodon.org/methods/timelines/streaming/
* #event-types-a-idevent-typesa).
*/
string type;
//! The payload.
string data;
};
/*!
* @brief Represents a connection to an instance. Used for requests.
*
* @since 0.1.0
*
* @headerfile connection.hpp mastodonpp/connection.hpp
*/
class Connection : public CURLWrapper
{
public:
/*!
* @brief Construct a new Connection object.
*
* @param instance An Instance with the access data.
*
* @since 0.1.0
*/
explicit Connection(Instance &instance);
/*!
* @brief Make a HTTP GET call with parameters.
*
* Example:
* @code
* auto answer{connection.get(mastodonpp::API::v1::accounts_id_followers,
* {
* {"id", "12"},
* {"limit", "10"}
* })};
* @endcode
*
* @param endpoint Endpoint as API::endpoint_type or `std::string_view`.
* @param parameters A map of parameters.
*
*
* @since 0.1.0
*/
[[nodiscard]]
answer_type get(const endpoint_variant &endpoint,
const parametermap ¶meters);
/*!
* @brief Make a HTTP GET call.
*
* Example:
* @code
* auto answer{connection.get("/api/v1/instance")};
* @endcode
*
* @param endpoint Endpoint as API::endpoint_type or `std::string_view`.
*
* @since 0.1.0
*/
[[nodiscard]]
inline answer_type get(const endpoint_variant &endpoint)
{
return get(endpoint, {});
}
/*!
* @brief 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.
*
* Using get_new_events() instead is recommended.
*
* @since 0.1.0
*/
string get_new_stream_contents();
/*!
* @brief Get new stream events.
*
* @since 0.1.0
*/
vector<event_type> get_new_events();
private:
Instance &_instance;
const string_view _baseuri;
};
} // namespace mastodonpp
#endif // MASTODONPP_CONNECTION_HPP
|
