Spec-Zone.ru › Laravel 10

RedisLock

class RedisLock extends Блокировка (Просмотреть исходный код)

Трейты

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

Свойства

protected string $name

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

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

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

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

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

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

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

из Блокировки
protected Подключение $redis

Реализация фабрики Redis.

Методы

int secondsUntil(DateTimeInterface|DateInterval|int $delay)

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

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

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

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

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

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

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

из Взаимодействие со временем
void __construct(Подключение $redis, 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()

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

string getConnectionName()

Получить имя подключения Redis, используемого для управления блокировкой.

Подробности

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

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

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

void __construct(Подключение $redis, string $name, int $seconds, string|null $owner = null)

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

Parameters

Подключение $redis
string $name
int $seconds
string|null $owner

Return Value

void

bool acquire()

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

Return Value

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

$this betweenBlockedAttemptsSleepFor(int $milliseconds)

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

Параметры

int $milliseconds

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

$this

void forceRelease()

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

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

void

string getConnectionName()

Получить имя подключения Redis, используемого для управления блокировкой.

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

string

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

Spec-Zone.ru

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