Package com.couchbase.lite

Class MultipeerReplicator

java.lang.Object
com.couchbase.lite.MultipeerReplicator
public final class MultipeerReplicator extends Object
The MultipeerReplicator replicates database collections between devices using the Multipeer Connectivity framework. It provides peer discovery, connection management, and data replication.

  • Constructor Details

  • Method Details

    • getConfig

      @NonNull public MultipeerReplicatorConfiguration getConfig()
      The configuration.
      Returns:
      The configuration.

    • getPeerId

      @NonNull public PeerInfo.PeerId getPeerId()

    • getNeighborPeers

      @NonNull public Set<PeerInfo.PeerId> getNeighborPeers()

    • start

      public void start()
      Starts peer discovery and initiates replication with connected peers.

    • stop

      public void stop()
      Stops peer discovery and all replicators.

    • getPeerInfo

      @NonNull public PeerInfo getPeerInfo(@NonNull PeerInfo.PeerId peerId)

    • getNecessaryPermissions

      @NonNull public Set<String> getNecessaryPermissions()
      Returns the set of necessary permissions required by the application.
      Returns:
      A set of necessary permissions (Strings).

    • addStatusListener

      @NonNull public ListenerToken addStatusListener(@NonNull MultipeerReplicatorStatus.Listener listener)
      Adds a listener to receive updates on the multipeer replicator status.
      Parameters:
      listener - The listener to be added.
      Returns:
      A ListenerToken that can be used to remove the listener.

    • addStatusListener

      @NonNull public ListenerToken addStatusListener(@Nullable Executor executor, @NonNull MultipeerReplicatorStatus.Listener listener)
      Adds a listener to receive updates on the multipeer replicator status.
      Parameters:
      executor - The executor to run the listener on.
      listener - The listener to be added.
      Returns:
      A ListenerToken that can be used to remove the listener.

    • addPeerDiscoveryStatusListener

      @NonNull public ListenerToken addPeerDiscoveryStatusListener(@NonNull PeerDiscoveryStatus.Listener listener)
      Adds a listener to receive updates on the peer discovery status.
      Parameters:
      listener - The listener to be added.
      Returns:
      A ListenerToken that can be used to remove the listener.

    • addPeerDiscoveryStatusListener

      @NonNull public ListenerToken addPeerDiscoveryStatusListener(@Nullable Executor executor, @NonNull PeerDiscoveryStatus.Listener listener)
      Adds a listener to receive updates on the peer discovery status.
      Parameters:
      executor - The executor to run the listener on.
      listener - The listener to be added.
      Returns:
      A ListenerToken that can be used to remove the listener.

    • addPeerReplicatorStatusListener

      @NonNull public ListenerToken addPeerReplicatorStatusListener(@NonNull PeerReplicatorStatus.Listener listener)
      Adds a listener to receive updates on the replicator status for each connected peer.
      Parameters:
      listener - The listener to be added.
      Returns:
      A ListenerToken that can be used to remove the listener.

    • addPeerReplicatorStatusListener

      @NonNull public ListenerToken addPeerReplicatorStatusListener(@Nullable Executor executor, @NonNull PeerReplicatorStatus.Listener listener)
      Adds a listener to receive updates on the replicator status for each connected peer.
      Parameters:
      executor - The executor to run the listener on.
      listener - The listener to be added.
      Returns:
      A ListenerToken that can be used to remove the listener.

    • addPeerDocumentReplicationListener

      @NonNull public ListenerToken addPeerDocumentReplicationListener(@NonNull PeerDocumentReplication.Listener listener)
      Adds a listener to receive updates on the document replication status for each connected peer.
      Parameters:
      listener - The listener to be added.
      Returns:
      A ListenerToken that can be used to remove the listener.

    • addPeerDocumentReplicationListener

      @NonNull public ListenerToken addPeerDocumentReplicationListener(@Nullable Executor executor, @NonNull PeerDocumentReplication.Listener listener)
      Adds a listener to receive updates on the document replication status for each connected peer.
      Parameters:
      executor - The executor to run the listener on.
      listener - The listener to be added.
      Returns:
      A ListenerToken that can be used to remove the listener.