Replicator

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.

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

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

Constructors

Replicator

expect constructor(config: ReplicatorConfiguration)

actual constructor(config: ReplicatorConfiguration)

Properties

config

expect val config: ReplicatorConfiguration

The replicator's configuration.

actual val config: ReplicatorConfiguration

pendingDocumentIds

expect val ~~pendingDocumentIds~~: Set<String>

Get a best effort set of document IDs in the default collection, that are still pending replication.

actual val ~~pendingDocumentIds~~: Set<String>

serverCertificates

expect val serverCertificates: List<ByteArray>?

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

actual val serverCertificates: List<ByteArray>?

status

expect val status: ReplicatorStatus

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

actual val status: ReplicatorStatus

Functions

addChangeListener

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: CoroutineContext, listener: ReplicatorChangeSuspendListener): ListenerToken

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

actual fun addChangeListener(listener: ReplicatorChangeListener): ListenerToken

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

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

addDocumentReplicationListener

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: CoroutineContext, listener: DocumentReplicationSuspendListener): ListenerToken

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

actual fun addDocumentReplicationListener(listener: DocumentReplicationListener): ListenerToken

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

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

expect open override fun close()

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

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

expect fun ~~isDocumentPending~~(docId: String): 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): Boolean

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

actual fun ~~isDocumentPending~~(docId: String): Boolean

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

removeChangeListener

expect fun ~~removeChangeListener~~(token: ListenerToken)

Remove the given ReplicatorChangeListener or DocumentReplicationListener from the replicator.

actual fun ~~removeChangeListener~~(token: ListenerToken)

replicatorChangesFlow

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

A Flow of replicator state changes.

start

expect fun start()

Start the replicator.

expect fun start(resetCheckpoint: Boolean)

Start the replicator. This method does not wait for the replicator to start. The replicator runs asynchronously and reports its progress through replicator change notifications.

actual fun start()

actual fun start(resetCheckpoint: Boolean)

actual fun start()

actual fun start(resetCheckpoint: Boolean)

stop

expect fun stop()

Stop a running replicator. 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