Spec-Zone.ru › Laravel 9

RedisLock

class RedisLock extends Lock (View source)

Трейты

InteractsWithTime

Свойства

protected string $name

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

из Lock
protected int $seconds

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

из Lock
protected string $owner

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

из Lock
protected int $sleepMilliseconds

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

из Lock
protected Connection $redis

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

Методы

int secondsUntil(DateTimeInterface|DateInterval|int $delay)

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

из InteractsWithTime
int availableAt(DateTimeInterface|DateInterval|int $delay = 0)

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

из InteractsWithTime
DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)

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

из InteractsWithTime
int currentTime()

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

из InteractsWithTime
void __construct(Connection $redis, string $name, int $seconds, string|null $owner = null)

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

bool acquire()

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

bool release()

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

string getCurrentOwner()

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

mixed get(callable|null $callback = null)

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

из Lock
mixed block(int $seconds, callable|null $callback = null)

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

из Lock
string owner()

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

из Lock
bool isOwnedByCurrentProcess()

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

из Lock
$this betweenBlockedAttemptsSleepFor(int $milliseconds)

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

из Lock
void forceRelease()

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

string getConnectionName()

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

Подробное описание

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

void __construct(Connection $redis, string $name, int $seconds, string|null $owner = null)

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

Параметры

Connection $redis
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

protected 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/9.x/Illuminate/Cache/RedisLock.html

Spec-Zone.ru

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