|Inheritance||yii\redis\Mutex » yii\mutex\Mutex|
|Available since version||2.0.6|
Redis Mutex implements a mutex component using redis as the storage medium.
Redis Mutex requires redis version 2.6.12 or higher to work properly.
It needs to be configured with a redis yii\redis\Connection that is also configured as an application component.
By default it will use the
redis application component.
To use redis Mutex as the application component, configure the application as follows:
[ 'components' => [ 'mutex' => [ 'class' => 'yii\redis\Mutex', 'redis' => [ 'hostname' => 'localhost', 'port' => 6379, 'database' => 0, ] ], ], ]
Or if you have configured the redis yii\redis\Connection as an application component, the following is sufficient:
[ 'components' => [ 'mutex' => [ 'class' => 'yii\redis\Mutex', // 'redis' => 'redis' // id of the connection application component ], ], ]
|$expire||integer||The number of seconds in which the lock will be auto released.||yii\redis\Mutex|
|$keyPrefix||string||A string prefixed to every cache key so that it is unique.||yii\redis\Mutex|
|$redis||yii\redis\Connection|string|array||The Redis yii\redis\Connection object or the application component ID of the Redis yii\redis\Connection.||yii\redis\Mutex|
|init()||Initializes the redis Mutex component.||yii\redis\Mutex|
|acquireLock()||Acquires a lock by name.||yii\redis\Mutex|
|calculateKey()||Generates a unique key used for storing the mutex in Redis.||yii\redis\Mutex|
|releaseLock()||Releases acquired lock. This method will return
The number of seconds in which the lock will be auto released.
A string prefixed to every cache key so that it is unique. If not set, it will use a prefix generated from. You may set this property to be an empty string if you don't want to use key prefix. It is recommended that you explicitly set this property to some static value if the cached data needs to be shared among multiple applications.
The Redis yii\redis\Connection object or the application component ID of the Redis yii\redis\Connection. This can also be an array that is used to create a redis yii\redis\Connection instance in case you do not want do configure redis connection as an application component. After the Mutex object is created, if you want to change this property, you should only assign it with a Redis yii\redis\Connection object.
Acquires a lock by name.
|protected boolean acquireLock ( $name, $timeout = 0 )|
Of the lock to be acquired. Must be unique.
Time (in seconds) to wait for lock to be released. Defaults to
Lock acquiring result.
Generates a unique key used for storing the mutex in Redis.
|protected string calculateKey ( $name )|
A safe cache key associated with the mutex name.
Initializes the redis Mutex component.
This method will initialize the $redis property to make sure it refers to a valid redis connection.
|public void init ( )|
if $redis is invalid.
Releases acquired lock. This method will return
false in case the lock was not found or Redis command failed.
|protected boolean releaseLock ( $name )|
Of the lock to be released. This lock must already exist.
Lock release result: