Spec-Zone.ru › Laravel 10

Блокировка

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

Трейты

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

Свойства

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

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

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

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

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

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

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

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

Методы

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

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

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

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

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

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

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

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

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

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

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

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

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

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

строка getCurrentOwner()

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

mixed get(callable|null $callback = null)

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

mixed block(целое число $seconds, callable|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 timestamp.

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

целое число

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

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

Параметры

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

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

void

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

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

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

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

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

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

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

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

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

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

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

строка

mixed get(callable|null $callback = null)

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

Параметры

callable|null $callback

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

mixed

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

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

Параметры

int $seconds
callable|null $callback

Значение возврата

mixed

Исключения

LockTimeoutException

string owner()

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

Значение возврата

string

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/10.x/Illuminate/Cache/Lock.html

Spec-Zone.ru

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