Customizing Transports Configurations

This article provides instructions on explicitly configuring your Ditto instance to listen for connections on a specific port and to connect to remote instances using a host (IP) and port. 
Although Ditto automatically attempts to connect to other instances on the Local Area Network (LAN), Bluetooth Low Energy (LE), and Apple Wireless Direct Link (AWDL), supplying a DittoTransportConfig does not enable this feature by default. 
Rather, you manually enable peer-to-peer connections using EnableAllPeerToPeer(). (See Enabling and Disabling Transports﻿)
Enabling and Disabling Transports
﻿
﻿
Swift
Kotlin
JS
Java
C#
C++
Rust
Dart
DittoTransportConfig config = new DittoTransportConfig();

//Enable all peer to peer transports
config.EnableAllPeerToPeer();

//Or enable/disable each transport separately
//BluetoothLe
config.PeerToPeer.BluetoothLE.Enabled = true;
//Local Area Network
config.PeerToPeer.Lan.Enabled = true;
//AWDL for iOS/MacOS Catalyst
config.PeerToPeer.Awdl.Enabled = true;
//WifiAware for Android
config.PeerToPeer.WifiAware.Enabled = true;

Ditto.TransportConfig = config;

Ditto.StartSync();
DittoTransportConfig config = new DittoTransportConfig();

//Enable all peer to peer transports
config.EnableAllPeerToPeer();

//Or enable/disable each transport separately
//BluetoothLe
config.PeerToPeer.BluetoothLE.Enabled = true;
//Local Area Network
config.PeerToPeer.Lan.Enabled = true;
//AWDL for iOS/MacOS Catalyst
config.PeerToPeer.Awdl.Enabled = true;
//WifiAware for Android
config.PeerToPeer.WifiAware.Enabled = true;

Ditto.TransportConfig = config;

Ditto.StartSync();
﻿
Configuring Additional Settings
If you need additional connection configurations for the current Ditto instance, configure it to listen for connections on a specific port and to connect to remote instances using a host (IP) and port:
1
Before calling startSync(), create a DittoTransportConfig object with the desired settings.
2
Using the ditto.SetTransportConfig API method, set the created object on your Ditto instance.
3
Call the startSync method on your Ditto instance to initiate sync with the configured settings.
Syncing with Big Peer
﻿
Swift
Kotlin
JS
Java
C#
C++
Rust
Dart
val identity = DittoIdentity.OnlinePlayground(
    androidDependencies,
    "REPLACE_ME_WITH_YOUR_APP_ID",
    "YOUR_PLAYGROUND_TOKEN_HERE",
    // Set to false to disable syncing with the cloud
    true
)
val ditto = Ditto(androidDependencies, identity)

try {
    ditto.startSync()
} catch (e: DittoError) {
    // Handle error
}
val identity = DittoIdentity.OnlinePlayground(
    androidDependencies,
    "REPLACE_ME_WITH_YOUR_APP_ID",
    "YOUR_PLAYGROUND_TOKEN_HERE",
    // Set to false to disable syncing with the cloud
    true
)
val ditto = Ditto(androidDependencies, identity)

try {
    ditto.startSync()
} catch (e: DittoError) {
    // Handle error
}
﻿
Connecting to Remote Small Peers
﻿
Swift
Kotlin
JS
Java
C#
C++
Rust
Dart
var config = DittoTransportConfig()
// Connect explicitly to a remote devices
config.connect.tcpServers.insert("135.1.5.5:12345")
config.connect.tcpServers.insert("185.1.5.5:12345")

ditto.transportConfig = config

do {
  try ditto.startSync()
} catch (let err) {
  print(err.localizedDescription)
}
var config = DittoTransportConfig()
// Connect explicitly to a remote devices
config.connect.tcpServers.insert("135.1.5.5:12345")
config.connect.tcpServers.insert("185.1.5.5:12345")

ditto.transportConfig = config

