ditto/live.ditto/DittoPeer

DittoPeer

data class DittoPeer(val address: DittoAddress, val peerKey: DittoPeerKey, val deviceName: String, val connections: List<DittoConnection>, val os: String?, val isConnectedToDittoCloud: Boolean, val isCompatible: Boolean?, val dittoSdkVersion: String?, val queryOverlapGroup: Int)

An instance of Ditto taking part in the mesh network.

Constructors

DittoPeer

constructor(address: DittoAddress, peerKey: DittoPeerKey, deviceName: String, connections: List<DittoConnection>, os: String?, isConnectedToDittoCloud: Boolean, isCompatible: Boolean?, dittoSdkVersion: String?, queryOverlapGroup: Int)

Properties

address

@JvmField

val address: DittoAddress

The unique network identifier of the peer.

connections

@JvmField

val connections: List<DittoConnection>

Connections that are currently active with the current peer.

deviceName

@JvmField

val deviceName: String

The human-readable device name of the peer. This defaults to the hostname but can be manually set by the application developer of the other peer. It is not necessarily unique.

dittoSdkVersion

@JvmField

val dittoSdkVersion: String?

Version of the Ditto SDK in use by the peer. This detail is learned gradually and may not be known immediately.

isCompatible

@JvmField

val isCompatible: Boolean?

Indicates whether the peer's Ditto SDK version is compatible with the local version.

isConnectedToDittoCloud

@JvmField

val isConnectedToDittoCloud: Boolean

Indication of whether the peer is connected to the Ditto Cloud (big peer).

@JvmField

val os: String?

Operating system of the peer, if known. This detail is learned gradually and may not be known immediately.

peerKey

@JvmField

val peerKey: DittoPeerKey

The peer key is a unique identifier for a given peer, equal to or derived from the cryptographic public key used to authenticate it.

queryOverlapGroup

@JvmField

val queryOverlapGroup: Int

Used to indicate peers which may not be directly connected are likely to have queries that overlap and sets relative connection priorities to enable them to replicate through other peers on the network.

Functions

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int