MediaWiki master
|
Base class for lock managers that use a quorum of peer servers for locks. More...
Inherits LockManager.
Inherited by MemcLockManager, and RedisLockManager.
Protected Member Functions | |
collectPledgeQuorum ( $bucket, callable $callback) | |
Attempt to acquire pledges with the peers for a bucket. | |
doLock (array $paths, $type) | |
Lock resources with the given keys and lock type. | |
doLockByType (array $pathsByType) | |
doLockingRequestBucket ( $bucket, array $pathsByType) | |
Attempt to acquire locks with the peers for a bucket. | |
doUnlock (array $paths, $type) | |
Unlock resources with the given keys and lock type. | |
doUnlockByType (array $pathsByType) | |
doUnlockingRequestBucket ( $bucket, array $pathsByType) | |
Attempt to release locks with the peers for a bucket. | |
freeLocksOnServer ( $lockSrv, array $pathsByType) | |
Get a connection to a lock server and release locks on $paths. | |
getBucketFromPath ( $path) | |
Get the bucket for resource path. | |
getLocksOnServer ( $lockSrv, array $pathsByType) | |
Get a connection to a lock server and acquire locks. | |
isServerUp ( $lockSrv) | |
Check if a lock server is up. | |
releaseAllLocks () | |
Release all locks that this session is holding. | |
releasePledges ( $bucket, callable $callback) | |
Attempt to release pledges with the peers for a bucket. | |
Protected Member Functions inherited from LockManager | |
normalizePathsByType (array $pathsByType) | |
Normalize the $paths array by converting LOCK_UW locks into the appropriate type and removing any duplicated paths for each lock type. | |
sha1Base36Absolute ( $path) | |
Get the base 36 SHA-1 of a string, padded to 31 digits. | |
Protected Attributes | |
array | $degradedBuckets = [] |
Map of degraded buckets. | |
array | $srvsByBucket = [] |
Map of bucket indexes to peer server lists. | |
Protected Attributes inherited from LockManager | |
string | $domain |
domain (usually wiki ID) | |
array | $locksHeld = [] |
Map of (resource path => lock type => count) | |
int | $lockTTL |
maximum time locks can be held | |
array | $lockTypeMap |
Mapping of lock types to the type actually used. | |
LoggerInterface | $logger |
string | $session |
Random 32-char hex number. | |
const | CLI_LOCK_TTL = 3600 |
Default lock TTL in CLI mode. | |
const | MAX_LOCK_TTL = 2 * 3600 |
Max expected lock expiry in any context. | |
const | MIN_GUESSED_LOCK_TTL = 5 * 60 |
The minimum lock TTL if it is guessed from max_execution_time rather than configured. | |
const | MIN_LOCK_TTL = 5 |
Minimum lock TTL. | |
Additional Inherited Members | |
Public Member Functions inherited from LockManager | |
__construct (array $config) | |
Construct a new instance from configuration. | |
lock (array $paths, $type=self::LOCK_EX, $timeout=0) | |
Lock the resources at the given abstract paths. | |
lockByType (array $pathsByType, $timeout=0) | |
Lock the resources at the given abstract paths. | |
unlock (array $paths, $type=self::LOCK_EX) | |
Unlock the resources at the given abstract paths. | |
unlockByType (array $pathsByType) | |
Unlock the resources at the given abstract paths. | |
Public Attributes inherited from LockManager | |
const | LOCK_EX = 3 |
const | LOCK_SH = 1 |
Lock types; stronger locks have higher values. | |
const | LOCK_UW = 2 |
Base class for lock managers that use a quorum of peer servers for locks.
The resource space can also be sharded into separate peer groups.
See MemcLockManager and RedisLockManager.
Definition at line 32 of file QuorumLockManager.php.
|
finalprotected |
Attempt to acquire pledges with the peers for a bucket.
This is all or nothing; if any key is already pledged then this totally fails.
int | $bucket | |
callable | $callback | Pledge method taking a server name and yielding a StatusValue |
Definition at line 166 of file QuorumLockManager.php.
References isServerUp().
Referenced by doLockingRequestBucket().
|
finalprotected |
Lock resources with the given keys and lock type.
array | $paths | List of paths |
int | $type | LockManager::LOCK_* constant |
Reimplemented from LockManager.
Definition at line 286 of file QuorumLockManager.php.
|
finalprotected |
array | $pathsByType | Map of LockManager::LOCK_* constants to lists of paths |
Reimplemented from LockManager.
Definition at line 39 of file QuorumLockManager.php.
References $path, doLockingRequestBucket(), doUnlockByType(), and getBucketFromPath().
|
finalprotected |
Attempt to acquire locks with the peers for a bucket.
This is all or nothing; if any key is locked then this totally fails.
int | $bucket | |
array | $pathsByType | Map of LockManager::LOCK_* constants to lists of paths |
Definition at line 133 of file QuorumLockManager.php.
References collectPledgeQuorum(), and getLocksOnServer().
Referenced by doLockByType().
|
finalprotected |
Unlock resources with the given keys and lock type.
array | $paths | List of paths |
int | $type | LockManager::LOCK_* constant |
Reimplemented from LockManager.
Definition at line 291 of file QuorumLockManager.php.
|
protected |
array | $pathsByType |
Reimplemented from LockManager.
Definition at line 89 of file QuorumLockManager.php.
References $path, doUnlockingRequestBucket(), getBucketFromPath(), and releaseAllLocks().
Referenced by doLockByType().
|
finalprotected |
Attempt to release locks with the peers for a bucket.
int | $bucket | |
array | $pathsByType | Map of LockManager::LOCK_* constants to lists of paths |
Definition at line 149 of file QuorumLockManager.php.
References freeLocksOnServer(), and releasePledges().
Referenced by doUnlockByType().
|
abstractprotected |
Get a connection to a lock server and release locks on $paths.
Subclasses must effectively implement this or releaseAllLocks().
string | $lockSrv | |
array | $pathsByType | Map of LockManager::LOCK_* constants to lists of paths |
Reimplemented in MemcLockManager, and RedisLockManager.
Referenced by doUnlockingRequestBucket().
|
protected |
Get the bucket for resource path.
This should avoid throwing any exceptions.
string | $path |
Definition at line 243 of file QuorumLockManager.php.
References $path.
Referenced by doLockByType(), and doUnlockByType().
|
abstractprotected |
Get a connection to a lock server and acquire locks.
string | $lockSrv | |
array | $pathsByType | Map of LockManager::LOCK_* constants to lists of paths |
Reimplemented in MemcLockManager, and RedisLockManager.
Referenced by doLockingRequestBucket().
|
abstractprotected |
Check if a lock server is up.
This should process cache results to reduce RTT.
string | $lockSrv |
Reimplemented in MemcLockManager, and RedisLockManager.
Referenced by collectPledgeQuorum(), and releasePledges().
|
abstractprotected |
Release all locks that this session is holding.
Subclasses must effectively implement this or freeLocksOnServer().
Reimplemented in MemcLockManager, and RedisLockManager.
Referenced by doUnlockByType().
|
finalprotected |
Attempt to release pledges with the peers for a bucket.
int | $bucket | |
callable | $callback | Pledge method taking a server name and yielding a StatusValue |
Definition at line 208 of file QuorumLockManager.php.
References isServerUp().
Referenced by doUnlockingRequestBucket().
|
protected |
Map of degraded buckets.
Definition at line 37 of file QuorumLockManager.php.
|
protected |
Map of bucket indexes to peer server lists.
Definition at line 34 of file QuorumLockManager.php.