SyncReplicator class abstract interface Replication

A Replicator with a primarily synchronous API.

Implemented types

Properties

config ReplicatorConfiguration
This replicator's configuration.
no setterinherited
hashCode int
The hash code for this object.
no setterinherited
isClosed bool
Whether this resource has been closed.
no setterinherited
pendingDocumentIds Set<String>
Returns a Set of ids for Documents in the default collection, who have revisions pending to be pushed.
no setteroverride
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
status ReplicatorStatus
Returns this replicator's status.
no setteroverride

Methods

addChangeListener(ReplicatorChangeListener listener) ListenerToken
Adds a listener to be notified of changes to the status of this replicator.
override
addDocumentReplicationListener(DocumentReplicationListener listener) ListenerToken
Adds a listener to be notified of DocumentReplications performed by this replicator.
override
changes() Stream<ReplicatorChange>
Returns a Stream to be notified of changes to the status of this replicator.
inherited
close() Future<void>
Closes this resource and frees the resources it uses.
inherited
documentReplications() Stream<DocumentReplication>
Returns a Stream to be notified of DocumentReplications performed by this replicator.
inherited
isDocumentPending(String documentId) bool
Returns whether the Document with the given documentId, in the default collection, has revisions pending to be pushed.
override
isDocumentPendingInCollection(String documentId, Collection collection) bool
Returns whether the Document with the given documentId, in the given collection, has revisions pending to be pushed.
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
pendingDocumentIdsInCollection(Collection collection) Set<String>
Returns a Set of ids for Documents in the given collection, who have revisions pending to be pushed.
override
removeChangeListener(ListenerToken token) → void
Removes a previously added change listener.
override
start({bool reset = false}) → void
Starts this replicator with an option to reset the local checkpoint of the replicator.
override
stop() → void
Stops this replicator, if running.
override
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited

Static Methods

create(ReplicatorConfiguration config) Future<SyncReplicator>
Creates a replicator for replicating Documents between a local SyncDatabase and a target database.
override