https://github.com/yiisoft/mutex-redis
Redis mutex implementation for yiisoft/mutex.
https://github.com/yiisoft/mutex-redis
hacktoberfest mutex redis yii3
Last synced: 5 months ago
JSON representation
Redis mutex implementation for yiisoft/mutex.
- Host: GitHub
- URL: https://github.com/yiisoft/mutex-redis
- Owner: yiisoft
- License: bsd-3-clause
- Created: 2019-04-14T15:44:00.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-03-31T14:45:08.000Z (over 2 years ago)
- Last Synced: 2024-03-21T12:05:17.810Z (over 1 year ago)
- Topics: hacktoberfest, mutex, redis, yii3
- Language: PHP
- Homepage: https://www.yiiframework.com/
- Size: 49.8 KB
- Stars: 8
- Watchers: 18
- Forks: 4
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
Yii Mutex Library - Redis Driver
[](https://packagist.org/packages/yiisoft/mutex-redis)
[](https://packagist.org/packages/yiisoft/mutex-redis)
[](https://github.com/yiisoft/mutex-redis/actions/workflows/build.yml)
[](https://scrutinizer-ci.com/g/yiisoft/mutex-redis/?branch=master)
[](https://scrutinizer-ci.com/g/yiisoft/mutex-redis/?branch=master)
[](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/mutex-redis/master)
[](https://github.com/yiisoft/mutex-redis/actions?query=workflow%3A%22static+analysis%22)
[](https://shepherd.dev/github/yiisoft/mutex-redis)
This library provides a Redis mutex implementation for [yiisoft/mutex](https://github.com/yiisoft/mutex).
## Requirements
- PHP 7.4 or higher.
## Installation
The package could be installed with [Composer](https://getcomposer.org):
```shell
composer require yiisoft/mutex-redis
```
## General usage
The package provides two classes implementing `MutexInterface` and `MutexFactoryInterface`
from the [yiisoft/mutex](https://github.com/yiisoft/mutex) package:
```php
/**
* @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](https://github.com/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:
```php
$synchronizer = new \Yiisoft\Mutex\Synchronizer($mutexFactory);
$newCount = $synchronizer->execute('critical', function () {
return $counter->increase();
}, 10);
```
Another way is to manually open and close mutex:
```php
$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:
```php
$mutex = $mutexFactory->createAndAcquire('critical', 10);
$newCount = $counter->increase();
$mutex->release();
```
And if you want even more control, you can acquire mutex manually:
```php
$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:
```php
$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
- [Internals](docs/internals.md)
If you need help or have a question, the [Yii Forum](https://forum.yiiframework.com/c/yii-3-0/63) is a good place for that.
You may also check out other [Yii Community Resources](https://www.yiiframework.com/community).
## License
The Yii Mutex Library - Redis Driver is free software. It is released under the terms of the BSD License.
Please see [`LICENSE`](./LICENSE.md) for more information.
Maintained by [Yii Software](https://www.yiiframework.com/).
## Support the project
[](https://opencollective.com/yiisoft)
## Follow updates
[](https://www.yiiframework.com/)
[](https://twitter.com/yiiframework)
[](https://t.me/yii3en)
[](https://www.facebook.com/groups/yiitalk)
[](https://yiiframework.com/go/slack)