Spec-Zone.ru › Laravel 9

Блокировка

абстрактный класс Блокировка реализует Блокировка (Просмотреть исходный код)

Трейты

Взаимодействие со временем

Свойства

защищенная строка $name

Имя блокировки.

защищенное целое число $seconds

Количество секунд, в течение которых должна поддерживаться блокировка.

защищенная строка $owner

Идентификатор области действия этой блокировки.

защищенное целое число $sleepMilliseconds

Количество миллисекунд ожидания перед повторной попыткой получения блокировки в режиме блокировки.

Методы

целое число secondsUntil(DateTimeInterface|DateInterval|целое число $delay)

Получить количество секунд до заданной даты и времени.

из Взаимодействие со временем
целое число availableAt(DateTimeInterface|DateInterval|целое число $delay = 0)

Получить отметку времени «доступно в» в формате Unix.

из Взаимодействие со временем
DateTimeInterface|целое число parseDateInterval(DateTimeInterface|DateInterval|целое число $delay)

Если заданное значение является интервалом, преобразовать его в объект DateTime.

из Взаимодействие со временем
целое число currentTime()

Получить текущее системное время в формате Unix.

из Взаимодействие со временем
void __construct(строка $name, целое число $seconds, строка|null $owner = null)

Создать новый экземпляр блокировки.

логическое значение acquire()

Попытка получить блокировку.

логическое значение release()

Освободить блокировку.

строка getCurrentOwner()

Возвращает значение владельца, записанное в драйвер для данной блокировки.

смешанный тип get(вызов функции|null $callback = null)

Попытка получить блокировку.

смешанный тип block(целое число $seconds, вызов функции|null $callback = null)

Попытка получить блокировку на заданное количество секунд.

строка owner()

Возвращает текущего владельца блокировки.

логическое значение isOwnedByCurrentProcess()

Определяет, разрешена ли в драйвере разблокировка этой блокировки текущим процессом.

$this betweenBlockedAttemptsSleepFor(целое число $milliseconds)

Указывает количество миллисекунд ожидания между попытками получения заблокированной блокировки.

Подробное описание

защищенное целое число secondsUntil(DateTimeInterface|DateInterval|целое число $delay)

Получить количество секунд до заданной даты и времени.

Параметры

DateTimeInterface|DateInterval|целое число $delay

Возвращаемое значение

целое число

защищенное целое число availableAt(DateTimeInterface|DateInterval|целое число $delay = 0)

Получить отметку времени «доступно в» в формате Unix.

Параметры

DateTimeInterface|DateInterval|целое число $delay

Возвращаемое значение

целое число

защищенное DateTimeInterface|целое число parseDateInterval(DateTimeInterface|DateInterval|целое число $delay)

Если заданное значение является интервалом, преобразовать его в объект DateTime.

Параметры

DateTimeInterface|DateInterval|целое число $delay

Возвращаемое значение

DateTimeInterface|целое число

защищенное целое число currentTime()

Получить текущее системное время в формате Unix.

Возвращаемое значение

целое число

void __construct(строка $name, целое число $seconds, строка|null $owner = null)

Создать новый экземпляр блокировки.

Параметры

строка $name
целое число $seconds
строка|null $owner

Возвращаемое значение

void

абстрактный логическое значение acquire()

Попытка получить блокировку.

Возвращаемое значение

логическое значение

абстрактный логическое значение release()

Освободить блокировку.

Возвращаемое значение

логическое значение

абстрактный защищенное строка getCurrentOwner()

Возвращает значение владельца, записанное в драйвер для данной блокировки.

Возвращаемое значение

строка

смешанный тип get(вызов функции|null $callback = null)

Попытка получить блокировку.

Параметры

вызов функции|null $callback

Возвращаемое значение

смешанный тип

mixed block(int $seconds, callable|null $callback = null)

Попытка получить блокировку на заданное количество секунд.

Параметры

int $seconds
callable|null $callback

Возвращаемое значение

mixed

Исключения

LockTimeoutException

string owner()

Возвращает текущего владельца блокировки.

Возвращаемое значение

string

protected bool isOwnedByCurrentProcess()

Определяет, разрешено ли этому замку освободить блокировку в драйвере.

Возвращаемое значение

bool

$this betweenBlockedAttemptsSleepFor(int $milliseconds)

Укажите количество миллисекунд, которое нужно подождать между неудачными попытками получения блокировки.

Параметры

int $milliseconds

Возвращаемое значение

$this

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/9.x/Illuminate/Cache/Lock.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API