Spec-Zone.ru › Laravel 10

MemcachedLock

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

Трейты

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

Свойства

protected string $name

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

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

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

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

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

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

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

из Блокировки
protected Memcached $memcached

Экземпляр Memcached.

Методы

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(Memcached $memcached, 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(Memcached $memcached, string $name, int $seconds, string|null $owner = null)

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

Параметры

Memcached $memcached
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

$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/MemcachedLock.html

Spec-Zone.ru

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