Spec-Zone.ru › Laravel 8

ConcurrencyLimiterBuilder

class ConcurrencyLimiterBuilder (View source)

Трейты

InteractsWithTime

Свойства

Connection $connection

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

string $name

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

int $maxLocks

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

int $releaseAfter

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

int $timeout

Время ожидания получения блокировки.

Методы

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
void __construct(Connection $connection, string $name)

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

$this limit(int $maxLocks)

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

$this releaseAfter(int $releaseAfter)

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

$this block(int $timeout)

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

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

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

Подробное описание

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 timestamp.

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

int

void __construct(Connection $connection, string $name)

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

Параметры

Connection $connection
string $name

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

void

$this limit(int $maxLocks)

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

Параметры

int $maxLocks

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

$this

$this releaseAfter(int $releaseAfter)

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

Параметры

int $releaseAfter

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

$this

$this block(int $timeout)

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

Параметры

int $timeout

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

$this

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

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

Параметры

callable $callback
callable $failure

Значение возврата

mixed

Исключения

LimiterTimeoutException

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

Spec-Zone.ru

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