From: Aaron Schulz <aschulz@wikimedia.org>
Date: Fri, 14 Apr 2017 01:59:39 +0000 (-0700)
Subject: Clarify getLaggedReplicaMode()/laggedReplicaUsed() in LoadBalancer
X-Git-Tag: 1.31.0-rc.0~3492^2
X-Git-Url: http://git.cyclocoop.org/%24action?a=commitdiff_plain;h=4ffc29a6957cf962dff0211821505ad43f852582;p=lhc%2Fweb%2Fwiklou.git

Clarify getLaggedReplicaMode()/laggedReplicaUsed() in LoadBalancer

Change-Id: I4ea9033d2d643c6758c49f34a69c9837598eea33
---

diff --git a/includes/libs/rdbms/loadbalancer/ILoadBalancer.php b/includes/libs/rdbms/loadbalancer/ILoadBalancer.php
index cbd0ff3401..dbf653dd98 100644
--- a/includes/libs/rdbms/loadbalancer/ILoadBalancer.php
+++ b/includes/libs/rdbms/loadbalancer/ILoadBalancer.php
@@ -444,13 +444,17 @@ interface ILoadBalancer {
 	/**
 	 * @note This method will trigger a DB connection if not yet done
 	 * @param string|bool $domain Domain ID, or false for the current domain
-	 * @return bool Whether the generic connection for reads is highly "lagged"
+	 * @return bool Whether the database for generic connections this request is highly "lagged"
 	 */
 	public function getLaggedReplicaMode( $domain = false );
 
 	/**
+	 * Checks whether the database for generic connections this request was both:
+	 *   - a) Already choosen due to a prior connection attempt
+	 *   - b) Considered highly "lagged"
+	 *
 	 * @note This method will never cause a new DB connection
-	 * @return bool Whether any generic connection used for reads was highly "lagged"
+	 * @return bool
 	 */
 	public function laggedReplicaUsed();