Inheritance diagram for TYPO3\CMS\Core\Locking\SimpleLockStrategy:

Public Member Functions
	__construct ($subject)

	init ($loops=0, $step=0)

	__destruct ()

	release ()

	isAcquired ()

	acquire ($mode=self::LOCK_CAPABILITY_EXCLUSIVE)

	destroy ()

Static Public Member Functions
static	getCapabilities ()

static	getPriority ()

Public Attributes
const	FILE_LOCK_FOLDER = 'typo3temp/locks/'

Public Attributes inherited from TYPO3\CMS\Core\Locking\LockingStrategyInterface
const	LOCK_CAPABILITY_EXCLUSIVE = 1

const	LOCK_CAPABILITY_SHARED = 2

const	LOCK_CAPABILITY_NOBLOCK = 4

Protected Attributes
	$filePath

	$isAcquired = false

	$loops = 150

	$step = 200

Detailed Description

Simple file locking

Definition at line 24 of file SimpleLockStrategy.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Core\Locking\SimpleLockStrategy::__construct ( $subject )

Parameters

string $subject ID to identify this lock in the system

Exceptions

LockCreateException if the lock could not be created

Implements TYPO3\CMS\Core\Locking\LockingStrategyInterface.

Definition at line 52 of file SimpleLockStrategy.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\mkdir().

◆ __destruct()

TYPO3\CMS\Core\Locking\SimpleLockStrategy::__destruct ( )

Destructor: Releases lock automatically when instance is destroyed and release resources

Definition at line 87 of file SimpleLockStrategy.php.

References TYPO3\CMS\Core\Locking\SimpleLockStrategy\release().

Member Function Documentation

◆ acquire()

TYPO3\CMS\Core\Locking\SimpleLockStrategy::acquire ( $mode = self::LOCK_CAPABILITY_EXCLUSIVE )

Try to acquire a lock

Parameters

int $mode LOCK_CAPABILITY_EXCLUSIVE or self::LOCK_CAPABILITY_NOBLOCK

Returns: bool Returns TRUE if the lock was acquired successfully

Exceptions

LockAcquireWouldBlockException

Implements TYPO3\CMS\Core\Locking\LockingStrategyInterface.

Definition at line 142 of file SimpleLockStrategy.php.

References TYPO3\CMS\Core\Locking\SimpleLockStrategy\$isAcquired, TYPO3\CMS\Core\Locking\SimpleLockStrategy\$loops, TYPO3\CMS\Core\Utility\GeneralUtility\fixPermissions(), and TYPO3\CMS\Core\Locking\SimpleLockStrategy\isAcquired().

◆ destroy()

TYPO3\CMS\Core\Locking\SimpleLockStrategy::destroy ( )

Destroys the resource associated with the lock

Returns: void

Implements TYPO3\CMS\Core\Locking\LockingStrategyInterface.

Definition at line 194 of file SimpleLockStrategy.php.

◆ getCapabilities()

static TYPO3\CMS\Core\Locking\SimpleLockStrategy::getCapabilities ( )

static

Returns: int LOCK_CAPABILITY_* elements combined with bit-wise OR

Implements TYPO3\CMS\Core\Locking\LockingStrategyInterface.

Definition at line 130 of file SimpleLockStrategy.php.

◆ getPriority()

static TYPO3\CMS\Core\Locking\SimpleLockStrategy::getPriority ( )

static

Returns: int Returns a priority for the method. 0 to 100, 100 is highest

Implements TYPO3\CMS\Core\Locking\LockingStrategyInterface.

Definition at line 184 of file SimpleLockStrategy.php.

◆ init()

TYPO3\CMS\Core\Locking\SimpleLockStrategy::init	(	$loops = `0`,
		$step = `0`
	)

Parameters

int	$loops	Number of times a locked resource is tried to be acquired.
int	$step	Milliseconds after lock acquire is retried. $loops * $step results in the maximum delay of a lock.