LockInterface
интерфейс LockInterface
LockInterface определяет интерфейс для управления статусом блокировки.
Методы
| bool | acquire(bool $blocking = false) Получает блокировку. Если блокировка уже получена кем-то другим, параметр | |
| refresh() Увеличивает срок действия полученной блокировки. | ||
| bool | isAcquired() Возвращает, получена ли блокировка. | |
| release() Освобождает блокировку. | ||
| bool | isExpired() | |
| float|null | getRemainingLifetime() Возвращает оставшийся срок действия. |
Подробности
bool acquire(bool $blocking = false)
Получает блокировку. Если блокировка уже получена кем-то другим, параметр blocking определяет, будет ли вызов заблокирован до освобождения блокировки.
Параметры
| bool | $blocking | Нужно ли ожидать освобождения блокировки другим пользователем |
Возвращаемое значение
| bool | была ли блокировка получена |
Исключения
| LockConflictedException | Если блокировка получена кем-то другим в режиме ожидания |
| LockAcquiringException | Если блокировка не может быть получена |
refresh()
Увеличивает срок действия полученной блокировки.
Исключения
| LockConflictedException | Если блокировка получена кем-то другим |
| LockAcquiringException | Если блокировка не может быть обновлена |
bool isAcquired()
Возвращает, получена ли блокировка.
Возвращаемое значение
| bool |
release()
Освобождает блокировку.
Исключения
| LockReleasingException | Если блокировка не может быть освобождена |
bool isExpired()
Возвращаемое значение
| bool |
float|null getRemainingLifetime()
Возвращает оставшийся срок действия.
Возвращаемое значение
| float|null | Оставшийся срок действия в секундах. Null, если блокировка не истекает. |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/4.0/Symfony/Component/Lock/LockInterface.html