spiral / lock-bridge
This package provides a integration bridge for the RoadRunner Lock.
Requires
- php: ^8.1
- roadrunner-php/lock: ^1.0
- spiral/boot: ^3.7
- spiral/roadrunner-bridge: ^3.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.20
- phpunit/phpunit: ^10.2
- spiral/nyholm-bridge: ^1.3
- spiral/testing: ^2.4
- vimeo/psalm: ^5.13
This package is auto-updated.
Last update: 2024-10-28 14:17:34 UTC
README
This package provides a integration bridge for the RoadRunner Lock, which allows for easy management of distributed locks in Spiral Framework. The package provides a fast, lightweight, and reliable way to acquire, release, and manage locks in a distributed environment, making it ideal for use in high-traffic web applications and microservices.
Requirements
Make sure that your server is configured with following PHP version and extensions:
- PHP 8.1+
- Spiral Framework 3.7+
Installation
You can install the package via composer:
composer require spiral/lock-bridge
After package install you need to register bootloader from the package.
protected const LOAD = [ // ... \Spiral\LockBridge\Bootloader\LockBootloader::class, ];
Note If you are using
spiral-packages/discoverer
, you don't need to register bootloader by yourself.
Usage
use RoadRunner\Lock\LockInterface; $lock = $container->get(LockInterface::class);
Acquire lock
Locks a resource so that it can be accessed by one process at a time. When a resource is locked, other processes that attempt to lock the same resource will be blocked until the lock is released.
$id = $lock->lock('pdf:create'); // Acquire lock with ttl - 10 seconds $id = $lock->lock('pdf:create', ttl: 10); // or $id = $lock->lock('pdf:create', ttl: new \DateInterval('PT10S')); // Acquire lock and wait 5 seconds until lock will be released $id = $lock->lock('pdf:create', wait: 5); // or $id = $lock->lock('pdf:create', wait: new \DateInterval('PT5S')); // Acquire lock with id - 14e1b600-9e97-11d8-9f32-f2801f1b9fd1 $id = $lock->lock('pdf:create', id: '14e1b600-9e97-11d8-9f32-f2801f1b9fd1');
Acquire read lock
Locks a resource for shared access, allowing multiple processes to access the resource simultaneously. When a resource is locked for shared access, other processes that attempt to lock the resource for exclusive access will be blocked until all shared locks are released.
$id = $lock->lockRead('pdf:create', ttl: 10); // or $id = $lock->lockRead('pdf:create', ttl: new \DateInterval('PT10S')); // Acquire lock and wait 5 seconds until lock will be released $id = $lock->lockRead('pdf:create', wait: 5); // or $id = $lock->lockRead('pdf:create', wait: new \DateInterval('PT5S')); // Acquire lock with id - 14e1b600-9e97-11d8-9f32-f2801f1b9fd1 $id = $lock->lockRead('pdf:create', id: '14e1b600-9e97-11d8-9f32-f2801f1b9fd1');
Release lock
Releases an exclusive lock or read lock on a resource that was previously acquired by a call to lock()
or lockRead()
.
// Release lock after task is done. $lock->release('pdf:create', $id); // Force release lock $lock->forceRelease('pdf:create');
Check lock
Checks if a resource is currently locked and returns information about the lock.
$status = $lock->exists('pdf:create'); if($status) { // Lock exists } else { // Lock not exists }
Update TTL
Updates the time-to-live (TTL) for the locked resource.
// Add 10 seconds to lock ttl $lock->updateTTL('pdf:create', $id, 10); // or $lock->updateTTL('pdf:create', $id, new \DateInterval('PT10S'));
Testing
composer test
License
The MIT License (MIT). Please see License File for more information.