Spec-Zone.ru › Laravel 11

ArrayLock

class ArrayLock extends Блокировка (Просмотр исходного кода)

Трейты

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

Свойства

protected string $name

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

из Блокировки
protected int $seconds

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

из Блокировки
protected string $owner

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

из Блокировки
protected int $sleepMilliseconds

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

из Блокировки
protected Массив хранилищ $store

Родительское хранилище кэша массивов.

Методы

int secondsUntil(DateTimeInterface|DateInterval|int $delay)

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

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

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

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

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

из Взаимодействия со временем
int currentTime()

Получение текущего времени системы в формате UNIX timestamp.

из Взаимодействия со временем
string runTimeForHumans(float $startTime, float $endTime = null)

Форматирование общего времени выполнения для отображения пользователю.

из Взаимодействия со временем
void __construct(Массив хранилищ $store, string $name, int $seconds, string|null $owner = null)

Создание нового экземпляра блокировки.

bool acquire()

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

bool release()

Освобождение блокировки.

string getCurrentOwner()

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

mixed get(callable|null $callback = null)

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

из Блокировки
mixed block(int $seconds, callable|null $callback = null)

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

из Блокировки
string owner()

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

из Блокировки
bool isOwnedByCurrentProcess()

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

из Блокировки
bool isOwnedBy(string|null $owner)

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

из Блокировки
$this betweenBlockedAttemptsSleepFor(int $milliseconds)

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

из Блокировки
bool exists()

Определение существования текущей блокировки.

void forceRelease()

Освобождает эту блокировку, игнорируя владение.

Подробности

protected int secondsUntil(DateTimeInterface|DateInterval|int $delay)

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

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

int

protected int availableAt(DateTimeInterface|DateInterval|int $delay = 0)

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

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

int

protected DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)

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

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

DateTimeInterface|int

protected int currentTime()

Получение текущего времени системы в формате UNIX timestamp.

Return Value

int

protected string runTimeForHumans(float $startTime, float $endTime = null)

Форматирование общего времени выполнения для отображения пользователю.

Parameters

float $startTime
float $endTime

Return Value

string
END_OF_DOCUMENT_MARKER

void __construct(ArrayStore $store, string $name, int $seconds, string|null $owner = null)

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

Параметры

ArrayStore $store
string $name
int $seconds
string|null $owner

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

void

bool acquire()

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

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

bool

bool release()

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

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

bool

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

protected bool exists()

Определить, существует ли текущая блокировка.

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

bool

void forceRelease()

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

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

void

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

Spec-Zone.ru

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