DittoSharp.DittoKit Class Reference

The entrypoint to the DittoSharp SDK. More...

Inheritance diagram for DittoSharp.DittoKit:

Public Member Functions
	DittoKit (DittoIdentity identity=default, string workingDir="dittokit")
	Initializes a new instance of the DittoKit class. More...
void	StartTcpServer (string address)
	Starts a TCP server connection. More...
void	StartWebsocketServer (string address)
	Starts a WebSocket server that other devices will be able to connect to. More...
void	SetAccessLicense (string license)
	Activate a DittoKit instance by setting an access license. You cannot interact with DittoKit before you have activated it. More...
void	Dispose ()

Properties
static DittoLogLevel	MinimumLogLevel [set]
	Sets the minimum logging level to be printed in the console or stdout. For example if this is set to DittoLogLevel.Warning, then only logs that are logged with the Warning or Error log levels will be shown. More...
bool	Activated [get]
uint	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...

Detailed Description

The entrypoint to the DittoSharp SDK.

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

Constructor & Destructor Documentation

DittoKit()

DittoSharp.DittoKit.DittoKit ( DittoIdentity  identity = default, string  workingDir = "dittokit"  )

inline

Initializes a new instance of the DittoKit class.

Parameters

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

Member Function Documentation

SetAccessLicense()

void DittoSharp.DittoKit.SetAccessLicense ( string  license )

inline

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

Parameters

license

The access license.

StartTcpServer()

void DittoSharp.DittoKit.StartTcpServer ( string  address )

inline

Starts a TCP server connection.

Parameters

address

The address of the server to connect to.

StartWebsocketServer()

void DittoSharp.DittoKit.StartWebsocketServer ( string  address )

inline

Starts a WebSocket server that other devices will be able to connect to.

Parameters

address

The address that the WebSocket server should run at.

Property Documentation

MinimumLogLevel

DittoLogLevel DittoSharp.DittoKit.MinimumLogLevel

staticset

Sets the minimum logging level to be printed in the console or stdout. For example if this is set to DittoLogLevel.Warning, then only logs that are logged with the Warning or Error log levels will be shown.

SiteId

uint DittoSharp.DittoKit.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 DittoSharp.DittoKit.Store

get

Gets a reference to the embedded data store.