Fix some LoadBalancer::waitFor*() inconsistencies

[lhc/web/wiklou.git] / includes / libs / rdbms / loadbalancer / ILoadBalancer.php

diff --git a/includes/libs/rdbms/loadbalancer/ILoadBalancer.php b/includes/libs/rdbms/loadbalancer/ILoadBalancer.php
index 2ea0e4e..cbd0ff3 100644 (file)
--- a/includes/libs/rdbms/loadbalancer/ILoadBalancer.php
+++ b/includes/libs/rdbms/loadbalancer/ILoadBalancer.php
@@ -23,7 +23,6 @@
  */
 namespace Wikimedia\Rdbms;
 
-use Database;
 use DBError;
 use DBAccessError;
 use DBTransactionError;
@@ -136,6 +135,10 @@ interface ILoadBalancer {
         * If a DB_REPLICA connection has been opened already, then wait immediately.
         * Otherwise sets a variable telling it to wait if such a connection is opened.
         *
+        * This only applies to connections to the generic replica DB for this request.
+        * If a timeout happens when waiting, then getLaggedReplicaMode()/laggedReplicaUsed()
+        * will return true.
+        *
         * @param DBMasterPos|bool $pos Master position or false
         */
        public function waitFor( $pos );