Spec-Zone.ru › Laravel 7

RedisLock

класс RedisLock расширяет 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)

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

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

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

из 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
bool block(int $seconds, callable|null $callback = null)

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

из Lock
string owner()

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

из Lock
bool isOwnedByCurrentProcess()

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

из Lock
$this betweenBlockedAttemptsSleepFor(int $milliseconds)

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

из Lock
void forceRelease()

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

Подробности

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

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

Параметры

DateTimeInterface|DateInterval|int $delay

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

int

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

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

Параметры

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

bool block(int $seconds, callable|null $callback = null)

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

Параметры

int $seconds
callable|null $callback

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

bool

Исключения

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

Spec-Zone.ru

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