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.
mixed handle(mixed $job, callable $next)
Обработать задачу.
$this when(callable $callback)
Указать обратный вызов, который должен определить, должно ли применяться поведение ограничения скорости.
$this withPrefix(string $prefix)
Установить префикс ключа ограничение скорости.
$this backoff(int $backoff)
Указать количество минут, на которое задача должна быть задержана при ее освобождении (перед тем, как она достигнет максимального числа исключений).
protected string getKey(mixed $job)
Получить кэш-ключ, связанный с ограничение скорости.
$this by(string $key)
Установить значение, по которому должен быть ключирован ограничитель скорости.
$this byJob()
Указать, что ключ ограничения должен использовать UUID задачи.
protected int getTimeUntilNextRetry(string $key)
Получить количество секунд, которое должно пройти, прежде чем задача будет повторно выполнена.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/10.x/Illuminate/Queue/Middleware/ThrottlesExceptions.html
