Spec-Zone.ru › Laravel 11

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 timestamp.

из Взаимодействия со временем
string runTimeForHumans(float $startTime, float $endTime = null)

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

из Взаимодействия со временем
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()

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

из Блокировки
bool isOwnedBy(string|null $owner)

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

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

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

из Блокировки
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 timestamp.

Return Value

int

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

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

Parameters

float $startTime
float $endTime

Return Value

string
END_OF_DOCUMENT_MARKER

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

bool isOwnedBy(string|null $owner)

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

Параметры

string|null $owner

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

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/11.x/Illuminate/Cache/MemcachedLock.html

Spec-Zone.ru

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