DittoSDK.DittoHttpListenConfig Class Reference

Configuration for less common data sync scenarios. Please read the documentation on the Ditto website for examples. Incorrect use of Listen can result in insecure configurations. More...

Inheritance diagram for DittoSDK.DittoHttpListenConfig:

Public Member Functions
override bool	Equals (object obj)
bool	Equals (DittoHttpListenConfig other)
override int	GetHashCode ()
DittoHttpListenConfig	Copy ()
	Creates a deep copy of the config object.
override string	ToString ()

Static Public Member Functions
static bool	operator== (DittoHttpListenConfig left, DittoHttpListenConfig right)
static bool	operator!= (DittoHttpListenConfig left, DittoHttpListenConfig right)

Properties
bool	Enabled = false [get, set]
	Gets or sets a value indicating whether to start an HTTP/WebSocket service.
string	InterfaceIp = "0.0.0.0" [get, set]
	Gets or sets the bind address. The default value is 0.0.0.0 which will normally allow connectivity via IPv4.
ushort	Port = 80 [get, set]
	Gets or sets the listening port.
bool	WebsocketSync = true [get, set]
	Gets or sets a value indicating whether the HTTP service should allow WebSocket clients to connect and sync via the Ditto replication protocol.
string	StaticContentPath = string.Empty [get, set]
	Gets or sets a path to a directory whose contents should be served at the root of the HTTP server. If this string is empty (default) then this feature is not enabled.
string	TlsKeyPath = string.Empty [get, set]
	Gets or sets the path to a TLS private key. If this and the corresponding certificate path are non-empty, HTTPS and WSS will be enabled for this listener.
string	TlsCertificatePath = string.Empty [get, set]
	Gets or sets the path to a TLS certifiate. If this and the corresponding private key are non-empty, HTTPS and WSS will be enabled for this listener.
bool	IdentityProvider = false [get, set]
	Gets or sets a value indicating whether this HTTP service should act as an identity provider which can be accessed via clients using an OnlineWithAuthentication identity.
string	IdentityProviderSigningKey = string.Empty [get, set]
	Gets or sets a the private key for signing JWT tokens when acting as an identity provider. It should be presented in PEM format.
List< string >	IdentityProviderVerifyingKeys = new List<string>() [get, set]
	Gets or sets a the public keys which should be trusted for incoming WebSocket connections. Typically this will be the matching public key(s) for any signing keys in use.
string	IdentityProviderCAKey = string.Empty [get, set]
	Gets or sets the private key for a TLS CA. This may be the same as the main IdentityProviderSigningKey. If non-empty, this will issue certificates for authenticated clients to sync to each other peer-to-peer if their platforms support it.

Detailed Description

Configuration for less common data sync scenarios. Please read the documentation on the Ditto website for examples. Incorrect use of Listen can result in insecure configurations.

Member Function Documentation

Copy()

DittoHttpListenConfig DittoSDK.DittoHttpListenConfig.Copy ( )

inline

Creates a deep copy of the config object.

Returns

A new, equivalent DittoHttpListenConfig instance.