Spec-Zone.ru › Laravel 11

Блокировка

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

Трейты

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

Свойства

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

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

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

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

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

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

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

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

Методы

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

Получить количество секунд до указанного DateTime.

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

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

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

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

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

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

из Взаимодействие со временем
строка runTimeForHumans(вещественное число $startTime, вещественное число $endTime = null)

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

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

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

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

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

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

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

строка getCurrentOwner()

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

смешанное get(обратный вызов|null $callback = null)

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

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

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

строка owner()

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

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

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

логическое значение isOwnedBy(строка|null $owner)

Определяет, принадлежит ли эта блокировка заданному идентификатору.

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

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

Подробности

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

Получить количество секунд до указанного DateTime.

Параметры

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

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

целое число

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

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

Параметры

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

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

целое число

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

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

Параметры

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

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

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

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

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

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

целое число

защищённое строка runTimeForHumans(вещественное число $startTime, вещественное число $endTime = null)

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

Параметры

вещественное число $startTime
вещественное число $endTime

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

строка

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

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

Параметры

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

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

void

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

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

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

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

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

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

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

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

abstract protected string getCurrentOwner()

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

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

string

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

bool isOwnedBy(string|null $owner)

Определяет, принадлежит ли эта блокировка заданному идентификатору.

Параметры

string|null $owner

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

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

Spec-Zone.ru

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