Interface LockInterface
Interface for lock engines.
Lock engines provide distributed locking mechanisms to prevent race conditions when multiple processes access shared resources.
Method Summary
-
acquire() public
Acquire a lock for the given resource.
-
acquireBlocking() public
Acquire a lock, waiting up to $timeout seconds if necessary.
-
forceRelease() public
Force release a lock without ownership verification.
-
isLocked() public
Check if a resource is currently locked.
-
refresh() public
Refresh a lock's TTL to extend its duration.
-
release() public
Release a lock.
Method Detail
acquire() ¶ public
acquire(string $resource, int $ttl = 300): Cake\Lock\AcquiredLock|nullAcquire a lock for the given resource.
Parameters
-
string$resource The resource identifier to lock.
-
int$ttl optional Time-to-live in seconds. The lock will automatically expire after this duration to prevent deadlocks.
Returns
Cake\Lock\AcquiredLock|nullReturns an AcquiredLock on success, null on failure.
acquireBlocking() ¶ public
acquireBlocking(string $resource, int $ttl = 300, int $timeout = 10, int $retryInterval = 100): Cake\Lock\AcquiredLock|nullAcquire a lock, waiting up to $timeout seconds if necessary.
This method will block until the lock is acquired or the timeout is reached.
Parameters
-
string$resource The resource identifier to lock.
-
int$ttl optional Time-to-live in seconds for the lock.
-
int$timeout optional Maximum time in seconds to wait for the lock.
-
int$retryInterval optional Milliseconds to wait between retry attempts.
Returns
Cake\Lock\AcquiredLock|nullReturns an AcquiredLock on success, null on timeout.
forceRelease() ¶ public
forceRelease(string $resource): boolForce release a lock without ownership verification.
WARNING: This should only be used for administrative purposes as it bypasses owner verification and may cause race conditions.
Parameters
-
string$resource The resource identifier to force release.
Returns
boolTrue if the lock was released, false otherwise.
isLocked() ¶ public
isLocked(string $resource): boolCheck if a resource is currently locked.
Note: This is a point-in-time check and the lock status may change immediately after this method returns.
Parameters
-
string$resource The resource identifier to check.
Returns
boolTrue if the resource is locked, false otherwise.
refresh() ¶ public
refresh(Cake\Lock\AcquiredLock $lock, int|null $ttl = null): boolRefresh a lock's TTL to extend its duration.
This is useful for long-running operations that need to hold a lock longer than initially anticipated.
Parameters
-
Cake\Lock\AcquiredLock$lock The lock instance to refresh.
-
int|null$ttl optional New TTL in seconds. If null, uses the original TTL.
Returns
boolTrue if the lock was refreshed, false otherwise.
release() ¶ public
release(Cake\Lock\AcquiredLock $lock): boolRelease a lock.
Parameters
-
Cake\Lock\AcquiredLock$lock The lock instance to release.
Returns
boolTrue if the lock was released, false otherwise.