]> scripts.mit.edu Git - autoinstallsdev/mediawiki.git/blobdiff - includes/db/LoadMonitor.php
MediaWiki 1.17.0
[autoinstallsdev/mediawiki.git] / includes / db / LoadMonitor.php
index 929ab2b9e1c59fb9029830edd32d6de281709b38..9b959728c31ecf33f752998b78c054d7e8a46802 100644 (file)
@@ -1,9 +1,16 @@
 <?php
+/**
+ * Database load monitoring
+ *
+ * @file
+ * @ingroup Database
+ */
 
 /**
  * An interface for database load monitoring
+ *
+ * @ingroup Database
  */
-
 interface LoadMonitor {
        /**
         * Construct a new LoadMonitor with a given LoadBalancer parent
@@ -12,9 +19,9 @@ interface LoadMonitor {
        
        /**
         * Perform pre-connection load ratio adjustment.
-        * @param array $loads
-        * @param string $group The selected query group
-        * @param string $wiki
+        * @param $loads Array
+        * @param $group String: the selected query group
+        * @param $wiki String
         */
        function scaleLoads( &$loads, $group = false, $wiki = false );
 
@@ -31,8 +38,8 @@ interface LoadMonitor {
         * to the running thread count. The threshold may be false, which indicates
         * that the sysadmin has not configured this feature.
         *
-        * @param Database $conn
-        * @param float $threshold
+        * @param $conn DatabaseBase
+        * @param $threshold Float
         */
        function postConnectionBackoff( $conn, $threshold );
 
@@ -46,8 +53,9 @@ interface LoadMonitor {
 /**
  * Basic MySQL load monitor with no external dependencies
  * Uses memcached to cache the replication lag for a short time
+ *
+ * @ingroup Database
  */
-
 class LoadMonitor_MySQL implements LoadMonitor {
        var $parent; // LoadBalancer