ThrottlesExceptions

class ThrottlesExceptions (View source)

Свойства

protected string	$key	Указанный разработчиком ключ, который должен использовать ограничитель скорости.
protected bool	$byJob	Указывает, должен ли ключ ограничения использовать UUID задачи.
protected int	$maxAttempts	Максимальное количество попыток, разрешенных до применения ограничения скорости.
protected int	$decaySeconds	Количество секунд, в течение которых максимальное количество попыток сбрасывается.
protected int	$retryAfterMinutes	Количество минут ожидания перед повторной попыткой выполнения задачи после возникновения исключения.
protected callable	$reportCallback	Обратный вызов, определяющий, должно ли исключение быть сообщено.
protected callable	$whenCallback	Обратный вызов, определяющий, должно ли применяться ограничение скорости.
protected string	$prefix	Префикс ключа ограничителя скорости.
protected RateLimiter	$limiter	Экземпляр ограничителя скорости.

Методы

void

__construct(int $maxAttempts = 10, int $decaySeconds = 600)

Создать новый экземпляр 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 задачи.

$this

report(callable|null $callback = null)

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

int

getTimeUntilNextRetry(string $key)

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

Детали

void __construct(int $maxAttempts = 10, int $decaySeconds = 600)

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

Parameters

int	$maxAttempts
int	$decaySeconds

Return Value

void

mixed handle(mixed $job, callable $next)

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

Parameters

mixed	$job
callable	$next

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

Параметры

callable|null

$callback

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

$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/11.x/Illuminate/Queue/Middleware/ThrottlesExceptions.html