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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of library-sync-jvm 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.5.2' instead.

The newest version!

/*
 * Copyright 2022 Realm Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.realm.kotlin.mongodb.sync

/**
 * A **progress mode** is used to select which notifications are received from
 * [SyncSession.progressAsFlow].
 */
public enum class ProgressMode {

    /**
     * Used to pass to [SyncSession.progressAsFlow] to create a flow that will record the size of the
     * current outstanding changes not transferred, and will only continue
     * to report progress updates until those changes have been either downloaded or uploaded. After
     * that the progress listener will not report any further changes.
     *
     * Progress reported in this mode will only ever increase.
     *
     * **NOTE:** The [Flow] returned by [SyncSession.progressAsFlow] will complete when the transfer is
     * done, i.e. after emitting a [Progress] with
     * [Progress.isTransferComplete] being `true`.
     */
    CURRENT_CHANGES,

    /**
     * Used to pass to [SyncSession.progressAsFlow] to create a flow that reports the size of outstanding
     * changes not yet transferred and will continue to report progress changes, even if changes
     * are being added after the listener was registered.
     *
     * Progress reported in this mode can both increase and decrease, e.g. if large amounts of data is
     * written after registering the listener.
     */
    INDEFINITELY,
}