PhpRedisLock

class PhpRedisLock extends RedisLock (View source)

Особенности

Свойства

protected string	$name	Имя блокировки.	от Блокировки
protected int	$seconds	Количество секунд, в течение которых должна сохраняться блокировка.	от Блокировки
protected string	$owner	Идентификатор области действия этой блокировки.	от Блокировки
protected int	$sleepMilliseconds	Количество миллисекунд ожидания перед повторной попыткой получения блокировки в режиме блокировки.	от Блокировки
protected Connection	$redis	Реализация фабрики Redis.	от RedisLock

Методы

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

string

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

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

из InteractsWithTime

void

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

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

bool

acquire()

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

из RedisLock

bool

release()

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

string

getCurrentOwner()

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

из RedisLock

mixed

get(callable|null $callback = null)

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

из Lock

mixed

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

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

из Lock

string

owner()

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

из Lock

bool

isOwnedByCurrentProcess()

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

из Lock

bool

isOwnedBy(string|null $owner)

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

из Lock

$this

betweenBlockedAttemptsSleepFor(int $milliseconds)

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

из Lock

void

forceRelease()

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

из RedisLock

string

getConnectionName()

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

из RedisLock

Подробности

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

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)

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

Параметры

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/PhpRedisLock.html