Spec-Zone.ru › Laravel 9

FileLock

class FileLock extends CacheLock (View source)

Трейты

InteractsWithTime

Свойства

protected string $name

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

из Lock
protected int $seconds

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

из Lock
protected string $owner

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

из Lock
protected int $sleepMilliseconds

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

из Lock
protected Store $store

Реализация хранилища кэша.

из CacheLock

Методы

int secondsUntil(DateTimeInterface|DateInterval|int $delay)

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

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

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

из InteractsWithTime
DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)

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

из InteractsWithTime
int currentTime()

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

из InteractsWithTime
void __construct(Store $store, string $name, int $seconds, string|null $owner = null)

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

из CacheLock
bool acquire()

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

bool release()

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

из CacheLock
string getCurrentOwner()

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

из CacheLock
mixed get(callable|null $callback = null)

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

из Lock
mixed block(int $seconds, callable|null $callback = null)

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

из Lock
string owner()

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

из Lock
bool isOwnedByCurrentProcess()

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

из Lock
$this betweenBlockedAttemptsSleepFor(int $milliseconds)

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

из Lock
void forceRelease()

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

из CacheLock

Подробности

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

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

Параметры

Store $store
string $name
int $seconds
string|null $owner

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

void
END_OF_DOCUMENT_MARKER

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

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/9.x/Illuminate/Cache/FileLock.html

Spec-Zone.ru

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