Base class for lock managers that use a quorum of peer servers for locks. More...

Inherits Wikimedia\LockManager\LockManager.

Inherited by Wikimedia\LockManager\MemcLockManager, and Wikimedia\LockManager\RedisLockManager.

Collaboration diagram for Wikimedia\LockManager\QuorumLockManager:

[legend]

Protected Member Functions

doLockByType (array $pathsByType)

Acquire a set of locks without blocking.If some locks could not be acquired, then the other locks should be released. This must set the "lockmanager-fail-conflict" error if there are any lock conflicts.

Parameters

array $pathsByType Map of LockManager::LOCK_* constants to lists of paths

Returns: StatusValue

See also: LockManager::lockByType()

doLockingRequest (string $path, string $type)

Attempt to acquire locks with the peers.

doUnlockByType (array $pathsByType)

doUnlockingRequest (string $path, string $type)

Attempt to release locks with the peers.

freeLocksOnServer ( $lockServer, array $pathsByType)

Get a connection to a lock server and release locks on $paths.

getLocksOnServer ( $lockServer, array $pathsByType)

Get a connection to a lock server and acquire locks.

isServerUp ( $lockServer)

Check if a lock server is up.

releaseAllLocks ()

Release all locks that this session is holding.

Protected Member Functions inherited from Wikimedia\LockManager\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	$downServers = []
	list of down server names

array	$lockServers = []
	Map server names to data used by subclasses.

int	$minVotes = 2
	Minimum number of success to consider lock/unlock successful.

Protected Attributes inherited from Wikimedia\LockManager\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	MAX_LOCK_TTL = 2 * 3600
	Max expected lock expiry in any context.

const	MIN_LOCK_TTL = 5
	Minimum lock TTL.

Additional Inherited Members

Public Member Functions inherited from Wikimedia\LockManager\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.

lockKey (string $key, int $timeout=0)

Provide a mutex of the key.

Parameters

string	$key	Key to lock (relative to a domain, usually represented by the wiki ID, which callers don't need to specify)
int	$timeout	Time to wait in seconds

Returns: bool true if the lock is acquired, false otherwise

scopedLock (string $key, int $timeout=0)

Lock a key and unlock it automatically when the object is destructed.

Parameters

string	$key
int	$timeout

Returns: ScopedCallback|null returns null when we failed to acquire the lock

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.

unlockKey (string $key)

Parameters

string $key Key to unlock (relative to a domain, usually represented by the wiki ID, which callers don't need to specify)

Returns: bool true if the lock is released, false otherwise

Public Attributes inherited from Wikimedia\LockManager\LockManager

const LOCK_EX = 3

const LOCK_SH = 1

Lock types; stronger locks have higher values.

const LOCK_UW = 2

Detailed Description

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.

Stability: stable: to extend

Since: 1.20

Definition at line 22 of file QuorumLockManager.php.

Member Function Documentation

◆ doLockByType()

Wikimedia\LockManager\QuorumLockManager::doLockByType ( array $pathsByType )

finalprotected

Acquire a set of locks without blocking.If some locks could not be acquired, then the other locks should be released. This must set the "lockmanager-fail-conflict" error if there are any lock conflicts.

Parameters

array $pathsByType Map of LockManager::LOCK_* constants to lists of paths