Ditto 1.1.7
Ditto.hpp
1#ifndef _DITTO_DITTO_SYNC_KIT_
2#define _DITTO_DITTO_SYNC_KIT_
3
4#include "Identity.hpp"
5#include "LogLevel.hpp"
6#include "Store.hpp"
7#include "TransportConfig.hpp"
8
9#include "Helpers.hpp"
10
11#include <memory>
12
13namespace ditto {
14class Authenticator;
15
22class Ditto {
23 friend class Authenticator;
24 friend class ValidityListener;
25
26public:
34 explicit Ditto(
35 std::shared_ptr<Identity> identity = Identity::OfflinePlayground(),
36 std::string persistence_dir = "");
37
38 Ditto(Ditto const &other) = delete;
39 Ditto(Ditto &&other) noexcept;
40 Ditto &operator=(Ditto const &other) = delete;
41 Ditto &operator=(Ditto &&other) noexcept;
42 ~Ditto();
43
50 std::shared_ptr<Authenticator> get_auth() const;
51
57 Store &get_store() const;
58
65
72 bool get_is_sync_active() const;
73
84 void set_license_token(std::string license_token) DITTO_DEPRECATED;
85
95 void set_offline_only_license_token(std::string license_token);
96
107 void set_access_license(std::string license_str) DITTO_DEPRECATED;
108
119 void try_start_sync() const;
120
133 void start_sync() const DITTO_DEPRECATED;
134
141 void stop_sync() const;
142
153
165 void
166 update_transport_config(std::function<void(TransportConfig &config)> lambda);
167
173 static std::string get_sdk_version();
174
180 static bool get_logging_enabled();
181
188 static void set_logging_enabled(bool enabled);
189
197
204 static void set_emoji_log_level_headings_enabled(bool enabled);
205
211 static LogLevel get_minimum_log_level();
212
220 static void set_minimum_log_level(LogLevel log_level);
221
236 void run_garbage_collection() const;
237
238private:
239 class Fields;
240 std::shared_ptr<Fields> fields;
241
242 explicit Ditto(std::shared_ptr<Fields> fields);
243
244 void validity_updated(bool web_valid, bool x509_valid) const;
245};
246} // namespace ditto
247
248#endif
Provides access to authentication information and methods for logging on to Ditto Cloud....
Definition: Authenticator.hpp:26
Definition: Ditto.cpp:34
The entrypoint to the Ditto SDK.
Definition: Ditto.hpp:22
static bool get_logging_enabled()
Gets whether or not logging is enabled for Ditto.
Definition: Ditto.cpp:291
void set_access_license(std::string license_str) DITTO_DEPRECATED
Activate an offline Ditto instance by setting a license token. You cannot initiate sync on an offline...
Definition: Ditto.cpp:210
TransportConfig get_transport_config() const
Returns the current transport config.
Definition: Ditto.cpp:225
void stop_sync() const
Stops all network transports.
Definition: Ditto.cpp:259
static void set_minimum_log_level(LogLevel log_level)
Sets the minimum log level at which logs should be emitted for Ditto.
Definition: Ditto.cpp:307
void set_transport_config(TransportConfig config)
Assign a new transports configuration.
Definition: Ditto.cpp:269
void run_garbage_collection() const
Removes all sync metadata for any remote peers which aren't currently connected.
Definition: Ditto.cpp:311
void start_sync() const DITTO_DEPRECATED
Starts the network transports. Ditto will connect to other devices and sync with them where appropria...
Definition: Ditto.cpp:250
bool get_is_sync_active() const
Returns a flag indicating whether or not sync is active. Use try_start_sync to activate sync and stop...
Definition: Ditto.cpp:229
static void set_logging_enabled(bool enabled)
Sets whether or not logging is enabled for Ditto.
Definition: Ditto.cpp:293
static bool get_emoji_log_level_headings_enabled()
Gets whether or not emoji log level headings are enabled for Ditto.
Definition: Ditto.cpp:297
Ditto(std::shared_ptr< Identity > identity=Identity::OfflinePlayground(), std::string persistence_dir="")
Initializes a new Ditto instance.
Definition: Ditto.cpp:90
void update_transport_config(std::function< void(TransportConfig &config)> lambda)
Convenience method to update the current transport config of the receiver.
Definition: Ditto.cpp:277
void try_start_sync() const
Starts the network transports. Ditto will connect to other devices and sync with them where appropria...
Definition: Ditto.cpp:231
void set_offline_only_license_token(std::string license_token)
Activate an offline Ditto instance by setting a license token. You cannot initiate sync on an offline...
Definition: Ditto.cpp:189
static LogLevel get_minimum_log_level()
Gets the minimum log level at which logs will be emitted for Ditto.
Definition: Ditto.cpp:305
Store & get_store() const
Provides access to the SDK's store functionality.
Definition: Ditto.cpp:223
std::shared_ptr< Authenticator > get_auth() const
Provides access to authentication information and methods for logging on to Ditto Cloud.
Definition: Ditto.cpp:221
static void set_emoji_log_level_headings_enabled(bool enabled)
Sets whether or not emoji log level headings are enabled for Ditto.
Definition: Ditto.cpp:301
void set_license_token(std::string license_token) DITTO_DEPRECATED
Activate an offline Ditto instance by setting a license token. You cannot initiate sync on an offline...
Definition: Ditto.cpp:182
static std::string get_sdk_version()
Returns a string identifying the version of the Ditto SDK.
Definition: Ditto.cpp:284
static std::shared_ptr< OfflinePlaygroundIdentity > OfflinePlayground(std::string app_id="", uint64_t site_id=0, std::string persistence_dir="")
Construct a new OfflinePlaygroundIdentity.
Definition: Identity.cpp:34
Provides access to Collections and a write transaction API.
Definition: Store.hpp:20
A configuration object specifying which network transports Ditto should use to sync data.
Definition: TransportConfig.hpp:256