Spec-Zone.ru › Laravel 6

RedisLock

class RedisLock extends Lock (View source)

Свойства

InteractsWithTime

Свойства

protected string $name

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

из Lock
protected int $seconds

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

из Lock
protected string $owner

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

из Lock
protected Connection $redis

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

Методы

int secondsUntil(DateTimeInterface|DateInterval|int $delay)

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

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

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

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

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

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

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

из Lock
string owner()

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

из Lock
bool isOwnedByCurrentProcess()

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

из Lock
void forceRelease()

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

Подробности

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

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

Параметры

DateTimeInterface|DateInterval|int $delay

Значение возврата

int

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

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

Параметры

DateTimeInterface|DateInterval|int $delay

Значение возврата

int

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

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

Параметры

DateTimeInterface|DateInterval|int $delay

Значение возврата

DateTimeInterface|int

protected int currentTime()

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

Значение возврата

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
END_OF_DOCUMENT_MARKER

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

void forceRelease()

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

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

void

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

Spec-Zone.ru

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