yiisoft / mutex-redis
Yii Mutex Library - Redis Driver
Fund package maintenance!
Opencollective
yiisoft
Installs: 19 372
Dependents: 0
Suggesters: 1
Security: 0
Stars: 8
Watchers: 19
Forks: 5
Open Issues: 4
Requires
- php: ^7.4|^8.0
- predis/predis: ^1.1
- yiisoft/mutex: ^1.1
- yiisoft/security: ^1.0
Requires (Dev)
- phpunit/phpunit: ^9.5
- roave/infection-static-analysis-plugin: ^1.9
- spatie/phpunit-watcher: ^1.23
- vimeo/psalm: ^4.9
This package is auto-updated.
Last update: 2024-10-20 11:24:54 UTC
README
Yii Mutex Library - Redis Driver
This library provides a Redis mutex implementation for yiisoft/mutex.
Requirements
- PHP 7.4 or higher.
Installation
The package could be installed with Composer:
composer require yiisoft/mutex-redis
General usage
The package provides two classes implementing MutexInterface
and MutexFactoryInterface
from the yiisoft/mutex package:
/** * @var \Predis\ClientInterface $client Predis client instance to use. */ $mutex = new \Yiisoft\Mutex\Redis\RedisMutex( 'mutex-name', $client, 60, // Optional. Number of seconds in which the lock will be auto released. Default is `30`. ); $mutexFactory = new \Yiisoft\Mutex\Redis\RedisMutexFactory( $client, 60, // Optional. Number of seconds in which the lock will be auto released. Default is `30`. );
For more information about the client instance and connection configuration, see the documentation of the predis/predis package.
There are multiple ways you can use the package. You can execute a callback in a synchronized mode i.e. only a single instance of the callback is executed at the same time:
$synchronizer = new \Yiisoft\Mutex\Synchronizer($mutexFactory); $newCount = $synchronizer->execute('critical', function () { return $counter->increase(); }, 10);
Another way is to manually open and close mutex:
$simpleMutex = \Yiisoft\Mutex\SimpleMutex($mutexFactory); if (!$simpleMutex->acquire('critical', 10)) { throw new \Yiisoft\Mutex\Exception\MutexLockedException('Unable to acquire the "critical" mutex.'); } $newCount = $counter->increase(); $simpleMutex->release('critical');
It could be done on lower level:
$mutex = $mutexFactory->createAndAcquire('critical', 10); $newCount = $counter->increase(); $mutex->release();
And if you want even more control, you can acquire mutex manually:
$mutex = $mutexFactory->create('critical'); if (!$mutex->acquire(10)) { throw new \Yiisoft\Mutex\Exception\MutexLockedException('Unable to acquire the "critical" mutex.'); } $newCount = $counter->increase(); $mutex->release();
The RedisMutex
supports the "wait for a lock for a certain time" functionality. Using the withRetryDelay()
method, you can override the number of milliseconds between each try until specified timeout times out:
$mutex = $mutex->withRetryDelay(100);
By default, it is 50 milliseconds - it means that we may try to acquire lock up to 20 times per second.
Documentation
If you need help or have a question, the Yii Forum is a good place for that. You may also check out other Yii Community Resources.
License
The Yii Mutex Library - Redis Driver is free software. It is released under the terms of the BSD License.
Please see LICENSE
for more information.
Maintained by Yii Software.