Очередь синхронизации
класс SyncQueue расширяет Очередь и реализует Очередь (Просмотреть исходный код)
Трейты
| Взаимодействует со временем |
Свойства
| protected Контейнер | $container | Экземпляр контейнера IoC. | из Очереди |
| protected string | $connectionName | Имя подключения к очереди. | из Очереди |
| protected | $dispatchAfterCommit | Указывает, что задачи должны быть отправлены после завершения всех транзакций базы данных. | из Очереди |
| static protected callable[] | $createPayloadCallbacks | Обратные вызовы создания полезной нагрузки. | из Очереди |
Методы
| int | secondsUntil(DateTimeInterface|DateInterval|int $delay)
Получить количество секунд до заданного времени DateTime. | 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. | from InteractsWithTime |
| mixed | pushOn(string $queue, string $job, mixed $data = '')
Добавить новую задачу в очередь. | from Queue |
| mixed | laterOn(string $queue, DateTimeInterface|DateInterval|int $delay, string $job, mixed $data = '')
Добавить новую задачу в определенную очередь через (n) секунд. | from Queue |
| void | bulk(array $jobs, mixed $data = '', string|null $queue = null)
Добавить массив задач в очередь. | from Queue |
| string | createPayload(Closure|string|object $job, string $queue, mixed $data = '')
Создать строку полезной нагрузки из заданной задачи и данных. | from Queue |
| array | createPayloadArray(string|object $job, string $queue, mixed $data = '')
Создать массив полезной нагрузки из заданной задачи и данных. | from Queue |
| array | createObjectPayload(object $job, string $queue)
Создать полезную нагрузку для обработчика очереди на основе объекта. | from Queue |
| string | getDisplayName(object $job)
Получить отображаемое имя для заданной задачи. | from Queue |
| mixed | getJobBackoff(mixed $job)
Получить задержку для обработчика очереди на основе объекта. | from Queue |
| mixed | getJobExpiration(mixed $job)
Получить метку времени истечения срока действия для обработчика очереди на основе объекта. | from Queue |
| bool | jobShouldBeEncrypted(object $job)
Определить, следует ли шифровать задачу. | from Queue |
| array | createStringPayload(string $job, string $queue, mixed $data)
Создать типичный массив полезной нагрузки очереди на основе строки. | from Queue |
| static void | createPayloadUsing(callable|null $callback)
Зарегистрировать обратный вызов, который будет выполнен при создании полезных нагрузок задач. | from Queue |
| array | withCreatePayloadHooks(string $queue, array $payload)
Создать заданную полезную нагрузку с использованием любых зарегистрированных хуков полезной нагрузки. | from Queue |
| mixed | enqueueUsing(Closure|string|object $job, string $payload, string $queue, DateTimeInterface|DateInterval|int|null $delay, callable $callback)
Добавить задачу в очередь с использованием заданного обратного вызова. | from Queue |
| bool | shouldDispatchAfterCommit(Closure|string|object $job)
Определить, следует ли отправлять задачу после подтверждения всех транзакций базы данных. | from Queue |
| void | raiseJobQueuedEvent(string|int|null $jobId, Closure|string|object $job)
Вызвать событие добавления задачи в очередь. | from Queue |
| string | getConnectionName()
Получить имя соединения для очереди. | from Queue |
| $this | setConnectionName(string $name)
Установить имя соединения для очереди. | from Queue |
| Container | getContainer()
Получить экземпляр контейнера, используемый соединением. | from Queue |
| void | setContainer(Container $container)
Установить экземпляр контейнера IoC. | from Queue |
| int | size(string|null $queue = null)
Получить размер очереди. | |
| mixed | push(string|object $job, mixed $data = '', string|null $queue = null)
Добавить новую задачу в очередь. | |
| SyncJob | resolveJob(string $payload, string $queue)
Разрешить экземпляр синхронной задачи. | |
| void | raiseBeforeJobEvent(Job $job)
Вызвать событие перед выполнением задачи очереди. | |
| void | raiseAfterJobEvent(Job $job)
Вызвать событие после выполнения задачи очереди. |
| void | raiseExceptionOccurredJobEvent(Job $job, Throwable $e)
Вызвать событие очереди обработки задания с возникшей ошибкой. | |
| void | handleException(Job $queueJob, Throwable $e)
Обработать исключение, возникшее во время обработки задания. | |
| mixed | pushRaw(string $payload, string|null $queue = null, array $options = [])
Отправить сырое содержимое в очередь. | |
| mixed | later(DateTimeInterface|DateInterval|int $delay, string|object $job, mixed $data = '', string|null $queue = null)
Отправить задание в очередь через (n) секунд. | |
| Job|null | pop(string|null $queue = null)
Извлечь следующее задание из очереди. |
Подробности
protected int secondsUntil(DateTimeInterface|DateInterval|int $delay)
Получить количество секунд до заданной даты и времени.
protected int availableAt(DateTimeInterface|DateInterval|int $delay = 0)
Получить UNIX-метку времени "доступно в".
protected DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)
Если заданное значение является интервалом, преобразуйте его в экземпляр DateTime.
protected int currentTime()
Получить текущее системное время в формате UNIX-метки.
mixed pushOn(string $queue, string $job, mixed $data = '')
Отправить новое задание в очередь.
mixed laterOn(string $queue, DateTimeInterface|DateInterval|int $delay, string $job, mixed $data = '')
Отправить новое задание в указанную очередь через (n) секунд.
void bulk(array $jobs, mixed $data = '', string|null $queue = null)
Отправить массив заданий в очередь.
protected string createPayload(Closure|string|object $job, string $queue, mixed $data = '')
Создать строку полезной нагрузки из заданного задания и данных.
protected array createPayloadArray(string|object $job, string $queue, mixed $data = '')
Создать массив полезной нагрузки из заданного задания и данных.
protected array createObjectPayload(object $job, string $queue)
Создать полезную нагрузку для обработчика очереди на основе объекта.
protected string getDisplayName(object $job)
Получить отображаемое имя для заданного задания.
mixed getJobBackoff(mixed $job)
Получить отложенную обработку для обработчика очереди на основе объекта.
mixed getJobExpiration(mixed $job)
Получить отметку времени истечения срока действия задания для обработчика очереди на основе объекта.
protected bool jobShouldBeEncrypted(object $job)
Определить, следует ли зашифровать задание.
protected array createStringPayload(string $job, string $queue, mixed $data)
Создайте типичный массив данных очереди на основе строк.
static void createPayloadUsing(callable|null $callback)
Зарегистрируйте обратный вызов для выполнения при создании данных задачи.
protected array withCreatePayloadHooks(string $queue, array $payload)
Создайте заданные данные с использованием любых зарегистрированных обработчиков данных.
protected mixed enqueueUsing(Closure|string|object $job, string $payload, string $queue, DateTimeInterface|DateInterval|int|null $delay, callable $callback)
Добавить задачу в очередь с использованием данного обратного вызова.
protected bool shouldDispatchAfterCommit(Closure|string|object $job)
Определить, должна ли задача быть отправлена после завершения всех транзакций базы данных.
protected void raiseJobQueuedEvent(string|int|null $jobId, Closure|string|object $job)
Вызвать событие добавления задачи в очередь.
string getConnectionName()
Получить имя подключения к очереди.
$this setConnectionName(string $name)
Установить имя подключения к очереди.
Container getContainer()
Получить экземпляр контейнера, используемый подключением.
void setContainer(Container $container)
Установить экземпляр контейнера IoC.
int size(string|null $queue = null)
Получить размер очереди.
mixed push(string|object $job, mixed $data = '', string|null $queue = null)
Добавить новую задачу в очередь.
protected SyncJob resolveJob(string $payload, string $queue)
Разрешить экземпляр задачи Sync.
protected void raiseBeforeJobEvent(Job $job)
Вызвать событие перед задачей очереди.
protected void raiseAfterJobEvent(Задача $job)
Вызвать событие после задачи очереди.
protected void raiseExceptionOccurredJobEvent(Задача $job, Throwable $e)
Вызвать событие возникновения исключения при выполнении задачи в очереди.
protected void handleException(Job $queueJob, Throwable $e)
Обработать исключение, возникшее во время обработки задания.
mixed pushRaw(string $payload, string|null $queue = null, array $options = [])
Отправить сырое содержимое в очередь.
mixed later(DateTimeInterface|DateInterval|int $delay, string|object $job, mixed $data = '', string|null $queue = null)
Отправить новое задание в очередь через (n) секунд.
Job|null pop(string|null $queue = null)
Извлечь следующее задание из очереди.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/9.x/Illuminate/Queue/SyncQueue.html
