yiisoft / mutex
Yii Mutex Library
Fund package maintenance!
Opencollective
yiisoft
Installs: 54 039
Dependents: 10
Suggesters: 0
Security: 0
Stars: 32
Watchers: 21
Forks: 7
Open Issues: 1
Requires
- php: ^7.4|^8.0
Requires (Dev)
- phpunit/phpunit: ^9.5
- roave/infection-static-analysis-plugin: ^1.14
- spatie/phpunit-watcher: ^1.23
- vimeo/psalm: ^4.9
Suggests
- yiisoft/mutex-file: Use the File driver for mutex
- yiisoft/mutex-pdo-mysql: Use the MySQL PDO driver for mutex
- yiisoft/mutex-pdo-oracle: Use the Oracle PDO driver for mutex
- yiisoft/mutex-pdo-pgsql: Use the Postgres PDO driver for mutex
- yiisoft/mutex-redis: Use the Redis driver for mutex
This package is auto-updated.
Last update: 2024-10-20 11:13:27 UTC
README
Yii 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:
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:
/** @var \Yiisoft\Mutex\Synchronizer $synchronizer */ $newCount = $synchronizer->execute('critical', function () { return $counter->increase(); }, 10);
Another way is to manually open and close mutex:
/** @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:
/** @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:
/** @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:
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:
public function __destruct() { $this->release(); }
and shutdown function:
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
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 is free software. It is released under the terms of the BSD License.
Please see LICENSE
for more information.
Maintained by Yii Software.