Spec-Zone.ru › Laravel 10

ThrottlesExceptionsWithRedis

class ThrottlesExceptionsWithRedis extends ThrottlesExceptions (View source)

Свойства

InteractsWithTime

Свойства

protected string $key

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

from ThrottlesExceptions
protected bool $byJob

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

from ThrottlesExceptions
protected int $maxAttempts

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

from ThrottlesExceptions
protected int $decayMinutes

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

from ThrottlesExceptions
protected int $retryAfterMinutes

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

from ThrottlesExceptions
protected callable $whenCallback

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

from ThrottlesExceptions
protected string $prefix

Префикс ключа ограничителя скорости.

from ThrottlesExceptions
protected DurationLimiter $limiter

Экземпляр ограничителя скорости.

protected Factory $redis

Реализация фабрики Redis.

Методы

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

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

from ThrottlesExceptions
mixed handle(mixed $job, callable $next)

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

$this when(callable $callback)

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

from ThrottlesExceptions
$this withPrefix(string $prefix)

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

from ThrottlesExceptions
$this backoff(int $backoff)

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

from ThrottlesExceptions
string getKey(mixed $job)

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

from ThrottlesExceptions
$this by(string $key)

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

from ThrottlesExceptions
$this byJob()

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

from ThrottlesExceptions
int getTimeUntilNextRetry(string $key)

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

from ThrottlesExceptions
int secondsUntil(DateTimeInterface|DateInterval|int $delay)

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

from InteractsWithTime
int availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Получить отметку времени «доступно в» в формате Unix timestamp.

from InteractsWithTime
DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)

Если заданное значение представляет собой интервал, преобразовать его в экземпляр DateTime.

from InteractsWithTime
int currentTime()

Получить текущее системное время в формате Unix timestamp.

from InteractsWithTime

Подробности

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

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

Parameters

int $maxAttempts
int $decayMinutes

Return Value

void

mixed handle(mixed $job, callable $next)

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

Parameters

mixed $job
callable $next

Return Value

mixed

$this when(callable $callback)

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

Parameters

callable $callback

Return Value

$this

$this withPrefix(string $prefix)

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

Parameters

string $prefix

Return Value

$this

$this backoff(int $backoff)

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

Parameters

int $backoff

Return Value

$this

protected string getKey(mixed $job)

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

Parameters

mixed $job

Return Value

string

$this by(string $key)

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

Parameters

string $key

Return Value

$this

$this byJob()

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

Return Value

$this

protected int getTimeUntilNextRetry(string $key)

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

Parameters

string $key

Return Value

int

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

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

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

int

protected int availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Получить отметку времени «доступно в» в формате UNIX.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

int

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

Если заданное значение является интервалом, преобразовать его в экземпляр DateTime.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

DateTimeInterface|int

protected int currentTime()

Получить текущее системное время в формате UNIX timestamp.

Return Value

int

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

Spec-Zone.ru

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