do {
  try ditto.startSync()
} catch (let err) {
  print(err.localizedDescription)
}
﻿
Initializing WebSocket Connections
Ensure WebSocket connections are discoverable across peers within your local network: 
Swift
Kotlin
JS
Java
C#
C++
Rust
Dart
var config = DittoTransportConfig()
config.connect.webSocketURLs.insert("ws://127.0.0.1")
ditto.transportConfig = config

do {
  try ditto.startSync()
} catch (let err) {
  print(err.localizedDescription)
}
var config = DittoTransportConfig()
config.connect.webSocketURLs.insert("ws://127.0.0.1")
ditto.transportConfig = config

do {
  try ditto.startSync()
} catch (let err) {
  print(err.localizedDescription)
}
﻿
Listening for Connections
﻿
Swift
Kotlin
JS
Java
C#
C++
Rust
Dart
var config = DittoTransportConfig()

// Listen for incoming connections on port 4000
config.listen.tcp.isEnabled = true
config.listen.tcp.interfaceIP = "0.0.0.0"
config.listen.tcp.port = 4000

ditto.transportConfig = config

do {
  try ditto.startSync()
} catch (let err) {
  print(err.localizedDescription)
}
var config = DittoTransportConfig()

// Listen for incoming connections on port 4000
config.listen.tcp.isEnabled = true
config.listen.tcp.interfaceIP = "0.0.0.0"
config.listen.tcp.port = 4000

ditto.transportConfig = config

do {
  try ditto.startSync()
} catch (let err) {
  print(err.localizedDescription)
}
﻿
﻿
Combining Multiple Transports
﻿
Swift
Kotlin
JS
Java
C#
C++
Rust
Dart
final config = TransportConfig()
  ..setAllPeerToPeerEnabled(true)
  ..listen.tcp.isEnabled = true
  ..listen.tcp.interfaceIP = '0.0.0.0'
  ..listen.tcp.port = 4000;

// 3. Connect explicitly to remote devices
await ditto.setTransportConfig(config);
await ditto.startSync();
final config = TransportConfig()
  ..setAllPeerToPeerEnabled(true)
  ..listen.tcp.isEnabled = true
  ..listen.tcp.interfaceIP = '0.0.0.0'
  ..listen.tcp.port = 4000;

// 3. Connect explicitly to remote devices
await ditto.setTransportConfig(config);
await ditto.startSync();
﻿
Monitoring Conditions
﻿
Swift
Kotlin
JS
Java
C#
C++
Rust
Dart
// Setting up inside a ViewController
let ditto = Ditto(identity: DittoIdentity.onlinePlayground(appID: "REPLACE_ME_WITH_YOUR_APP_ID", token: "REPLACE_ME_WITH_YOUR_PLAYGROUND_TOKEN"))
ditto.delegate = self
try! ditto.startSync()

// Now you can observe real time changes to the transport conditions:
extension ViewController: DittoDelegate {
   func transportConditionDidChange(transportID: Int64, condition: TransportCondition) {
       if condition == .BleDisabled {
           print("BLE disabled")
       } else if condition == .NoBleCentralPermission {
           print("Permission missing for BLE")
       } else if condition == .NoBlePeripheralPermission {
           print("Permission missing for BLE")
       }
   }
// Setting up inside a ViewController
let ditto = Ditto(identity: DittoIdentity.onlinePlayground(appID: "REPLACE_ME_WITH_YOUR_APP_ID", token: "REPLACE_ME_WITH_YOUR_PLAYGROUND_TOKEN"))
ditto.delegate = self
try! ditto.startSync()

// Now you can observe real time changes to the transport conditions:
extension ViewController: DittoDelegate {
   func transportConditionDidChange(transportID: Int64, condition: TransportCondition) {
       if condition == .BleDisabled {
           print("BLE disabled")
       } else if condition == .NoBleCentralPermission {
           print("Permission missing for BLE")
       } else if condition == .NoBlePeripheralPermission {
           print("Permission missing for BLE")
       }
   }
﻿
﻿
Updated 04 Dec 2024
Did this page help you?
Using Mesh Presence
Creating Sync Groups