Skip to content

MutexTrait ​

Type
Trait
Namespace
craft\mutex
Implemented by
craft\mutex\Mutex
Since
3.7.30

View source

Public Properties ​

PropertyDescription
namePrefixstring – A string prefixed to every lock name.

namePrefix ​

Type
string
Default value
''

A string prefixed to every lock name. This can be used to avoid lock conflicts if multiple applications are sharing the same database connection.

View source

Public Methods ​

MethodDescription
acquire()
init()Initializes the component.
isAcquired()
release()
releaseQueuedLocks()Releases any locks that are waiting on the DB transaction to complete.

acquire() ​

View source

Arguments ​

Returns ​

boolean

init() ​

Initializes the component.

View source

isAcquired() ​

View source

Arguments ​

Returns ​

boolean

release() ​

View source

Arguments ​

Returns ​

boolean

releaseQueuedLocks() ​

Releases any locks that are waiting on the DB transaction to complete.

View source