Spec-Zone.ru › Laravel 8

DynamoDbLock

class DynamoDbLock extends Блокировка (Просмотреть исходный код)

Свойства

Взаимодействие со временем

Свойства

protected string $name

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

из Блокировки
protected int $seconds

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

из Блокировки
protected string $owner

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

из Блокировки
protected int $sleepMilliseconds

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

из Блокировки
protected DynamoDbStore $dynamo

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

Методы

int secondsUntil(DateTimeInterface|DateInterval|int $delay)

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

из Взаимодействия со временем
int availableAt(DateTimeInterface|DateInterval|int $delay = 0)

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

из Взаимодействия со временем
DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)

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

из Взаимодействия со временем
int currentTime()

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

из Взаимодействия со временем
void __construct(DynamoDbStore $dynamo, string $name, int $seconds, string|null $owner = null)

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

bool acquire()

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

bool release()

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

string getCurrentOwner()

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

mixed get(callable|null $callback = null)

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

из Блокировки
mixed block(int $seconds, callable|null $callback = null)

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

из Блокировки
string owner()

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

из Блокировки
bool isOwnedByCurrentProcess()

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

из Блокировки
$this betweenBlockedAttemptsSleepFor(int $milliseconds)

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

из Блокировки
void forceRelease()

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

Подробности

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.

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

int

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

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

Параметры

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

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

void

bool acquire()

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

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

bool

bool release()

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

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

bool
END_OF_DOCUMENT_MARKER

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

protected 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/8.x/Illuminate/Cache/DynamoDbLock.html

Spec-Zone.ru

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