MysqlMutex

Type

Class

Namespace

craft\mutex

Inherits

craft\mutex\MysqlMutex » yii\mutex\MysqlMutex (opens new window) » yii\mutex\DbMutex (opens new window) » yii\mutex\Mutex (opens new window) » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)

Implements

yii\base\Configurable (opens new window)

Uses traits

craft\mutex\MutexTrait

Since

3.6.0

Deprecated in

in 3.7.30. Use [[Mutex]] instead, with [[Mutex::$mutex|$mutex]] set to a reliable multi-server mutex driver, such as yii\redis\Mutex (provided by yii2-redis (opens new window)).

View source (opens new window)

Public Properties

Property	Description
autoRelease (opens new window)	boolean (opens new window) – Whether all locks acquired in this process (i.e. local locks) must be released automatically before finishing script execution.
behaviors (opens new window)	yii\base\Behavior (opens new window) – List of behaviors attached to this component.
db (opens new window)	yii\db\Connection (opens new window), array (opens new window), string (opens new window) – The DB connection object or the application component ID of the DB connection.
keyPrefix (opens new window)	yii\db\Expression (opens new window), string (opens new window), null (opens new window) – Prefix value.
namePrefix	string (opens new window) – A string prefixed to every lock name.

Public Methods

Method	Description
__call() (opens new window)	Calls the named method which is not a class method.
__clone() (opens new window)	This method is called after the object is created by cloning an existing one.
__construct() (opens new window)	Constructor.
__get() (opens new window)	Returns the value of a component property.
__isset() (opens new window)	Checks if a property is set, i.e. defined and not null.
__set() (opens new window)	Sets the value of a component property.
__unset() (opens new window)	Sets a component property to be null.
acquire()
attachBehavior() (opens new window)	Attaches a behavior to this component.
attachBehaviors() (opens new window)	Attaches a list of behaviors to the component.
behaviors() (opens new window)	Returns a list of behaviors that this component should behave as.
canGetProperty() (opens new window)	Returns a value indicating whether a property can be read.
canSetProperty() (opens new window)	Returns a value indicating whether a property can be set.
className() (opens new window)	Returns the fully qualified name of this class.
detachBehavior() (opens new window)	Detaches a behavior from the component.
detachBehaviors() (opens new window)	Detaches all behaviors from the component.
ensureBehaviors() (opens new window)	Makes sure that the behaviors declared in behaviors() (opens new window) are attached to this component.
getBehavior() (opens new window)	Returns the named behavior object.
getBehaviors() (opens new window)	Returns all behaviors attached to this component.
hasEventHandlers() (opens new window)	Returns a value indicating whether there is any handler attached to the named event.
hasMethod() (opens new window)	Returns a value indicating whether a method is defined.
hasProperty() (opens new window)	Returns a value indicating whether a property is defined for this component.
init()	Initializes the component.
isAcquired()
off() (opens new window)	Detaches an existing event handler from this component.
on() (opens new window)	Attaches an event handler to an event.
release()
releaseQueuedLocks()	Releases any locks that are waiting on the DB transaction to complete.
trigger() (opens new window)	Triggers an event.

Protected Methods

Method	Description
acquireLock() (opens new window)	Acquires lock by given name.
hashLockName() (opens new window)	Generate hash for lock name to avoid exceeding lock name length limit.
prepareName() (opens new window)	Prepare lock name
releaseLock() (opens new window)	Releases lock by given name.