Wikimedia\LockManager\NullLockManager Class Reference

Simple lock management based on in-process reference counting. More...

Inherits Wikimedia\LockManager\LockManager.

Collaboration diagram for Wikimedia\LockManager\NullLockManager:

Protected Member Functions
	doLock (array $paths, $type)
	Lock resources with the given keys and lock type. Parameters array $paths List of paths int $type LockManager::LOCK_* constant Returns StatusValue
	doUnlock (array $paths, $type)
	Unlock resources with the given keys and lock type. Parameters array $paths List of paths int $type LockManager::LOCK_* constant Returns StatusValue
Protected Member Functions inherited from Wikimedia\LockManager\LockManager
	doLockByType (array $pathsByType)
	doUnlockByType (array $pathsByType)
	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.

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.
	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 Wikimedia\LockManager\LockManager
const	LOCK_EX = 3
const	LOCK_SH = 1
	Lock types; stronger locks have higher values.
const	LOCK_UW = 2
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.

Detailed Description

Simple lock management based on in-process reference counting.

Since

1.19

Definition at line 16 of file NullLockManager.php.

Member Function Documentation

doLock()

Wikimedia\LockManager\NullLockManager::doLock ( array $paths, $type )

protected

Lock resources with the given keys and lock type.

Parameters

array	$paths	List of paths
int	$type	LockManager::LOCK_* constant

Returns

StatusValue

Reimplemented from Wikimedia\LockManager\LockManager.

Definition at line 18 of file NullLockManager.php.

References $path.

doUnlock()

Wikimedia\LockManager\NullLockManager::doUnlock ( array $paths, $type )

protected

Unlock resources with the given keys and lock type.

Parameters

array	$paths	List of paths
int	$type	LockManager::LOCK_* constant

Returns

StatusValue

Reimplemented from Wikimedia\LockManager\LockManager.

Definition at line 31 of file NullLockManager.php.

References $path.

---

The documentation for this class was generated from the following file:

• includes/libs/LockManager/NullLockManager.php