Spec-Zone.ru › Laravel 11

ConcurrencyLimiterBuilder

class ConcurrencyLimiterBuilder (View source)

Трейты

InteractsWithTime

Свойства

Connection $connection

Подключение к Redis.

string $name

Имя блокировки.

int $maxLocks

Максимальное количество сущностей, которые могут удерживать блокировку одновременно.

int $releaseAfter

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

int $timeout

Время блокировки до тех пор, пока блокировка не станет доступной.

int $sleep

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

Методы

int secondsUntil(DateTimeInterface|DateInterval|int $delay)

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

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

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

из InteractsWithTime
DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)

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

из InteractsWithTime
int currentTime()

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

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

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

из InteractsWithTime
void __construct(Connection $connection, string $name)

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

$this limit(int $maxLocks)

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

$this releaseAfter(int $releaseAfter)

Установить количество секунд до освобождения блокировки.

$this block(int $timeout)

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

$this sleep(int $sleep)

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

mixed then(callable $callback, callable|null $failure = null)

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

Подробности

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

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

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

int

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

Получить временную метку "доступно в" (UNIX timestamp).

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

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

Вывести общее время выполнения в читаемом для человека формате.

Parameters

float $startTime
float $endTime

Return Value

string

void __construct(Connection $connection, string $name)

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

Parameters

Connection $connection
string $name

Return Value

void

$this limit(int $maxLocks)

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

Parameters

int $maxLocks

Return Value

$this

$this releaseAfter(int $releaseAfter)

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

Parameters

int $releaseAfter

Return Value

$this

$this block(int $timeout)

Установите количество времени блокировки до получения блокировки.

Параметры

int $timeout

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

$this

$this sleep(int $sleep)

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

Параметры

int $sleep

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

$this

mixed then(callable $callback, callable|null $failure = null)

Выполните указанный обратный вызов, если блокировка получена, в противном случае вызовите обратный вызов ошибки.

Параметры

callable $callback
callable|null $failure

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

mixed

Исключения

LimiterTimeoutException

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

Spec-Zone.ru

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