ditto/live.ditto/DittoReplicationSubscription

DittoReplicationSubscription

class DittoReplicationSubscription : Closeable

A replication subscription configures Ditto to receive updates from remote peers about documents matching the subscription's query.

Since

4.5.0

Throws

live.ditto.DittoError

if there is a problem creating or registering the subscription.

Types

Companion

object Companion

Functions

open override fun close()

Convenience method which removes the replication subscription from its store. No-op if the replication subscription has already been closed or the store and Ditto instance have gone out of scope.

Properties

isClosed

var isClosed: Boolean = false

true when if the DittoReplicationSubscription has been closed (i.e. removed from its store. Also, a replication subscription is considered closed if it store and Ditto instance goes out of scope.

queryArguments

val queryArguments: Map<String, Any?>? = null

Arguments for the queryString.

queryString

val queryString: String

Documents matching this query will be included in the subscription.

store

var store: WeakReference<DittoStore>?

Weak reference to the store where this subscript is registered. When this is null the subscription has been closed.