同期セッションの管理 - Kotlin SDK

同期セッション

Flexible Sync を使用すると、Realm Kotlin SDK は同期セッションを使用して、バックグラウンドで Atlas とデータを同期します。 同期セッションは、同期された Realm を開くたびに開始されます。

val app = App.create(YOUR_APP_ID)
val user = app.login(credentials)
val config = SyncConfiguration.Builder(user, setOf(Task::class))
    .build()
// Open the synced realm
val realm = Realm.open(config)
// Sync session is now active
// ... do something with the synced realm

同期セッションは以下を管理します。

• Realm への変更のアップロードとダウンロード

• 同期の一時停止と再開

• ネットワーク接続のモニタリング

1 つの同期された Realm のSyncSessionには、 Realm.syncSessionプロパティを使用してアクセスできます。

アップロードおよびダウンロードによる変更を待機

すべての変更が同期された Realm から Atlas にアップロードされるのを非同期に待機するには、 updateAllLocalchangesを呼び出します。 このメソッドは、すべての変更がアップロードされたときにtrueを返します。

Atlas のすべての変更が Device Sync サーバーから同期された Realm にダウンロードされるまで非同期に待機するには、 DownloadAllServerChecks を呼び出します。 このメソッドは、すべての変更がダウンロードされたときにtrueを返します。

また、どちらのメソッドにも任意のtimeoutパラメータを含めて、 falseを返すまでの最大時間を決定できます。 falseが返された後もアップロードまたはダウンロードはバックグラウンドで続行されることに注意してください。

次の例では、タイムアウトが定義された両方のメソッドを呼び出す方法が示されています。

// Wait to download all pending changes from Atlas
realm.syncSession.downloadAllServerChanges(1.minutes)
// Add data locally
realm.write {
    this.copyToRealm(Task().apply {
        taskName = "Review proposal"
        assignee = "Emma"
        progressMinutes = 0
    })
}
// Wait for local changes to be uploaded to Atlas
realm.syncSession.uploadAllLocalChanges(1.minutes)

同期セッションの一時停止と再開

セッションの同期を一時停止するには、 syncSession.一時停止()を呼び出します。 セッションが一時停止されている間は、Realm は Atlas と変更を同期しません。

変更の同期を再開するには、 syncSession.resume() を呼び出します。

同期セッションを一時停止して再開するリージョンごとに、 syncSession.pause()とsyncSession.resume()を手動で呼び出す必要があります。 1 つのセッションの同期状態は、開いている他のセッションには影響しません。

次のコード ブロックは、これらのメソッドを呼び出す方法を示しています。

// Pause the sync session
// Data that you write while session is paused does not sync to Atlas
realm.syncSession.pause()
// Add data locally
realm.write {
    this.copyToRealm(Task().apply {
        taskName = "Submit expense report"
        assignee = "Kevin"
        progressMinutes = 0
    })
}
// Resume sync session
// Local changes now sync to Atlas
realm.syncSession.resume()

ネットワーク接続の監視

現在のネットワーク接続の状態を取得するには、 SyncSession. connectionState を確認します。 プロパティ。 これにより、ネットワーク接続の状態を示すConnectionState列挙値が返されます。 可能な状態はCONNECTED 、 DISCONNECTED 、またはCONNECTINGです。

if (realm.syncSession.connectionState == ConnectionState.CONNECTED) {
    Log.i("Connected to network")
    // ... do something
}

connectionStateAsFlow を使用してネットワーク接続の状態を監視します。 このプロパティは、ネットワーク接続が変更されたときに更新されるConnectionStateManyオブジェクトのフローを返します。 ConnectionStateChangeから新しいConnectionStateにアクセスできます。

val connectionFlow = realm.syncSession.connectionStateAsFlow()
connectionFlow.collect { ConnectionStateChange ->
    if (ConnectionStateChange.newState == ConnectionState.CONNECTED) {
        Log.i("Connected to Atlas Device Sync server")
    }
}

すべての同期セッションの手動再接続

Realm は、デバイスがオフラインの後に接続を回復し、増分バックオフ戦略を使用して再接続を試みることを自動的に検出します。

Kotlin SDK1.11.0バージョン 以降では、trigger App.Sync.reconnect() メソッド を使用して再接続試行を手動で することができます。インクリメンタル バックオフの期間を待つ代わりに、 これは、ネットワーク条件をより正確に理解し（たとえば、Android でConnectivityManagerを使用してネットワークの変更を監視する場合など）、Realm の自動再接続検出に依存したくない場合に便利です。 SDK は、デバイスがプレーンモードを切り替えるときにもこのメソッドを自動的に呼び出します。

再接続試行を手動でtriggerするには、 App.Sync.reconnect() App.Syncインターフェースを通じてアクセスされます。 単一の Realm 同期セッションにアクセスできるSyncSessionとは異なり、 App.Syncインターフェースはアプリのすべての同期セッションを制御します。

app.sync.reconnect()

このメソッドを呼び出すと、SDK はすべての同期セッションに直ちに再接続を試み、増分バックオフに使用されるすべてのタイマーをリセットします。