WithoutOverlapping
класс WithoutOverlapping (View source)
Свойства
| InteractsWithTime |
Свойства
| строка | $key | Уникальный ключ задания, используемый для предотвращения наложений. | |
| DateTimeInterface|число|null | $releaseAfter | Количество секунд до того, как задание должно стать доступным снова, если блокировка не была приобретена. | |
| число | $expiresAfter | Количество секунд, в течение которых блокировка должна действовать. | |
| строка | $prefix | Префикс ключа блокировки. |
Методы
| число | secondsUntil(DateTimeInterface|DateInterval|число $delay) Получить количество секунд до заданной даты и времени. | из InteractsWithTime |
| число | availableAt(DateTimeInterface|DateInterval|число $delay = 0) Получить метку времени «доступно в». | из InteractsWithTime |
| DateTimeInterface|число | parseDateInterval(DateTimeInterface|DateInterval|число $delay) Если заданное значение является интервалом, преобразовать его в экземпляр DateTime. | из InteractsWithTime |
| число | currentTime() Получить текущее системное время в виде метки времени Unix. | из InteractsWithTime |
| void | __construct(строка $key = '', DateTimeInterface|число|null $releaseAfter = 0, DateTimeInterface|число $expiresAfter = 0) Создать новый экземпляр middleware. | |
| смешанный | handle(смешанный $job, вызов $next) Обработать задание. | |
| $this | releaseAfter(DateTimeInterface|число $releaseAfter) Установить задержку (в секундах) для возвращения задания в очередь. | |
| $this | dontRelease() Не возвращать задание в очередь, если блокировка не может быть приобретена. | |
| $this | expireAfter(DateTimeInterface|число $expiresAfter) Установить максимальное количество секунд, которое может пройти, прежде чем блокировка будет освобождена. | |
| $this | withPrefix(строка $prefix) Установить префикс ключа блокировки. | |
| строка | getLockKey(смешанный $job) Получить ключ блокировки для заданного задания. |
Подробности
protected число secondsUntil(DateTimeInterface|DateInterval|число $delay)
Получить количество секунд до заданной даты и времени.
protected число availableAt(DateTimeInterface|DateInterval|число $delay = 0)
Получить метку времени «доступно в».
protected DateTimeInterface|число parseDateInterval(DateTimeInterface|DateInterval|число $delay)
Если заданное значение является интервалом, преобразовать его в экземпляр DateTime.
protected число currentTime()
Получить текущее системное время в виде метки времени Unix.
void __construct(строка $key = '', DateTimeInterface|число|null $releaseAfter = 0, DateTimeInterface|число $expiresAfter = 0)
Создать новый экземпляр middleware.
смешанный handle(смешанный $job, вызов $next)
Обработать задание.
$this releaseAfter(DateTimeInterface|число $releaseAfter)
Установить задержку (в секундах) для возвращения задания в очередь.
$this dontRelease()
Не возвращать задание в очередь, если блокировка не может быть приобретена.
$this expireAfter(DateTimeInterface|int $expiresAfter)
Установите максимальное количество секунд, которое может пройти, прежде чем блокировка будет снята.
$this withPrefix(string $prefix)
Установите префикс ключа блокировки.
string getLockKey(mixed $job)
Получить ключ блокировки для заданной задачи.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/8.x/Illuminate/Queue/Middleware/WithoutOverlapping.html