Class yii\mutex\FileMutex

继承yii\mutex\FileMutex » yii\mutex\Mutex » yii\base\Component » yii\base\BaseObject
实现yii\base\Configurable
Uses Traitsyii\mutex\RetryAcquireTrait
可用自版本2.0
源代码 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.

参见 yii\mutex\Mutex.

公共属性

隐藏继承的属性

属性类型描述定义在
$autoRelease boolean Whether all locks acquired in this process (i.e. local locks) must be released automatically before finishing script execution. yii\mutex\Mutex
$behaviors yii\base\Behavior[] 附加到此组件的行为列表. 该属性是只读的. yii\base\Component
$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 acquire() until specified timeout times out. yii\mutex\RetryAcquireTrait

公共方法

隐藏继承的方法

方法描述定义在
__call() 调用不是类方法的指定的方法. yii\base\Component
__clone() 在通过克隆现有对象创建对象之后调用此方法. yii\base\Component
__construct() 构造函数. yii\base\BaseObject
__get() 返回组件属性的值. yii\base\Component
__isset() 检查属性是否已设置, 即已定义且不为null. yii\base\Component
__set() 设置组件属性的值. yii\base\Component
__unset() 将组件属性设置为null. yii\base\Component
acquire() Acquires a lock by name. yii\mutex\Mutex
attachBehavior() 将行为附加到此组件. yii\base\Component
attachBehaviors() 将行为列表附加到组件. yii\base\Component
behaviors() 返回此组件应该具有的行为列表. yii\base\Component
canGetProperty() 返回一个值, 指示属性是否可读取. yii\base\Component
canSetProperty() 返回一个值, 指示属性是否可设置. yii\base\Component
className() 返回此类的完全限定名称. yii\base\BaseObject
detachBehavior() 从组件中分离一个行为. yii\base\Component
detachBehaviors() 分离组件中的所有行为. yii\base\Component
ensureBehaviors() 确保在 behaviors() 中声明的行为已附加到此组件. yii\base\Component
getBehavior() 返回指定的行为对象. yii\base\Component
getBehaviors() 返回附加到此组件的所有行为. yii\base\Component
hasEventHandlers() 返回一个值, 指示是否有任何处理程序附加到指定的事件. yii\base\Component
hasMethod() 返回一个值, 指示方法是否已定义. yii\base\Component
hasProperty() 返回一个值, 指示属性是否已定义. 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() 从该组件分离现有的事件处理程序. yii\base\Component
on() 将事件处理程序附加到事件. yii\base\Component
release() Releases acquired lock. This method will return false in case the lock was not found. yii\mutex\Mutex
trigger() 触发事件. yii\base\Component

受保护的方法

隐藏继承的方法

方法描述定义在
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

属性详情

$dirMode public 属性

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.

public integer $dirMode 0775
$fileMode public 属性

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.

public integer $fileMode null
$isWindows public 属性 (可用自版本: 2.0.16)

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.

public boolean $isWindows null
$mutexPath public 属性

The directory to store mutex files. You may use path alias here. Defaults to the "mutex" subdirectory under the application runtime path.

public string $mutexPath '@runtime/mutex'

方法详情

acquireLock() protected 方法

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.

getLockFilePath() protected 方法 (可用自版本: 2.0.10)

Generate path for lock file.

protected string getLockFilePath ( $name )
$name string
init() public 方法

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
releaseLock() protected 方法

Releases lock by given name.

protected boolean releaseLock ( $name )
$name string

Of the lock to be released.

return boolean

Release result.