Spec-Zone.ru › Laravel 9

DurationLimiterBuilder

класс DurationLimiterBuilder (View source)

Traits

InteractsWithTime

Properties

Connection $connection

Соединение Redis.

string $name

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

int $maxLocks

Максимальное количество блокировок, которые могут быть получены за временной интервал.

int $decay

Длительность поддержания окна блокировки.

int $timeout

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

int $sleep

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

Methods

int secondsUntil(DateTimeInterface|DateInterval|int $delay)

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

из 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(Connection $connection, string $name)

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

$this allow(int $maxLocks)

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

$this every(DateTimeInterface|DateInterval|int $decay)

Установить длительность поддержания окна блокировки.

$this block(int $timeout)

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

$this sleep(int $sleep)

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

mixed then(callable $callback, callable $failure = null)

Выполнить заданный обратный вызов, если блокировка получена, иначе вызвать обратный вызов ошибки.

Details

protected int secondsUntil(DateTimeInterface|DateInterval|int $delay)

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

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(Connection $connection, string $name)

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

Parameters

Connection $connection
string $name

Return Value

void

$this allow(int $maxLocks)

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

Parameters

int $maxLocks

Return Value

$this

$this every(DateTimeInterface|DateInterval|int $decay)

Установить длительность поддержания окна блокировки.

Parameters

DateTimeInterface|DateInterval|int $decay

Return Value

$this

$this block(int $timeout)

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

Parameters

int $timeout

Return Value

$this

$this sleep(int $sleep)

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

Параметры

int $sleep

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

$this

mixed then(callable $callback, callable $failure = null)

Выполнить заданный обратный вызов, если блокировка получена, иначе вызвать обратный вызов ошибки.

Параметры

callable $callback
callable $failure

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

mixed

Исключения

LimiterTimeoutException

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/9.x/Illuminate/Redis/Limiters/DurationLimiterBuilder.html

Spec-Zone.ru

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