Spec-Zone.ru › Laravel 10

DurationLimiterBuilder

class DurationLimiterBuilder (View source)

Свойства

InteractsWithTime

Свойства

Connection $connection

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

string $name

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

int $maxLocks

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

int $decay

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

int $timeout

Время блокировки до получения блокировки.

int $sleep

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

Методы

int secondsUntil(DateTimeInterface|DateInterval|int $delay)

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

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

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

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

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

из InteractsWithTime
int currentTime()

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

из 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)

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

Подробное описание

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

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

Параметры

DateTimeInterface|DateInterval|int $delay

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

int

protected int availableAt(DateTimeInterface|DateInterval|int $delay = 0)

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

Параметры

DateTimeInterface|DateInterval|int $delay

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

int

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

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

Параметры

DateTimeInterface|DateInterval|int $delay

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

DateTimeInterface|int

protected int currentTime()

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

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

int

void __construct(Connection $connection, string $name)

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

Параметры

Connection $connection
string $name

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

void

$this allow(int $maxLocks)

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

Параметры

int $maxLocks

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

$this

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

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

Параметры

DateTimeInterface|DateInterval|int $decay

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

$this

$this block(int $timeout)

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

Параметры

int $timeout

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

$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/10.x/Illuminate/Redis/Limiters/DurationLimiterBuilder.html

Spec-Zone.ru

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