From: Aaron Schulz <aschulz@wikimedia.org>
Date: Mon, 15 Aug 2016 06:00:10 +0000 (-0700)
Subject: objectcache: expand getWithSetCallback() docs a bit
X-Git-Tag: 1.31.0-rc.0~6069^2
X-Git-Url: http://git.cyclocoop.org/%24self?a=commitdiff_plain;h=6da50011e43a2d882be89f1e8c3b22429458830a;p=lhc%2Fweb%2Fwiklou.git

objectcache: expand getWithSetCallback() docs a bit

Change-Id: Ifc8304848fd5e4b8f7ea5555271de09609cdbe10
---

diff --git a/includes/libs/objectcache/WANObjectCache.php b/includes/libs/objectcache/WANObjectCache.php
index 4fd40e2fba..143042cfde 100644
--- a/includes/libs/objectcache/WANObjectCache.php
+++ b/includes/libs/objectcache/WANObjectCache.php
@@ -466,7 +466,7 @@ class WANObjectCache implements IExpiringStore, LoggerAwareInterface {
 	 *
 	 * Example usage:
 	 * @code
-	 *     $dbw->begin( __METHOD__ ); // start of request
+	 *     $dbw->startAtomic( __METHOD__ ); // start of request
 	 *     ... <execute some stuff> ...
 	 *     // Update the row in the DB
 	 *     $dbw->update( ... );
@@ -476,7 +476,7 @@ class WANObjectCache implements IExpiringStore, LoggerAwareInterface {
 	 *         $cache->delete( $key );
 	 *     } );
 	 *     ... <execute some stuff> ...
-	 *     $dbw->commit( __METHOD__ ); // end of request
+	 *     $dbw->endAtomic( __METHOD__ ); // end of request
 	 * @endcode
 	 *
 	 * The $ttl parameter can be used when purging values that have not actually changed
@@ -689,7 +689,9 @@ class WANObjectCache implements IExpiringStore, LoggerAwareInterface {
 	 *             // Calling touchCheckKey() on this key invalidates the cache
 	 *             'checkKeys' => [ $cache->makeKey( 'site-cat-config' ) ],
 	 *             // Try to only let one datacenter thread manage cache updates at a time
-	 *             'lockTSE' => 30
+	 *             'lockTSE' => 30,
+	 *             // Avoid querying cache servers multiple times in a web request
+	 *             'pcTTL' => $cache::TTL_PROC_LONG
 	 *         ]
 	 *     );
 	 * @endcode
@@ -743,8 +745,12 @@ class WANObjectCache implements IExpiringStore, LoggerAwareInterface {
 	 *             // Merge them and get the new "last 100" rows
 	 *             return array_slice( array_merge( $new, $list ), 0, 100 );
 	 *        },
-	 *        // Try to only let one datacenter thread manage cache updates at a time
-	 *        [ 'lockTSE' => 30 ]
+	 *        [
+	 *             // Try to only let one datacenter thread manage cache updates at a time
+	 *             'lockTSE' => 30,
+	 *             // Use a magic value when no cache value is ready rather than stampeding
+	 *             'busyValue' => 'computing'
+	 *        ]
 	 *     );
 	 * @endcode
 	 *