Spec-Zone.ru › Laravel 11

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)

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

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

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

from InteractsWithTime
DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)

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

from InteractsWithTime
int currentTime()

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

from InteractsWithTime
string runTimeForHumans(float $startTime, float $endTime = null)

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

from 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)

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

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

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

from Lock
string owner()

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

from Lock
bool isOwnedByCurrentProcess()

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

from Lock
bool isOwnedBy(string|null $owner)

Определить, принадлежит ли данная блокировка заданному идентификатору.

from Lock
$this betweenBlockedAttemptsSleepFor(int $milliseconds)

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

from 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)

Получить метку времени «доступно в» в формате 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 timestamp.

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

int

protected string runTimeForHumans(float $startTime, float $endTime = null)

Вычисляет и форматирует общее время выполнения в удобочитаемом для человека виде.

Параметры

float $startTime
float $endTime

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

string

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

bool isOwnedByCurrentProcess()

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

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

bool

bool isOwnedBy(string|null $owner)

Определяет, принадлежит ли этот замок заданному идентификатору.

Параметры

string|null $owner

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

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

Spec-Zone.ru

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