Spec-Zone.ru › Laravel 11

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 $decaySeconds

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

from ThrottlesExceptions
protected int $retryAfterMinutes

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

from ThrottlesExceptions
protected callable $reportCallback

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

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 $decaySeconds = 600)

Создать новый экземпляр 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
$this report(callable|null $callback = null)

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

from ThrottlesExceptions
int getTimeUntilNextRetry(string $key)

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

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

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

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

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

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

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

from InteractsWithTime
int currentTime()

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

из InteractsWithTime
string runTimeForHumans(float $startTime, float $endTime = null)

Учитывая начальное время, отформатировать общее время выполнения для удобочитаемости.

из InteractsWithTime

Подробности

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

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

Параметры

int $maxAttempts
int $decaySeconds

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

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

$this report(callable|null $callback = null)

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

Параметры

callable|null $callback

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

$this

protected int getTimeUntilNextRetry(string $key)

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

Параметры

string $key

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

int

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

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

Параметры

DateTimeInterface|DateInterval|int $delay

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

int

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

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

Параметры

DateTimeInterface|DateInterval|int $delay

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

int

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

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

Параметры

DateTimeInterface|DateInterval|int $delay

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

DateTimeInterface|int

protected int currentTime()

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

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

int

protected string runTimeForHumans(float $startTime, float $endTime = null)

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

Параметры

float $startTime
float $endTime

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

string

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

Spec-Zone.ru

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