commonMain.io.realm.kotlin.mongodb.sync.Sync.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of library-sync Show documentation

Sync Library code for Realm Kotlin. This artifact is not supposed to be consumed directly, but through 'io.realm.kotlin:gradle-plugin:1.6.2' instead.

There is a newer version: 2.3.0

Show newest version

package io.realm.kotlin.mongodb.sync

import io.realm.kotlin.mongodb.App
import io.realm.kotlin.mongodb.syncSession

/**
 * A _Device Sync_ manager responsible for controlling all sync sessions across all realms
 * associated with a given [App] instance. For session functionality associated with a single
 * realm, see [syncSession].
 *
 * @see App.sync
 * @see io.realm.kotlin.mongodb.syncSession
 */
public interface Sync {

    /**
     * Returns whether or not any sync sessions are still active.
     */
    public val hasSyncSessions: Boolean

    /**
     * Realm will automatically detect when a device gets connectivity after being offline and
     * resume syncing. However, as some of these checks are performed using incremental backoff,
     * this will in some cases not happen immediately.
     *
     * In those cases it can be beneficial to call this method manually, which will force all
     * sessions to attempt to reconnect immediately and reset any timers they are using for
     * incremental backoff.
     *
     * Note, Realm has an internal default socket read timeout of 2 minutes. Calling this method
     * within those two minutes will not trigger a reconnect.
     */
    public fun reconnect()

    /**
     * Calling this method will block until all sync sessions for a given [App] has terminated.
     *
     * Closing a Realm will terminate the sync session, but it is not synchronous as Realms
     * communicate with their sync session using an asynchronous communication channel. This
     * has the effect that trying to delete a Realm right after closing it will sometimes throw
     * an [IllegalStateException]. Using this method can be a way to ensure it is safe to delete
     * the file.
     */
    public fun waitForSessionsToTerminate()
}