Skip to content

FileMutex

Type
Class
Namespace
craft\mutex
Inherits
craft\mutex\FileMutex » yii\mutex\FileMutex » yii\mutex\Mutex » yii\base\Component » yii\base\BaseObject
Implements
yii\base\Configurable
Uses traits
yii\mutex\RetryAcquireTrait
Since
3.0.0
Deprecated in
in 3.1.14. Use [[\yii\mutex\FileMutex]] instead.

View source

Public Properties

PropertyDescription
autoReleaseboolean – Whether all locks acquired in this process (i.e. local locks) must be released automatically before finishing script execution.
behaviorsyii\base\Behavior – List of behaviors attached to this component.
dirModeinteger – The permission to be set for newly created directories.
fileModeinteger, null – The permission to be set for newly created mutex files.
isWindowsboolean, null – Whether file handling should assume a Windows file system.
mutexPathstring – The directory to store mutex files.
retryDelayinteger – Number of milliseconds between each try in \yii\mutex\acquire() until specified timeout times out.

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__clone()This method is called after the object is created by cloning an existing one.
__construct()Constructor.
__get()Returns the value of a component property.
__isset()Checks if a property is set, i.e. defined and not null.
__set()Sets the value of a component property.
__unset()Sets a component property to be null.
acquire()Acquires a lock by name.
attachBehavior()Attaches a behavior to this component.
attachBehaviors()Attaches a list of behaviors to the component.
behaviors()Returns a list of behaviors that this component should behave as.
canGetProperty()Returns a value indicating whether a property can be read.
canSetProperty()Returns a value indicating whether a property can be set.
className()Returns the fully qualified name of this class.
detachBehavior()Detaches a behavior from the component.
detachBehaviors()Detaches all behaviors from the component.
ensureBehaviors()Makes sure that the behaviors declared in behaviors() are attached to this component.
getBehavior()Returns the named behavior object.
getBehaviors()Returns all behaviors attached to this component.
hasEventHandlers()Returns a value indicating whether there is any handler attached to the named event.
hasMethod()Returns a value indicating whether a method is defined.
hasProperty()Returns a value indicating whether a property is defined for this component.
init()Initializes mutex component implementation dedicated for UNIX, GNU/Linux, Mac OS X, and other UNIX-like operating systems.
isAcquired()Checks if a lock is acquired by the current process.
off()Detaches an existing event handler from this component.
on()Attaches an event handler to an event.
release()Releases acquired lock. This method will return false in case the lock was not found.
trigger()Triggers an event.

Protected Methods

MethodDescription
acquireLock()Acquires lock by given name.
getLockFilePath()Generate path for lock file.
releaseLock()Releases lock by given name.