Spec-Zone.ru › Laravel 8

ThrottlesExceptions

class ThrottlesExceptions (View source)

Свойства

protected string $key

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

protected bool $byJob

Указывает, должен ли ключ ограничения использовать UUID задачи.

protected int $maxAttempts

Максимальное количество попыток, разрешенных до применения ограничения скорости.

protected int $decayMinutes

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

protected int $retryAfterMinutes

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

protected callable $whenCallback

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

protected string $prefix

Префикс ключа лимитера.

protected RateLimiter $limiter

Экземпляр лимитера.

Методы

void __construct(int $maxAttempts = 10, int $decayMinutes = 10)

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

mixed handle(mixed $job, callable $next)

Обработать задачу.

$this when(callable $callback)

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

$this withPrefix(string $prefix)

Установить префикс ключа лимитера.

$this backoff(int $backoff)

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

string getKey(mixed $job)

Получить ключ кэша, связанный с лимитером.

$this by(string $key)

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

$this byJob()

Указать, что ключ ограничения должен использовать UUID задачи.

int getTimeUntilNextRetry(string $key)

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

Подробности

void __construct(int $maxAttempts = 10, int $decayMinutes = 10)

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

Параметры

int $maxAttempts
int $decayMinutes

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

void

mixed handle(mixed $job, callable $next)

Обработать задачу.

Параметры

mixed $job
callable $next

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

mixed

$this when(callable $callback)

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

Параметры

callable $callback

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

$this

$this withPrefix(string $prefix)

Установить префикс ключа лимитера.

Параметры

string $prefix

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

$this

$this backoff(int $backoff)

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

Параметры

int $backoff

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

$this

protected string getKey(mixed $job)

Получить ключ кэша, связанный с лимитером.

Параметры

mixed $job

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

string

$this by(string $key)

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

Параметры

string $key

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

$this

$this byJob()

Указать, что ключ ограничения должен использовать UUID задачи.

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

$this

protected int getTimeUntilNextRetry(string $key)

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

Параметры

string $key

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

int

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/8.x/Illuminate/Queue/Middleware/ThrottlesExceptions.html

Spec-Zone.ru

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