Class yii\mutex\FileMutex
| Inheritance | yii\mutex\FileMutex » yii\mutex\Mutex » yii\base\Component » yii\base\BaseObject |
|---|---|
| Implements | yii\base\Configurable |
| Uses Traits | yii\mutex\RetryAcquireTrait |
| Available since version | 2.0 |
| Source Code | https://github.com/yiisoft/yii2/blob/master/framework/mutex/FileMutex.php |
FileMutex implements mutex "lock" mechanism via local file system files.
This component relies on PHP flock() function.
Application configuration example:
[
'components' => [
'mutex' => [
'class' => 'yii\mutex\FileMutex'
],
],
]
Note: this component can maintain the locks only for the single web server, it probably will not suffice in case you are using cloud server solution.
Warning: due to
flock()function nature this component is unreliable when using a multithreaded server API like ISAPI.
See also yii\mutex\Mutex.
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $autoRelease | boolean | Whether all locks acquired in this process (i.e. local locks) must be released automatically before finishing script execution. | yii\mutex\Mutex |
| $dirMode | integer | The permission to be set for newly created directories. | yii\mutex\FileMutex |
| $fileMode | integer | The permission to be set for newly created mutex files. | yii\mutex\FileMutex |
| $isWindows | boolean | Whether file handling should assume a Windows file system. | yii\mutex\FileMutex |
| $mutexPath | string | The directory to store mutex files. | yii\mutex\FileMutex |
| $retryDelay | integer | Number of milliseconds between each try in \yii\mutex\acquire() until specified timeout times out. | yii\mutex\RetryAcquireTrait |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __call() | Calls the named method which is not a class method. | yii\base\Component |
| __clone() | This method is called after the object is created by cloning an existing one. | yii\base\Component |
| __construct() | Constructor. | yii\base\BaseObject |
| __get() | Returns the value of a component property. | yii\base\Component |
| __isset() | Checks if a property is set, i.e. defined and not null. | yii\base\Component |
| __set() | Sets the value of a component property. | yii\base\Component |
| __unset() | Sets a component property to be null. | yii\base\Component |
| acquire() | Acquires a lock by name. | yii\mutex\Mutex |
| attachBehavior() | Attaches a behavior to this component. | yii\base\Component |
| attachBehaviors() | Attaches a list of behaviors to the component. | yii\base\Component |
| behaviors() | Returns a list of behaviors that this component should behave as. | yii\base\Component |
| canGetProperty() | Returns a value indicating whether a property can be read. | yii\base\Component |
| canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\Component |
| className() | Returns the fully qualified name of this class. | yii\base\BaseObject |
| detachBehavior() | Detaches a behavior from the component. | yii\base\Component |
| detachBehaviors() | Detaches all behaviors from the component. | yii\base\Component |
| ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. | yii\base\Component |
| getBehavior() | Returns the named behavior object. | yii\base\Component |
| getBehaviors() | Returns all behaviors attached to this component. | yii\base\Component |
| hasEventHandlers() | Returns a value indicating whether there is any handler attached to the named event. | yii\base\Component |
| hasMethod() | Returns a value indicating whether a method is defined. | yii\base\Component |
| hasProperty() | Returns a value indicating whether a property is defined for this component. | yii\base\Component |
| init() | Initializes mutex component implementation dedicated for UNIX, GNU/Linux, Mac OS X, and other UNIX-like operating systems. | yii\mutex\FileMutex |
| isAcquired() | Checks if a lock is currently acquired | yii\mutex\Mutex |
| off() | Detaches an existing event handler from this component. | yii\base\Component |
| on() | Attaches an event handler to an event. | yii\base\Component |
| release() | Releases acquired lock. This method will return false in case the lock was not found. | yii\mutex\Mutex |
| trigger() | Triggers an event. | yii\base\Component |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| acquireLock() | Acquires lock by given name. | yii\mutex\FileMutex |
| getLockFilePath() | Generate path for lock file. | yii\mutex\FileMutex |
| releaseLock() | Releases lock by given name. | yii\mutex\FileMutex |
Property Details
The permission to be set for newly created directories. This value will be used by PHP chmod() function. No umask will be applied. Defaults to 0775, meaning the directory is read-writable by owner and group, but read-only for other users.
The permission to be set for newly created mutex files. This value will be used by PHP chmod() function. No umask will be applied. If not set, the permission will be determined by the current environment.
Whether file handling should assume a Windows file system. This value will determine how releaseLock() goes about deleting the lock file. If not set, it will be determined by checking the DIRECTORY_SEPARATOR constant.
The directory to store mutex files. You may use path alias here. Defaults to the "mutex" subdirectory under the application runtime path.
Method Details
Acquires lock by given name.
| protected boolean acquireLock ( $name, $timeout = 0 ) | ||
| $name | string | Of the lock to be acquired. |
| $timeout | integer | Time (in seconds) to wait for lock to become released. |
| return | boolean | Acquiring result. |
|---|---|---|
Generate path for lock file.
| protected string getLockFilePath ( $name ) | ||
| $name | string | |
Initializes mutex component implementation dedicated for UNIX, GNU/Linux, Mac OS X, and other UNIX-like operating systems.
| public void init ( ) | ||
| throws | yii\base\InvalidConfigException | |
|---|---|---|
Releases lock by given name.
| protected boolean releaseLock ( $name ) | ||
| $name | string | Of the lock to be released. |
| return | boolean | Release result. |
|---|---|---|