Spec-Zone.ru › Laravel 10

DynamoDbLock

class DynamoDbLock extends Lock (View source)

Трейты

InteractsWithTime

Свойства

protected string $name

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

from Lock
protected int $seconds

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

from Lock
protected string $owner

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

from Lock
protected int $sleepMilliseconds

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

from Lock
protected DynamoDbStore $dynamo

Экземпляр клиента DynamoDB.

Методы

int secondsUntil(DateTimeInterface|DateInterval|int $delay)

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

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

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

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

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

from InteractsWithTime
int currentTime()

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

from InteractsWithTime
void __construct(DynamoDbStore $dynamo, 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
$this betweenBlockedAttemptsSleepFor(int $milliseconds)

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

from Lock
void forceRelease()

Освободить эту блокировку, не учитывая владение.

Подробности

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.

Return Value

int

void __construct(DynamoDbStore $dynamo, string $name, int $seconds, string|null $owner = null)

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

Parameters

DynamoDbStore $dynamo
string $name
int $seconds
string|null $owner

Return Value

void

bool acquire()

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

Return Value

bool

bool release()

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

Return Value

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

$this betweenBlockedAttemptsSleepFor(int $milliseconds)

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

Параметры

int $milliseconds

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

$this

void forceRelease()

Освободить эту блокировку, не учитывая владения.

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

void

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

Spec-Zone.ru

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