CBL-5710: Add note that the replicator cannot be started in the inBat…

…ch() function (#3286)
couchbase · May 15, 2024 · ec83376 · ec83376
1 parent 986803e
commit ec83376
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/Objective-C/CBLReplicator.h b/Objective-C/CBLReplicator.h
@@ -75,6 +75,8 @@ NS_ASSUME_NONNULL_BEGIN
 /** 
  Starts the replicator. This method returns immediately; the replicator runs asynchronously
  and will report its progress through the replicator change notification.
+ 
+ @note This method MUST NOT be called within database's inBatch() block, as it will enter deadlock.
  */
 - (void) start;
 

diff --git a/Swift/Replicator.swift b/Swift/Replicator.swift
@@ -98,6 +98,7 @@ public final class Replicator {
 
     /// Starts the replicator. This method returns immediately; the replicator runs asynchronously
     /// and will report its progress through the replicator change notification.
+    ///  - Note: This method MUST NOT be called within database's inBatch() block, as it will enter deadlock.
     public func start() {
         registerActiveReplicator()
         impl.start()