DittoSmallPeerInfo

class DittoSmallPeerInfo(val ditto: WeakReference<DittoBase>)

Entrypoint for small peer info collection. Small peer info consists of information gathered into a system collection on a regular interval and optionally synced to the Big Peer for device dashboard and debugging purposes.

This class isn't created directly. It can be accessed via the smallPeerInfo property on a Ditto instance.

Constructors

DittoSmallPeerInfo

constructor(ditto: WeakReference<DittoBase>)

Types

Companion

object Companion

Properties

ditto

val ditto: WeakReference<DittoBase>

isEnabled

var isEnabled: Boolean

Indicates whether the small peer info collector is currently enabled.

metadata

var metadata: Map<String, Any>

The metadata is free-form, user-provided Map which is serialized into JSON and is inserted into the small peer info system doc at each collection interval. The Map has no schema except for the following constraints:

metadataJsonString

var metadataJsonString: String

syncScope

var syncScope: DittoSmallPeerInfoSyncScope

Controls which "kind" of peers the small peer info will be replicated to. Defaults to BigPeerOnly.