Replicator

actual class Replicator(config: ReplicatorConfiguration) : DelegatedClass<CBLReplicator> , AutoCloseable(source)

expect class Replicator(config: ReplicatorConfiguration) : AutoCloseable(source)

A replicator for replicating document changes between a local database and a target database. The replicator can be bidirectional or either push or pull. The replicator can also be one-shot or continuous. The replicator runs asynchronously, so observe the status to be notified of progress.

Parameters

config

replicator configuration

actual class Replicator(config: ReplicatorConfiguration) : DelegatedClass<<Error class: unknown class>> , AutoCloseable(source)

actual class Replicator(config: ReplicatorConfiguration) : AutoCloseable(source)

Constructors

Replicator

actual constructor(config: ReplicatorConfiguration)

expect constructor(config: ReplicatorConfiguration)

Initializes a replicator with the given configuration.

actual constructor(config: ReplicatorConfiguration)

Properties

config

actual val config: ReplicatorConfiguration

expect val config: ReplicatorConfiguration

The replicator's configuration.

actual val config: ReplicatorConfiguration

isClosed

actual val isClosed: Boolean

expect val isClosed: Boolean

Determine whether this replicator has been closed.

actual val isClosed: Boolean

serverCertificates

actual val serverCertificates: List<ByteArray>?

expect val serverCertificates: List<ByteArray>?

The server certificates received from the server during the TLS handshake.

actual val serverCertificates: List<ByteArray>?

status

actual val status: ReplicatorStatus

expect val status: ReplicatorStatus

The replicator's current status: its activity level and progress.

actual val status: ReplicatorStatus

Functions

addChangeListener

actual fun addChangeListener(listener: ReplicatorChangeListener): ListenerToken

actual fun addChangeListener(context: CoroutineContext, listener: ReplicatorChangeSuspendListener): ListenerToken

actual fun addChangeListener(scope: CoroutineScope, listener: ReplicatorChangeSuspendListener)

expect fun addChangeListener(listener: ReplicatorChangeListener): ListenerToken

Adds a change listener for the changes in the replication status and progress.

expect fun addChangeListener(context: CoroutineContext, listener: ReplicatorChangeSuspendListener): ListenerToken

Adds a change listener for the changes in the replication status and progress with a CoroutineContext that will be used to launch coroutines the listener will be called on. Coroutines will be launched in a CoroutineScope that is canceled when the listener is removed.

expect fun addChangeListener(scope: CoroutineScope, listener: ReplicatorChangeSuspendListener)

Adds a change listener for the changes in the replication status and progress with a CoroutineScope that will be used to launch coroutines the listener will be called on. The listener is removed when the scope is canceled.

actual fun addChangeListener(listener: ReplicatorChangeListener): ListenerToken

actual fun addChangeListener(context: <Error class: unknown class>, listener: ReplicatorChangeSuspendListener): ListenerToken

actual fun addChangeListener(scope: <Error class: unknown class>, listener: ReplicatorChangeSuspendListener)

actual fun addChangeListener(listener: ReplicatorChangeListener): ListenerToken

actual fun addChangeListener(context: CoroutineContext, listener: ReplicatorChangeSuspendListener): ListenerToken

actual fun addChangeListener(scope: CoroutineScope, listener: ReplicatorChangeSuspendListener)

addDocumentReplicationListener

actual fun addDocumentReplicationListener(listener: DocumentReplicationListener): ListenerToken

actual fun addDocumentReplicationListener(context: CoroutineContext, listener: DocumentReplicationSuspendListener): ListenerToken

actual fun addDocumentReplicationListener(scope: CoroutineScope, listener: DocumentReplicationSuspendListener)

expect fun addDocumentReplicationListener(listener: DocumentReplicationListener): ListenerToken

Adds a document replication event listener.

expect fun addDocumentReplicationListener(context: CoroutineContext, listener: DocumentReplicationSuspendListener): ListenerToken

Adds a document replication event listener with a CoroutineContext that will be used to launch coroutines the listener will be called on. Coroutines will be launched in a CoroutineScope that is canceled when the listener is removed.

expect fun addDocumentReplicationListener(scope: CoroutineScope, listener: DocumentReplicationSuspendListener)

Adds a document replication event listener with a CoroutineScope that will be used to launch coroutines the listener will be called on. The listener is removed when the scope is canceled.

actual fun addDocumentReplicationListener(listener: DocumentReplicationListener): ListenerToken

actual fun addDocumentReplicationListener(context: <Error class: unknown class>, listener: DocumentReplicationSuspendListener): ListenerToken

actual fun addDocumentReplicationListener(scope: <Error class: unknown class>, listener: DocumentReplicationSuspendListener)

actual fun addDocumentReplicationListener(listener: DocumentReplicationListener): ListenerToken

actual fun addDocumentReplicationListener(context: CoroutineContext, listener: DocumentReplicationSuspendListener): ListenerToken

actual fun addDocumentReplicationListener(scope: CoroutineScope, listener: DocumentReplicationSuspendListener)

actual open override fun close()

expect open override fun close()

Immediately close the replicator and free its resources. We recommend the use of this method on Replicators that are in the STOPPED state. If the replicator is not stopped, this method will make a best effort attempt to stop it but will not wait to confirm that it was stopped cleanly. Any attempt to restart a closed replicator will result in a CouchbaseLiteError. This includes calls to getPendingDocIds and isDocPending.

actual open override fun close()

documentReplicationFlow

fun Replicator.documentReplicationFlow(coroutineContext: CoroutineContext? = null): Flow<DocumentReplication>

A Flow of document replications.

equals

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

getPendingDocumentIds

actual fun getPendingDocumentIds(collection: Collection): Set<String>

expect fun getPendingDocumentIds(collection: Collection): Set<String>

Get a best effort list of documents in the passed collection that are still pending replication.

actual fun getPendingDocumentIds(collection: Collection): Set<String>

hashCode

open override fun hashCode(): Int

isDocumentPending

actual fun isDocumentPending(docId: String, collection: Collection): Boolean

expect fun isDocumentPending(docId: String, collection: Collection): Boolean

Best effort check to see if the document whose ID is passed is still pending replication.

actual fun isDocumentPending(docId: String, collection: Collection): Boolean

replicatorChangesFlow

fun Replicator.replicatorChangesFlow(coroutineContext: CoroutineContext? = null): Flow<ReplicatorChange>

A Flow of replicator state changes.

start

actual fun start()

actual fun start(resetCheckpoint: Boolean)

expect fun start()

expect fun start(resetCheckpoint: Boolean)

Start the replicator.

actual fun start()

actual fun start(resetCheckpoint: Boolean)

actual fun start()

actual fun start(resetCheckpoint: Boolean)

stop

actual fun stop()

expect fun stop()

Stop a running replicator, first cancelling any pending conflict resolutions. This method does not wait for the replicator to stop. When the replicator actually stops, it will broadcast a new state, STOPPED, to change listeners.

actual fun stop()

toString

open override fun toString(): String