Spec-Zone.ru › Laravel 8

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)

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

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

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

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

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

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

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

из Замок
$this betweenBlockedAttemptsSleepFor(int $milliseconds)

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

из Замок
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.

Return Value

int

void __construct(Хранилище $store, string $name, int $seconds, string|null $owner = null)

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

Parameters

Хранилище $store
string $name
int $seconds
string|null $owner

Return Value

void

bool acquire()

Попытка получить замок.

Return Value

bool

bool release()

Освобождение замка.

Return Value

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

protected bool isOwnedByCurrentProcess()

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

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

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/8.x/Illuminate/Cache/CacheLock.html

Spec-Zone.ru

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