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)

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

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)

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

Параметры

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