From 7553367fe964ef9f8495eab90fd49b1f92f334fb Mon Sep 17 00:00:00 2001
From: =?utf8?q?Thiemo=20M=C3=A4ttig?= <thiemo.maettig@wikimedia.de>
Date: Thu, 20 Nov 2014 16:13:13 +0100
Subject: [PATCH] Fix/update inline documentation of LoadBalancer

Plus two very minor fixes in the code,
* an unused variable and
* a broken error message.

Change-Id: I40a39c81bd0d6d6054f983c82880f4bf31c21275
---
 includes/db/LoadBalancer.php | 30 +++++++++++++++---------------
 1 file changed, 15 insertions(+), 15 deletions(-)

diff --git a/includes/db/LoadBalancer.php b/includes/db/LoadBalancer.php
index 233c92f4a6..19ef3763ed 100644
--- a/includes/db/LoadBalancer.php
+++ b/includes/db/LoadBalancer.php
@@ -28,13 +28,13 @@
  * @ingroup Database
  */
 class LoadBalancer {
-	/** @var array Map of (server index => server config array) */
+	/** @var array[] Map of (server index => server config array) */
 	private $mServers;
-	/** @var array Map of (local/foreignUsed/foreignFree => server index => DatabaseBase array) */
+	/** @var array[] Map of (local/foreignUsed/foreignFree => server index => DatabaseBase array) */
 	private $mConns;
 	/** @var array Map of (server index => weight) */
 	private $mLoads;
-	/** @var array Map of (group => server index => weight) */
+	/** @var array[] Map of (group => server index => weight) */
 	private $mGroupLoads;
 	/** @var bool Whether to disregard slave lag as a factor in slave selection */
 	private $mAllowLagged;
@@ -197,8 +197,8 @@ class LoadBalancer {
 	 * always return a consistent index during a given invocation
 	 *
 	 * Side effect: opens connections to databases
-	 * @param bool|string $group
-	 * @param bool|string $wiki
+	 * @param string|bool $group Query group, or false for the generic reader
+	 * @param string|bool $wiki Wiki ID, or false for the current wiki
 	 * @throws MWException
 	 * @return bool|int|string
 	 */
@@ -218,7 +218,7 @@ class LoadBalancer {
 			return $this->mReadIndex;
 		}
 
-		$section = new ProfileSection( __METHOD__ );
+		new ProfileSection( __METHOD__ );
 
 		# Find the relevant load array
 		if ( $group !== false ) {
@@ -410,7 +410,7 @@ class LoadBalancer {
 
 		if ( $result == -1 || is_null( $result ) ) {
 			# Timed out waiting for slave, use master instead
-			$server = $this->mServers[$index];
+			$server = $this->mServers[$index]['host'];
 			$msg = __METHOD__ . ": Timed out waiting on $server pos {$this->mWaitForPos}";
 			wfDebug( "$msg\n" );
 			wfDebugLog( 'DBPerformance', "$msg:\n" . wfBacktrace( true ) );
@@ -432,8 +432,8 @@ class LoadBalancer {
 	 * This is the main entry point for this class.
 	 *
 	 * @param int $i Server index
-	 * @param array $groups Query groups
-	 * @param bool|string $wiki Wiki ID
+	 * @param array|string|bool $groups Query group(s), or false for the generic reader
+	 * @param string|bool $wiki Wiki ID, or false for the current wiki
 	 *
 	 * @throws MWException
 	 * @return DatabaseBase
@@ -556,8 +556,8 @@ class LoadBalancer {
 	 * @see LoadBalancer::getConnection() for parameter information
 	 *
 	 * @param int $db
-	 * @param mixed $groups
-	 * @param bool|string $wiki
+	 * @param array|string|bool $groups Query group(s), or false for the generic reader
+	 * @param string|bool $wiki Wiki ID, or false for the current wiki
 	 * @return DBConnRef
 	 */
 	public function getConnectionRef( $db, $groups = array(), $wiki = false ) {
@@ -572,8 +572,8 @@ class LoadBalancer {
 	 * @see LoadBalancer::getConnection() for parameter information
 	 *
 	 * @param int $db
-	 * @param mixed $groups
-	 * @param bool|string $wiki
+	 * @param array|string|bool $groups Query group(s), or false for the generic reader
+	 * @param string|bool $wiki Wiki ID, or false for the current wiki
 	 * @return DBConnRef
 	 */
 	public function getLazyConnectionRef( $db, $groups = array(), $wiki = false ) {
@@ -589,7 +589,7 @@ class LoadBalancer {
 	 * error will be available via $this->mErrorConnection.
 	 *
 	 * @param int $i Server index
-	 * @param bool|string $wiki Wiki ID to open
+	 * @param string|bool $wiki Wiki ID, or false for the current wiki
 	 * @return DatabaseBase
 	 *
 	 * @access private
@@ -1119,7 +1119,7 @@ class LoadBalancer {
 	 * Results are cached for a short time in memcached/process cache
 	 *
 	 * @param string|bool $wiki
-	 * @return array Map of (server index => seconds)
+	 * @return int[] Map of (server index => seconds)
 	 */
 	function getLagTimes( $wiki = false ) {
 		if ( $this->getServerCount() <= 1 ) {
-- 
2.20.1