Manage locks using memcached servers. More...

Inheritance diagram for MemcLockManager:

Collaboration diagram for MemcLockManager:

Public Member Functions
	__construct (array $config)
	Construct a new instance from configuration. More...

	__destruct ()
	Make sure remaining locks get cleared for sanity. More...

Public Member Functions inherited from LockManager
	__construct (array $config)
	Construct a new instance from configuration. More...

	lock (array $paths, $type=self::LOCK_EX, $timeout=0)
	Lock the resources at the given abstract paths. More...

	lockByType (array $pathsByType, $timeout=0)
	Lock the resources at the given abstract paths. More...

	unlock (array $paths, $type=self::LOCK_EX)
	Unlock the resources at the given abstract paths. More...

	unlockByType (array $pathsByType)
	Unlock the resources at the given abstract paths. More...

Protected Member Functions
	acquireMutexes (MemcachedBagOStuff $memc, array $keys)

	freeLocksOnServer ($lockSrv, array $pathsByType)

	getCache ($lockSrv)
	Get the MemcachedBagOStuff object for a $lockSrv. More...

	getLocksOnServer ($lockSrv, array $pathsByType)

	isServerUp ($lockSrv)

	newLockArray ()

	recordKeyForPath ($path)

	releaseAllLocks ()

	releaseMutexes (MemcachedBagOStuff $memc, array $keys)

	sanitizeLockArray ($a)

Protected Member Functions inherited from QuorumLockManager
	doLock (array $paths, $type)

	doLockByType (array $pathsByType)

	doLockingRequestBucket ($bucket, array $pathsByType)
	Attempt to acquire locks with the peers for a bucket. More...

	doUnlock (array $paths, $type)

	doUnlockByType (array $pathsByType)

	doUnlockingRequestBucket ($bucket, array $pathsByType)
	Attempt to release locks with the peers for a bucket. More...

	freeLocksOnServer ($lockSrv, array $pathsByType)
	Get a connection to a lock server and release locks on $paths. More...

	getBucketFromPath ($path)
	Get the bucket for resource path. More...

	getLocksOnServer ($lockSrv, array $pathsByType)
	Get a connection to a lock server and acquire locks. More...

	isServerUp ($lockSrv)
	Check if a lock server is up. More...

	releaseAllLocks ()
	Release all locks that this session is holding. More...

Protected Member Functions inherited from LockManager
	doLock (array $paths, $type)
	Lock resources with the given keys and lock type. More...

	doLockByType (array $pathsByType)

	doUnlock (array $paths, $type)
	Unlock resources with the given keys and lock type. More...

	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. More...

	sha1Base16Absolute ($path)
	Get the base 16 SHA-1 of a string, padded to 31 digits. More...

	sha1Base36Absolute ($path)
	Get the base 36 SHA-1 of a string, padded to 31 digits. More...

Protected Attributes
MemcachedBagOStuff[]	$cacheServers = []
	Map of (server name => MemcachedBagOStuff) More...

array	$lockTypeMap
	Mapping of lock types to the type actually used. More...

HashBagOStuff	$statusCache
	Server status cache. More...

Protected Attributes inherited from QuorumLockManager
array	$degradedBuckets = []
	Map of degraded buckets. More...

array	$srvsByBucket = []
	Map of bucket indexes to peer server lists. More...

Protected Attributes inherited from LockManager
	$domain

array	$locksHeld = []
	Map of (resource path => lock type => count) More...

	$lockTTL

array	$lockTypeMap
	Mapping of lock types to the type actually used. More...

LoggerInterface	$logger

string	$session
	Random 32-char hex number. More...

Additional Inherited Members
Public Attributes inherited from LockManager
const	LOCK_EX = 3

const	LOCK_SH = 1
	Lock types; stronger locks have higher values. More...

const	LOCK_UW = 2

Detailed Description

Manage locks using memcached servers.

Version of LockManager based on using memcached servers. This is meant for multi-wiki systems that may share files. All locks are non-blocking, which avoids deadlocks.

All lock requests for a resource, identified by a hash string, will map to one bucket. Each bucket maps to one or several peer servers, each running memcached. A majority of peers must agree for a lock to be acquired.

Since: 1.20

Definition at line 39 of file MemcLockManager.php.

Constructor & Destructor Documentation

MemcLockManager::__construct ( array $config )

Construct a new instance from configuration.

Parameters

array

$config

Parameters include:

lockServers : Associative array of server names to "<IP>:<port>" strings.
srvsByBucket : Array of 1-16 consecutive integer keys, starting from 0, each having an odd-numbered list of server names (peers) as values.
memcConfig : Configuration array for MemcachedBagOStuff::construct() with an additional 'class' parameter specifying which MemcachedBagOStuff subclass to use. The server names will be injected. [optional]

Exceptions

Exception

Definition at line 64 of file MemcLockManager.php.

References $name, $params, and as.

MemcLockManager::__destruct ( )

Make sure remaining locks get cleared for sanity.

Definition at line 348 of file MemcLockManager.php.

References $path, as, and QuorumLockManager\doUnlock().