X-Git-Url: https://git.heureux-cyclage.org/?a=blobdiff_plain;f=includes%2Flibs%2Frdbms%2Flbfactory%2FILBFactory.php;h=4b6afe7089a4b9de9884a97e69f1e2a9ff830abe;hb=eb833685de76cb23631b59bf7e16efdcbd5e0d6d;hp=812064a772ccc9465bf446367085a8706faf3417;hpb=5f3ca358fed2e59ee33f1134dbee247495c0f09a;p=lhc%2Fweb%2Fwiklou.git

diff --git a/includes/libs/rdbms/lbfactory/ILBFactory.php b/includes/libs/rdbms/lbfactory/ILBFactory.php
index 812064a772..4b6afe7089 100644
--- a/includes/libs/rdbms/lbfactory/ILBFactory.php
+++ b/includes/libs/rdbms/lbfactory/ILBFactory.php
@@ -31,9 +31,12 @@ use InvalidArgumentException;
  * @since 1.28
  */
 interface ILBFactory {
+	/** @var int Don't save DB positions at all */
 	const SHUTDOWN_NO_CHRONPROT = 0; // don't save DB positions at all
-	const SHUTDOWN_CHRONPROT_ASYNC = 1; // save DB positions, but don't wait on remote DCs
-	const SHUTDOWN_CHRONPROT_SYNC = 2; // save DB positions, waiting on all DCs
+	/** @var int Save DB positions, but don't wait on remote DCs */
+	const SHUTDOWN_CHRONPROT_ASYNC = 1;
+	/** @var int Save DB positions, waiting on all DCs */
+	const SHUTDOWN_CHRONPROT_SYNC = 2;
 
 	/**
 	 * Construct a manager of ILoadBalancer objects
@@ -140,6 +143,8 @@ interface ILBFactory {
 	/**
 	 * Get cached (tracked) load balancers for all main database clusters
 	 *
+	 * The default cluster name is ILoadBalancer::CLUSTER_MAIN_DEFAULT
+	 *
 	 * @return ILoadBalancer[] Map of (cluster name => ILoadBalancer)
 	 * @since 1.29
 	 */
@@ -154,7 +159,8 @@ interface ILBFactory {
 	public function getAllExternalLBs();
 
 	/**
-	 * Execute a function for each tracked load balancer
+	 * Execute a function for each currently tracked (instantiated) load balancer
+	 *
 	 * The callback is called with the load balancer as the first parameter,
 	 * and $params passed as the subsequent parameters.
 	 *
@@ -164,7 +170,8 @@ interface ILBFactory {
 	public function forEachLB( $callback, array $params = [] );
 
 	/**
-	 * Prepare all tracked load balancers for shutdown
+	 * Prepare all currently tracked (instantiated) load balancers for shutdown
+	 *
 	 * @param int $mode One of the class SHUTDOWN_* constants
 	 * @param callable|null $workCallback Work to mask ChronologyProtector writes
 	 * @param int|null &$cpIndex Position key write counter for ChronologyProtector