Merge "Adding a bunch of hooks from wikiHow into DifferenceEngine, 2nd try"

[lhc/web/wiklou.git] / includes / db / loadbalancer / LoadMonitor.php

diff --git a/includes/db/loadbalancer/LoadMonitor.php b/includes/db/loadbalancer/LoadMonitor.php
index 03ce787..e68cf1a 100644 (file)
--- a/includes/db/loadbalancer/LoadMonitor.php
+++ b/includes/db/loadbalancer/LoadMonitor.php
@@ -36,25 +36,27 @@ interface LoadMonitor {
 
        /**
         * Perform pre-connection load ratio adjustment.
-        * @param array $loads
+        * @param array &$loads
         * @param string|bool $group The selected query group. Default: false
         * @param string|bool $wiki Default: false
         */
        public function scaleLoads( &$loads, $group = false, $wiki = false );
 
        /**
-        * Return an estimate of replication lag for each server
+        * Get an estimate of replication lag (in seconds) for each server
+        *
+        * Values may be "false" if replication is too broken to estimate
         *
         * @param array $serverIndexes
         * @param string $wiki
         *
-        * @return array Map of (server index => seconds)
+        * @return array Map of (server index => float|int|bool)
         */
        public function getLagTimes( $serverIndexes, $wiki );
 
        /**
         * Clear any process and persistent cache of lag times
-        * @since 1.26
+        * @since 1.27
         */
        public function clearCaches();
 }