Spec-Zone.ru › Laravel 8

RedisLock

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

Трейты

InteractsWithTime

Свойства

protected string $name

Имя замка.

из Замка
protected int $seconds

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

из Замка
protected string $owner

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

из Замка
protected int $sleepMilliseconds

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

из Замка
protected Connection $redis

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

Методы

int secondsUntil(DateTimeInterface|DateInterval|int $delay)

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

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

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

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

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

из InteractsWithTime
int currentTime()

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

из 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)

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

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

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

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(Connection $redis, string $name, int $seconds, string|null $owner = null)

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

Parameters

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

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

Spec-Zone.ru

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