PrivMX Endpoint v2.7.0
Loading...
Searching...
No Matches
KvdbApi.hpp
1#ifndef _PRIVMXLIB_ENDPOINT_KVDB_KVDBAPI_HPP_
2#define _PRIVMXLIB_ENDPOINT_KVDB_KVDBAPI_HPP_
3
4#include <memory>
5#include <optional>
6#include <string>
7#include <vector>
8#include <map>
9
10#include "privmx/endpoint/core/Connection.hpp"
11#include "privmx/endpoint/core/Types.hpp"
12#include "privmx/endpoint/kvdb/Types.hpp"
13#include <privmx/endpoint/core/ExtendedPointer.hpp>
14
15namespace privmx {
16namespace endpoint {
17namespace kvdb {
18
19class KvdbApiImpl;
20
25public:
33 static KvdbApi create(core::Connection& connection);
34
39 KvdbApi(const KvdbApi& obj);
40 KvdbApi& operator=(const KvdbApi& obj);
41 KvdbApi(KvdbApi&& obj);
42 ~KvdbApi();
43
55 std::string createKvdb(const std::string& contextId,
56 const std::vector<core::UserWithPubKey>& users,
57 const std::vector<core::UserWithPubKey>& managers,
58 const core::Buffer& publicMeta,
59 const core::Buffer& privateMeta,
60 const std::optional<core::ContainerPolicy>& policies = std::nullopt
61 );
62
76 void updateKvdb(const std::string& kvdbId,
77 const std::vector<core::UserWithPubKey>& users,
78 const std::vector<core::UserWithPubKey>& managers,
79 const core::Buffer& publicMeta,
80 const core::Buffer& privateMeta,
81 const int64_t version,
82 const bool force,
83 const bool forceGenerateNewKey,
84 const std::optional<core::ContainerPolicy>& policies = std::nullopt
85 );
86
92 void deleteKvdb(const std::string& kvdbId);
93
100 Kvdb getKvdb(const std::string& kvdbId);
101
109 core::PagingList<Kvdb> listKvdbs(const std::string& contextId, const core::PagingQuery& pagingQuery);
110
118 KvdbEntry getEntry(const std::string& kvdbId, const std::string& key);
119
127 bool hasEntry(const std::string& kvdbId, const std::string& key);
128
136 core::PagingList<std::string> listEntriesKeys(const std::string& kvdbId, const core::PagingQuery& pagingQuery);
137
145 core::PagingList<KvdbEntry> listEntries(const std::string& kvdbId, const core::PagingQuery& pagingQuery);
146
155 void setEntry(const std::string& kvdbId, const std::string& key, const core::Buffer& publicMeta, const core::Buffer& privateMeta, const core::Buffer& data, int64_t version = 0);
156
163 void deleteEntry(const std::string& kvdbId, const std::string& key);
164
172 std::map<std::string, bool> deleteEntries(const std::string& kvdbId, const std::vector<std::string>& keys);
173
180 std::vector<std::string> subscribeFor(const std::vector<std::string>& subscriptionQueries);
181
186 void unsubscribeFrom(const std::vector<std::string>& subscriptionIds);
187
194 std::string buildSubscriptionQuery(EventType eventType, EventSelectorType selectorType, const std::string& selectorId);
195
202 std::string buildSubscriptionQueryForSelectedEntry(EventType eventType, const std::string& kvdbId, const std::string& kvdbEntryKey);
203
204private:
205 KvdbApi(const std::shared_ptr<KvdbApiImpl>& impl);
206};
207
208} // namespace kvdb
209} // namespace endpoint
210} // namespace privmx
211
212#endif // _PRIVMXLIB_ENDPOINT_KVDB_KVDBAPI_HPP_
Definition Buffer.hpp:13
Definition Connection.hpp:22
Definition ExtendedPointer.hpp:16
std::string createKvdb(const std::string &contextId, const std::vector< core::UserWithPubKey > &users, const std::vector< core::UserWithPubKey > &managers, const core::Buffer &publicMeta, const core::Buffer &privateMeta, const std::optional< core::ContainerPolicy > &policies=std::nullopt)
bool hasEntry(const std::string &kvdbId, const std::string &key)
std::string buildSubscriptionQuery(EventType eventType, EventSelectorType selectorType, const std::string &selectorId)
KvdbEntry getEntry(const std::string &kvdbId, const std::string &key)
core::PagingList< KvdbEntry > listEntries(const std::string &kvdbId, const core::PagingQuery &pagingQuery)
std::vector< std::string > subscribeFor(const std::vector< std::string > &subscriptionQueries)
void setEntry(const std::string &kvdbId, const std::string &key, const core::Buffer &publicMeta, const core::Buffer &privateMeta, const core::Buffer &data, int64_t version=0)
void unsubscribeFrom(const std::vector< std::string > &subscriptionIds)
core::PagingList< Kvdb > listKvdbs(const std::string &contextId, const core::PagingQuery &pagingQuery)
void deleteEntry(const std::string &kvdbId, const std::string &key)
core::PagingList< std::string > listEntriesKeys(const std::string &kvdbId, const core::PagingQuery &pagingQuery)
std::string buildSubscriptionQueryForSelectedEntry(EventType eventType, const std::string &kvdbId, const std::string &kvdbEntryKey)
static KvdbApi create(core::Connection &connection)
Kvdb getKvdb(const std::string &kvdbId)
void deleteKvdb(const std::string &kvdbId)
std::map< std::string, bool > deleteEntries(const std::string &kvdbId, const std::vector< std::string > &keys)
void updateKvdb(const std::string &kvdbId, const std::vector< core::UserWithPubKey > &users, const std::vector< core::UserWithPubKey > &managers, const core::Buffer &publicMeta, const core::Buffer &privateMeta, const int64_t version, const bool force, const bool forceGenerateNewKey, const std::optional< core::ContainerPolicy > &policies=std::nullopt)
Definition Types.hpp:16
Definition Types.hpp:127
Definition Types.hpp:15