yiisoft / mutex-file
Yii Mutex Library - File Driver
Fund package maintenance!
Opencollective
yiisoft
Installs: 2 111
Dependents: 1
Suggesters: 1
Security: 0
Stars: 11
Watchers: 18
Forks: 6
Open Issues: 2
Requires
- php: ^7.4|^8.0
- yiisoft/files: ^1.0|^2.0
- yiisoft/mutex: ^1.1
Requires (Dev)
- phpunit/phpunit: ^9.5
- roave/infection-static-analysis-plugin: ^1.16
- spatie/phpunit-watcher: ^1.23
- vimeo/psalm: ^4.18
This package is auto-updated.
Last update: 2024-10-16 12:55:24 UTC
README
Yii Mutex Library - File Driver
This library provides a File mutex implementation for yiisoft/mutex.
Requirements
- PHP 7.4 or higher.
Installation
The package could be installed with Composer:
composer require yiisoft/mutex-file
General usage
The package provides two classes implementing MutexInterface
and MutexFactoryInterface
from the yiisoft/mutex package:
$mutex = new \Yiisoft\Mutex\File\FileMutex( 'mutex-name', '/path/to/directory/for/storing/mutex/files', 0775, // Optional. The permission to be set for newly created mutex directory. Default is `0775`. 0777, // Optional. The permission to be set for newly created mutex files. Default is `null`. ); $mutexFactory = new \Yiisoft\Mutex\File\FileMutexFactory( '/path/to/directory/for/storing/mutex/files', 0775, // Optional. The permission to be set for newly created mutex directory. Default is `0775`. 0777, // Optional. The permission to be set for newly created mutex files. Default is `null`. );
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 = new \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 FileMutex
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 - File Driver is free software. It is released under the terms of the BSD License.
Please see LICENSE
for more information.
Maintained by Yii Software.