Spec-Zone.ru › Laravel 6

DurationLimiterBuilder

class DurationLimiterBuilder (View source)

Свойства

InteractsWithTime

Свойства

Connection $connection

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

string $name

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

int $maxLocks

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

int $decay

Время, в течение которого сохраняется окно блокировки.

int $timeout

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

Методы

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

из InteractsWithTime
void __construct(Connection $connection, string $name)

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

$this allow(int $maxLocks)

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

$this every(int $decay)

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

$this block(int $timeout)

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

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

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

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

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

Количество секунд до указанного значения DateTime.

Параметры

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

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

int

void __construct(Connection $connection, string $name)

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

Параметры

Connection $connection
string $name

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

void

$this allow(int $maxLocks)

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

Параметры

int $maxLocks

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

$this

$this every(int $decay)

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

Параметры

int $decay

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

$this

$this block(int $timeout)

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

Параметры

int $timeout

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

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

Spec-Zone.ru

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