Class yii\mutex\MysqlMutex

继承yii\mutex\MysqlMutex » yii\mutex\DbMutex » yii\mutex\Mutex » yii\base\Component » yii\base\BaseObject
实现yii\base\Configurable
可用自版本2.0
源代码 https://github.com/yiisoft/yii2/blob/master/framework/mutex/MysqlMutex.php

MysqlMutex implements mutex "lock" mechanism via MySQL locks.

Application configuration example:

[
    'components' => [
        'db' => [
            'class' => 'yii\db\Connection',
            'dsn' => 'mysql:host=127.0.0.1;dbname=demo',
        ]
        'mutex' => [
            'class' => 'yii\mutex\MysqlMutex',
        ],
    ],
]

参见 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
$db yii\db\Connection|array|string The DB connection object or the application component ID of the DB connection. yii\mutex\DbMutex

公共方法

隐藏继承的方法

方法描述定义在
__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 MySQL specific mutex component implementation. yii\mutex\MysqlMutex
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\MysqlMutex
hashLockName() Generate hash for lock name to avoid exceeding lock name length limit. yii\mutex\MysqlMutex
releaseLock() Releases lock by given name. yii\mutex\MysqlMutex

方法详情

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

hashLockName() protected 方法 (可用自版本: 2.0.16)

Generate hash for lock name to avoid exceeding lock name length limit.

参见 https://github.com/yiisoft/yii2/pull/16836.

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

Initializes MySQL specific mutex component implementation.

public void init ( )
throws yii\base\InvalidConfigException

if $db is not MySQL connection.

releaseLock() protected 方法
protected boolean releaseLock ( $name )
$name string

Of the lock to be released.

return boolean

Release result.