Spec-Zone.ru › Laravel 8

PhpRedisLock

class PhpRedisLock extends RedisLock (View source)

Свойства

protected string $name

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

из Lock
protected int $seconds

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

из Lock
protected string $owner

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

из Lock
protected int $sleepMilliseconds

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

из Lock
protected Connection $redis

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

из RedisLock

Свойства (Summary)

InteractsWithTime

Методы

int secondsUntil(DateTimeInterface|DateInterval|int $delay)

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

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

Получить метку времени Unix "доступно в" (available at).

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

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

from InteractsWithTime
int currentTime()

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

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

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

bool acquire()

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

from RedisLock
bool release()

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

string getCurrentOwner()

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

from RedisLock
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
$this betweenBlockedAttemptsSleepFor(int $milliseconds)

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

from Lock
void forceRelease()

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

from RedisLock
string getConnectionName()

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

from RedisLock

Подробности

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

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

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.

Return Value

int

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

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

Parameters

Connection $redis
string $name
int $seconds
string|null $owner

Return Value

void

bool acquire()

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

Return Value

bool

bool release()

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

Return Value

bool

protected string getCurrentOwner()

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

Return Value

string

mixed get(callable|null $callback = null)

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

Parameters

callable|null $callback

Return Value

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

Spec-Zone.ru

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