Spec-Zone.ru › Laravel 11

CacheLock

class CacheLock 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)

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

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

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

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

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

из Взаимодействие со временем
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)

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

из Блокировки
void forceRelease()

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

Подробности

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

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

Параметры

DateTimeInterface|DateInterval|int $delay

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

int

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

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

Параметры

DateTimeInterface|DateInterval|int $delay

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

int

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

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

Параметры

DateTimeInterface|DateInterval|int $delay

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

DateTimeInterface|int

protected int currentTime()

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

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

int

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

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

Параметры

float $startTime
float $endTime

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

string

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

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

Параметры

Store $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

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/CacheLock.html

Spec-Zone.ru

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