FileMutex
- Type
- Class
- Namespace
- craft\mutex
- Inherits
- craft\mutex\FileMutex » yii\mutex\FileMutex (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
- yii\mutex\RetryAcquireTrait (opens new window)
- Since
- 3.0.0
- Deprecated in
- in 3.1.14. Use [[\yii\mutex\FileMutex]] instead.
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. |
| dirMode (opens new window) | integer (opens new window) – The permission to be set for newly created directories. |
| fileMode (opens new window) | integer (opens new window), null (opens new window) – The permission to be set for newly created mutex files. |
| isWindows (opens new window) | boolean (opens new window), null (opens new window) – Whether file handling should assume a Windows file system. |
| mutexPath (opens new window) | string (opens new window) – The directory to store mutex files. |
| retryDelay (opens new window) | integer (opens new window) – Number of milliseconds between each try in \yii\mutex\acquire() until specified timeout times out. |
# 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() (opens new window) | Acquires a lock by name. |
| 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() (opens new window) | Initializes mutex component implementation dedicated for UNIX, GNU/Linux, Mac OS X, and other UNIX-like operating systems. |
| isAcquired() (opens new window) | Checks if a lock is acquired by the current process. |
| off() (opens new window) | Detaches an existing event handler from this component. |
| on() (opens new window) | Attaches an event handler to an event. |
| release() (opens new window) | Releases acquired lock. This method will return false in case the lock was not found. |
| trigger() (opens new window) | Triggers an event. |
# Protected Methods
| Method | Description |
|---|---|
| acquireLock() (opens new window) | Acquires lock by given name. |
| getLockFilePath() (opens new window) | Generate path for lock file. |
| releaseLock() (opens new window) | Releases lock by given name. |
← DbMutexTrait Mutex →