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

Public Member Functions
	__construct ($subject)

bool	acquire ($mode=self::LOCK_CAPABILITY_EXCLUSIVE)

bool	release ()

	destroy ()

bool	isAcquired ()

Static Public Member Functions
static int	getCapabilities ()

static int	getPriority ()

Public Attributes
const	LOCK_CAPABILITY_EXCLUSIVE = 1

const	LOCK_CAPABILITY_SHARED = 2

const	LOCK_CAPABILITY_NOBLOCK = 4

Detailed Description

Interface for locking methods

Definition at line 25 of file LockingStrategyInterface.php.

Constructor & Destructor Documentation

◆ __construct()

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

Parameters

string $subject ‪ID to identify this lock in the system

Exceptions

LockCreateException ‪if the lock could not be created

Implemented in TYPO3\CMS\Core\Locking\SemaphoreLockStrategy, TYPO3\CMS\Core\Locking\SimpleLockStrategy, TYPO3\CMS\Core\Locking\FileLockStrategy, and TYPO3\CMS\Core\Tests\Unit\Locking\Fixtures\DummyLock.

Member Function Documentation

◆ acquire()

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

Try to acquire a lock

Parameters

int $mode ‪LOCK_CAPABILITY_EXCLUSIVE or LOCK_CAPABILITY_SHARED

Returns: ‪bool Returns TRUE if the lock was acquired successfully

Exceptions

LockAcquireException	‪if the lock could not be acquired
LockAcquireWouldBlockException	‪if the acquire would have blocked and NOBLOCK was set

Implemented in TYPO3\CMS\Core\Locking\SimpleLockStrategy, TYPO3\CMS\Core\Locking\SemaphoreLockStrategy, TYPO3\CMS\Core\Locking\FileLockStrategy, and TYPO3\CMS\Core\Tests\Unit\Locking\Fixtures\DummyLock.

◆ destroy()

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

Destroys the resource associated with the lock

Implemented in TYPO3\CMS\Core\Locking\SimpleLockStrategy, TYPO3\CMS\Core\Locking\FileLockStrategy, TYPO3\CMS\Core\Locking\SemaphoreLockStrategy, and TYPO3\CMS\Core\Tests\Unit\Locking\Fixtures\DummyLock.

◆ getCapabilities()

static int TYPO3\CMS\Core\Locking\LockingStrategyInterface::getCapabilities ( )

static

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

Implemented in TYPO3\CMS\Core\Locking\FileLockStrategy, TYPO3\CMS\Core\Locking\SimpleLockStrategy, TYPO3\CMS\Core\Locking\SemaphoreLockStrategy, and TYPO3\CMS\Core\Tests\Unit\Locking\Fixtures\DummyLock.

◆ getPriority()

static int TYPO3\CMS\Core\Locking\LockingStrategyInterface::getPriority ( )

static

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

Implemented in TYPO3\CMS\Core\Locking\SimpleLockStrategy, TYPO3\CMS\Core\Locking\FileLockStrategy, TYPO3\CMS\Core\Locking\SemaphoreLockStrategy, and TYPO3\CMS\Core\Tests\Unit\Locking\Fixtures\DummyLock.

◆ isAcquired()

bool TYPO3\CMS\Core\Locking\LockingStrategyInterface::isAcquired ( )

Get status of this lock

Returns: ‪bool Returns TRUE if lock is acquired by this locker, FALSE otherwise

Implemented in TYPO3\CMS\Core\Locking\FileLockStrategy, TYPO3\CMS\Core\Locking\SimpleLockStrategy, TYPO3\CMS\Core\Locking\SemaphoreLockStrategy, and TYPO3\CMS\Core\Tests\Unit\Locking\Fixtures\DummyLock.

◆ release()

bool TYPO3\CMS\Core\Locking\LockingStrategyInterface::release ( )

Release the lock

Returns: ‪bool Returns TRUE on success or FALSE on failure

Implemented in TYPO3\CMS\Core\Locking\FileLockStrategy, TYPO3\CMS\Core\Locking\SemaphoreLockStrategy, TYPO3\CMS\Core\Locking\SimpleLockStrategy, and TYPO3\CMS\Core\Tests\Unit\Locking\Fixtures\DummyLock.

Member Data Documentation

◆ LOCK_CAPABILITY_EXCLUSIVE

const TYPO3\CMS\Core\Locking\LockingStrategyInterface::LOCK_CAPABILITY_EXCLUSIVE = 1

Exclusive locks can be acquired

Definition at line 30 of file LockingStrategyInterface.php.

Referenced by TYPO3\CMS\Core\Locking\ResourceMutex\acquireLock(), TYPO3\CMS\Core\Tests\Unit\Locking\Fixtures\DummyLock\getCapabilities(), TYPO3\CMS\Core\Locking\SemaphoreLockStrategy\getCapabilities(), TYPO3\CMS\Core\Tests\Unit\Locking\LockFactoryTest\getLockerReturnsExpectedClass(), and TYPO3\CMS\Core\Tests\Unit\Locking\LockFactoryTest\getLockerThrowsExceptionIfNoMatchFound().

◆ LOCK_CAPABILITY_NOBLOCK

const TYPO3\CMS\Core\Locking\LockingStrategyInterface::LOCK_CAPABILITY_NOBLOCK = 4

Do not block when acquiring the lock

Definition at line 40 of file LockingStrategyInterface.php.

Referenced by TYPO3\CMS\Core\Locking\ResourceMutex\acquireLock(), TYPO3\CMS\Core\Locking\SimpleLockStrategy\getCapabilities(), TYPO3\CMS\Core\Locking\FileLockStrategy\getCapabilities(), and TYPO3\CMS\Core\Tests\Unit\Locking\LockFactoryTest\getLockerThrowsExceptionIfNoMatchFound().

◆ LOCK_CAPABILITY_SHARED

const TYPO3\CMS\Core\Locking\LockingStrategyInterface::LOCK_CAPABILITY_SHARED = 2

Shared locks can be acquired

Definition at line 35 of file LockingStrategyInterface.php.

Referenced by TYPO3\CMS\Core\Tests\Unit\Locking\LockFactoryTest\getLockerReturnsExpectedClass(), and TYPO3\CMS\Core\Tests\Unit\Locking\LockFactoryTest\getLockerThrowsExceptionIfNoMatchFound().

Public Member Functions

Static Public Member Functions

Public Attributes