Ditto 2.0.0-alpha1
|
The entrypoint to the Ditto SDK. More...
#include <Ditto.hpp>
Classes | |
class | Fields |
Public Member Functions | |
Ditto (std::shared_ptr< Identity > identity=Identity::OfflinePlayground(), std::string persistence_dir="") | |
Initializes a new Ditto instance. More... | |
Ditto (Ditto const &other)=delete | |
Ditto (Ditto &&other) noexcept | |
Ditto & | operator= (Ditto const &other)=delete |
Ditto & | operator= (Ditto &&other) noexcept |
std::shared_ptr< Authenticator > | get_auth () const |
Provides access to authentication information and methods for logging on to Ditto Cloud. More... | |
Store & | get_store () const |
Provides access to the SDK's store functionality. More... | |
TransportConfig | get_transport_config () const |
Returns the current transport config. More... | |
bool | get_is_sync_active () const |
Returns a flag indicating whether or not sync is active. Use start_sync to activate sync and stop_sync to deactivate sync. More... | |
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 (OfflinePlayground, Manual or SharedKey) Ditto instance before you have activated it. More... | |
void | start_sync () const |
Starts the network transports. Ditto will connect to other devices and sync with them where appropriate. More... | |
void | stop_sync () const |
Stops all network transports. More... | |
void | set_transport_config (TransportConfig config) |
Assign a new transports configuration. More... | |
void | update_transport_config (std::function< void(TransportConfig &config)> lambda) |
Convenience method to update the current transport config of the receiver. More... | |
void | run_garbage_collection () const |
Removes all sync metadata for any remote peers which aren't currently connected. More... | |
Static Public Member Functions | |
static std::string | get_sdk_version () |
Returns a string identifying the version of the Ditto SDK. More... | |
static bool | get_logging_enabled () |
Gets whether or not logging is enabled for Ditto. More... | |
static void | set_logging_enabled (bool enabled) |
Sets whether or not logging is enabled for Ditto. More... | |
static bool | get_emoji_log_level_headings_enabled () |
Gets whether or not emoji log level headings are enabled for Ditto. More... | |
static void | set_emoji_log_level_headings_enabled (bool enabled) |
Sets whether or not emoji log level headings are enabled for Ditto. More... | |
static LogLevel | get_minimum_log_level () |
Gets the minimum log level at which logs will be emitted for Ditto. More... | |
static void | set_minimum_log_level (LogLevel log_level) |
Sets the minimum log level at which logs should be emitted for Ditto. More... | |
The entrypoint to the Ditto SDK.
For a Ditto instance to continue to connect to other devices it must be kept in scope.
|
explicit |
std::shared_ptr< Authenticator > ditto::Ditto::get_auth | ( | ) | const |
Provides access to authentication information and methods for logging on to Ditto Cloud.
Authenticator
.
|
static |
bool ditto::Ditto::get_is_sync_active | ( | ) | const |
Returns a flag indicating whether or not sync is active. Use start_sync
to activate sync and stop_sync
to deactivate sync.
|
static |
|
static |
|
static |
Store & ditto::Ditto::get_store | ( | ) | const |
Provides access to the SDK's store functionality.
Store
object. TransportConfig ditto::Ditto::get_transport_config | ( | ) | const |
Returns the current transport config.
void ditto::Ditto::run_garbage_collection | ( | ) | const |
Removes all sync metadata for any remote peers which aren't currently connected.
This method shouldn't usually be called. Manually running garbage collection often will result in slower sync times. Ditto automatically runs a garbage a collection process in the background at optimal times.
Manually running garbage collection is typically only useful during testing if large amounts of data are being generated. Alternatively, if an entire data set is to be evicted and it's clear that maintaining this metadata isn't necessary, then garbage collection could be run after evicting the old data.
|
static |
|
static |
|
static |
void ditto::Ditto::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 (OfflinePlayground, Manual or SharedKey) Ditto instance before you have activated it.
[in] | license_str | the license token to activate the Ditto instance with, which you can find on the Ditto portal (https://portal.ditto.live). |
void ditto::Ditto::set_transport_config | ( | TransportConfig | config | ) |
Assign a new transports configuration.
By default peer-to-peer transports (Bluetooth and WiFi, where available) are enabled.
You may use this method to alter the configuration at any time. Sync will not begin until start_sync is called.
void ditto::Ditto::start_sync | ( | ) | const |
Starts the network transports. Ditto will connect to other devices and sync with them where appropriate.
By default Ditto will enable all peer-to-peer transport types. The network configuration can be customized using set_transport_config.
DittoError | thrown if the Ditto instance hasn't been activated by a successful call to set_license_token. |
void ditto::Ditto::stop_sync | ( | ) | const |
Stops all network transports.
You may continue to use the database locally but no data will sync to or from other devices.
void ditto::Ditto::update_transport_config | ( | std::function< void(TransportConfig &config)> | lambda | ) |
Convenience method to update the current transport config of the receiver.
Invokes the block with a mutable copy of the current transport config which you can alter to your liking. The updated transport config is then set on the receiver.
You may use this method to alter the configuration at any time. Sync will not begin until start_sync
is invoked.