https://github.com/yiisoft/mutex
Mutex lock implementation
https://github.com/yiisoft/mutex
hacktoberfest lock mutex yii3
Last synced: 4 months ago
JSON representation
Mutex lock implementation
- Host: GitHub
- URL: https://github.com/yiisoft/mutex
- Owner: yiisoft
- License: bsd-3-clause
- Created: 2018-11-10T15:59:00.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-04-10T02:43:32.000Z (about 1 year ago)
- Last Synced: 2024-04-15T03:05:30.274Z (about 1 year ago)
- Topics: hacktoberfest, lock, mutex, yii3
- Language: PHP
- Homepage: https://www.yiiframework.com/
- Size: 136 KB
- Stars: 33
- Watchers: 21
- Forks: 6
- Open Issues: 1
-
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
[](https://packagist.org/packages/yiisoft/mutex)
[](https://packagist.org/packages/yiisoft/mutex)
[](https://github.com/yiisoft/mutex/actions/workflows/build.yml)
[](https://scrutinizer-ci.com/g/yiisoft/mutex/?branch=master)
[](https://scrutinizer-ci.com/g/yiisoft/mutex/?branch=master)
[](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/mutex/master)
[](https://github.com/yiisoft/mutex/actions?query=workflow%3A%22static+analysis%22)
[](https://shepherd.dev/github/yiisoft/mutex)
This package provides mutex implementation and allows mutual execution of concurrent processes in order to prevent
"race conditions".
This is achieved by using a "lock" mechanism. Each possibly concurrent processes cooperates by acquiring
a lock before accessing the corresponding data.
## Requirements
- PHP 7.4 or higher.
## Installation
The package could be installed with [Composer](https://getcomposer.org):
```shell
composer require yiisoft/mutex
```
## General usage
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
/** @var \Yiisoft\Mutex\Synchronizer $synchronizer */
$newCount = $synchronizer->execute('critical', function () {
return $counter->increase();
}, 10);
```
Another way is to manually open and close mutex:
```php
/** @var \Yiisoft\Mutex\SimpleMutex $simpleMutex */
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
/** @var \Yiisoft\Mutex\MutexFactoryInterface $mutexFactory */
$mutex = $mutexFactory->createAndAcquire('critical', 10);
$newCount = $counter->increase();
$mutex->release();
```
And if you want even more control, you can acquire mutex manually:
```php
/** @var \Yiisoft\Mutex\MutexFactoryInterface $mutexFactory */
$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();
```
## Mutex drivers
There are some mutex drivers available as separate packages:
- [File](https://github.com/yiisoft/mutex-file)
- [PDO MySQL](https://github.com/yiisoft/mutex-pdo-mysql)
- [PDO Oracle](https://github.com/yiisoft/mutex-pdo-oracle)
- [PDO Postgres](https://github.com/yiisoft/mutex-pdo-pgsql)
- [Redis](https://github.com/yiisoft/mutex-redis)
If you want to provide your own driver, you need to implement `MutexFactoryInterface` and `MutexInterface`.
There is ready to extend `Mutex`, `MutexFactory` and a `RetryAcquireTrait` that contains `retryAcquire()`
method implementing the "wait for a lock for a certain time" functionality.
When implementing your own drivers, you need to take care of automatic unlocking. For example using a destructor:
```php
public function __destruct()
{
$this->release();
}
```
and shutdown function:
```php
public function __construct()
{
register_shutdown_function(function () {
$this->release();
});
}
```
Note that you should not call the `exit()` or `die()` functions in the destructor or shutdown function. Since calling
these functions in the destructor and shutdown function will prevent all subsequent completion functions from executing.
## 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 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)