DittoSDK.Ditto Class Reference

The entrypoint to the Ditto SDK. More...

Public Member Functions
unsafe	Ditto (DittoIdentity identity=default, string workingDir="ditto")
	Initializes a new instance of the Ditto class. More...
unsafe void	StartTcpServer (string address)
	Starts a TCP server connection. More...
unsafe void	StartHTTPServer (string address, bool enableWebsocket, string staticPath=null, string tlsCertPath=null, string tlsKeyPath=null)
	Starts an HTTP server that other devices will be able to connect to. More...
unsafe void	SetAccessLicense (string license)
	Activate a Ditto instance by setting an access license. You cannot interact with Ditto before you have activated it. More...

Properties
bool	Activated [get]
	Gets a value indicating whether or not the SDK has been activated. More...
unsafe ulong	SiteId [get]
	Gets the unique identifier of a peer in Ditto's distributed mesh network. More...
DittoStore	Store [get]
	Gets a reference to the embedded data store. More...
unsafe string	SDKVersion [get]
	Gets a string identifying the version of the Ditto SDK. More...

Detailed Description

The entrypoint to the Ditto SDK.

For a Ditto instance to continue to connect to other devices it must be kept in scope.

Constructor & Destructor Documentation

Ditto()

unsafe DittoSDK.Ditto.Ditto ( DittoIdentity  identity = default, string  workingDir = "ditto"  )

inline

Initializes a new instance of the Ditto class.

Parameters

identity	Provide the identity of the entity that is interacting with Ditto.
workingDir	The directory that will be used to persist Ditto data.

Member Function Documentation

SetAccessLicense()

unsafe void DittoSDK.Ditto.SetAccessLicense ( string  license )

inline

Activate a Ditto instance by setting an access license. You cannot interact with Ditto before you have activated it.

Parameters

license

The access license.

StartHTTPServer()

unsafe void DittoSDK.Ditto.StartHTTPServer ( string  address, bool  enableWebsocket, string  staticPath = null, string  tlsCertPath = null, string  tlsKeyPath = null  )

inline

Starts an HTTP server that other devices will be able to connect to.

Parameters

address	The address that the WebSocket server should run at.
enableWebsocket	Whether to accept Ditto sync connections on this port.
staticPath	An absolute path to a directory of static files that should be served. May be null.
tlsCertPath	If using TLS, an absolute path to a file containing this server's certificate. Otherwise null.
tlsKeyPath	If using TLS, an absolute path to a file containing this server's private key. Otherwise null.

StartTcpServer()

unsafe void DittoSDK.Ditto.StartTcpServer ( string  address )

inline

Starts a TCP server connection.

Parameters

address

The address of the server to connect to.

Property Documentation

Activated

bool DittoSDK.Ditto.Activated

get

Gets a value indicating whether or not the SDK has been activated.

If false then you need to call Ditto.SetAccessLicense(string) before interacting with the SDK.

SDKVersion

unsafe string DittoSDK.Ditto.SDKVersion

get

Gets a string identifying the version of the Ditto SDK.

Returns

A string identifying the version of the Ditto SDK.

SiteId

unsafe ulong DittoSDK.Ditto.SiteId

get

Gets the unique identifier of a peer in Ditto's distributed mesh network.

IMPORTANT: This must be unique or the merging and conflict resolution will have unexpected behavior.

Store

DittoStore DittoSDK.Ditto.Store

get

Gets a reference to the embedded data store.