DittoPeer

Represents a peer in a Ditto mesh network.

Constructors

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

@JvmOverloads

constructor(address: DittoAddress, peerKeyString: String, deviceName: String, connections: List<DittoConnection>, os: String?, isConnectedToDittoCloud: Boolean, isCompatible: Boolean?, dittoSdkVersion: String?, queryOverlapGroup: Int, peerMetadata: Map<String, Any?> = mapOf(), identityServiceMetadata: Map<String, Any?> = mapOf())

Initializes a new peer

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? = null

The Ditto SDK version the peer is running with..

identityServiceMetadata

@JvmField

val identityServiceMetadata: Map<String, Any?>

Metadata associated with the peer by the identity service.

isCompatible

@JvmField

val isCompatible: Boolean? = null

Indicates whether the peer is compatible with the current peer.

isConnectedToDittoCloud

@JvmField

val isConnectedToDittoCloud: Boolean

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

@JvmField

val os: String? = null

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.

peerKeyString

@JvmField

val peerKeyString: String

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

peerMetadata

@JvmField

val peerMetadata: Map<String, Any?>

Metadata associated with the peer, empty dictionary by default.

queryOverlapGroup

@JvmField

val ~~queryOverlapGroup~~: Int = 0

An optional Query Overlap Group which can be assigned to group certain types of peers together and configure relative connection priorities. Defaults to 0 if not set.

Functions

equals

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

hashCode

open override fun hashCode(): Int