SyncQueue

class SyncQueue extends Очередь implements Очередь (Просмотреть исходный код)

Свойства

protected Контейнер	$container	Экземпляр контейнера IoC.	из Очереди
protected string	$connectionName	Имя подключения к очереди.	из Очереди
protected	$dispatchAfterCommit	Указывает, что задачи должны быть отправлены после подтверждения всех баз данных.	из Очереди
static protected callable[]	$createPayloadCallbacks	Обратные вызовы для создания полезной нагрузки.	из Очереди

Методы

int	secondsUntil(DateTimeInterface\|DateInterval\|int $delay) Получить количество секунд до указанной даты DateTime.	из InteractsWithTime
int	availableAt(DateTimeInterface\|DateInterval\|int $delay = 0) Получить отметку времени "доступно в" в формате UNIX.	из InteractsWithTime
DateTimeInterface\|int	parseDateInterval(DateTimeInterface\|DateInterval\|int $delay) Если заданное значение является интервалом, преобразовать его в экземпляр DateTime.	из InteractsWithTime
int	currentTime() Получить текущее системное время в формате UNIX timestamp.	из InteractsWithTime
mixed	pushOn(string $queue, string $job, mixed $data = '') Добавить новую задачу в очередь.	из Queue
mixed	laterOn(string $queue, DateTimeInterface\|DateInterval\|int $delay, string $job, mixed $data = '') Добавить новую задачу в очередь с задержкой.	из Queue
void	bulk(array $jobs, mixed $data = '', string\|null $queue = null) Добавить массив задач в очередь.	из Queue
string	createPayload(Closure\|string\|object $job, string $queue, mixed $data = '') Создать строковое представление загрузки для заданной задачи и данных.	из Queue
array	createPayloadArray(string\|object $job, string $queue, mixed $data = '') Создать массив данных загрузки для заданной задачи и данных.	из Queue
array	createObjectPayload(object $job, string $queue) Создать загрузку для обработчика очереди на основе объектов.	из Queue
string	getDisplayName(object $job) Получить отображаемое имя для заданной задачи.	из Queue
mixed	getJobBackoff(mixed $job) Получить задержку для обработчика очереди на основе объектов.	из Queue
mixed	getJobExpiration(mixed $job) Получить отметку времени истечения срока действия для обработчика очереди на основе объектов.	из Queue
bool	jobShouldBeEncrypted(object $job) Определить, нужно ли зашифровать задачу.	из Queue
array	createStringPayload(string $job, string $queue, mixed $data) Создать массив данных типичной загрузки для очереди на основе строк.	из Queue
static void	createPayloadUsing(callable\|null $callback) Зарегистрировать обратный вызов, который будет выполнен при создании загрузки задач.	из Queue
array	withCreatePayloadHooks(string $queue, array $payload) Создать указанную загрузку, используя зарегистрированные плагины.	из Queue
mixed	enqueueUsing(Closure\|string\|object $job, string $payload, string $queue, DateTimeInterface\|DateInterval\|int\|null $delay, callable $callback) Добавить задачу в очередь, используя указанный обратный вызов.	из Queue
bool	shouldDispatchAfterCommit(Closure\|string\|object $job) Определить, нужно ли запустить задачу после завершения всех баз данных.	из Queue
void	raiseJobQueuedEvent(string\|int\|null $jobId, Closure\|string\|object $job) Сгенерировать событие о добавлении задачи в очередь.	из Queue
string	getConnectionName() Получить имя подключения для очереди.	из Queue
$this	setConnectionName(string $name) Установить имя подключения для очереди.	из Queue
Container	getContainer() Получить экземпляр контейнера, используемый подключением.	из Queue
void	setContainer(Container $container) Установить экземпляр контейнера IoC.	из Queue
int	size(string\|null $queue = null) Получить размер очереди.
mixed	push(string\|object $job, mixed $data = '', string\|null $queue = null) Добавить новую задачу в очередь.
SyncJob	resolveJob(string $payload, string $queue) Создать экземпляр задачи Sync.
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) Отправить новую задачу в очередь с задержкой.
Job\|null	pop(string\|null $queue = null) Извлечь следующую задачу из очереди.

Подробности

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

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

Параметры

DateTimeInterface|DateInterval|int

$delay

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

int

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

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

Параметры

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

mixed pushOn(string $queue, string $job, mixed $data = '')

Отправить новую задачу в очередь.

Параметры

string	$queue
string	$job
mixed	$data

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

mixed

mixed laterOn(string $queue, DateTimeInterface|DateInterval|int $delay, string $job, mixed $data = '')

Отправить новую задачу в очередь с задержкой.

Параметры

string	$queue
DateTimeInterface\|DateInterval\|int	$delay
string	$job
mixed	$data

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

mixed

void bulk(array $jobs, mixed $data = '', string|null $queue = null)

Отправить массив задач в очередь.

Параметры

array	$jobs
mixed	$data
string\|null	$queue

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

void

protected string createPayload(Closure|string|object $job, string $queue, mixed $data = '')

Создать строку полезного груза из заданной задачи и данных.

Параметры

Closure\|string\|object	$job
string	$queue
mixed	$data

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

string

Исключения

InvalidPayloadException

protected array createPayloadArray(string|object $job, string $queue, mixed $data = '')

Создать массив полезного груза из заданной задачи и данных.

Параметры

string\|object	$job
string	$queue
mixed	$data

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

array

protected array createObjectPayload(object $job, string $queue)

Создать полезный груз для обработчика очереди на основе объектов.

Параметры

object	$job
string	$queue

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

array

protected string getDisplayName(object $job)

Получить имя для отображения заданной задачи.

Параметры

object

$job

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

string

mixed getJobBackoff(mixed $job)

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

Параметры

mixed

$job

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

mixed

mixed getJobExpiration(mixed $job)

Получить отметку времени истечения срока действия для обработчика очереди на основе объектов.

Параметры

mixed

$job

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

mixed

protected bool jobShouldBeEncrypted(object $job)

Определить, следует ли шифровать задачу.

Параметры

object

$job

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

bool

protected array createStringPayload(string $job, string $queue, mixed $data)

Создайте типичный массив данных очереди на основе строк.

Параметры

строка	$job
строка	$queue
смешанный тип	$data

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

массив

static void createPayloadUsing(callable|null $callback)

Зарегистрируйте обратный вызов для выполнения при создании данных задачи.

Параметры

callable|null

$callback

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

void

protected array withCreatePayloadHooks(string $queue, array $payload)

Создайте заданные данные с использованием любых зарегистрированных обработчиков данных.

Параметры

строка	$queue
массив	$payload

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

массив

protected mixed enqueueUsing(Closure|string|object $job, string $payload, string $queue, DateTimeInterface|DateInterval|int|null $delay, callable $callback)

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

Параметры

Closure\|string\|object	$job
строка	$payload
строка	$queue
DateTimeInterface\|DateInterval\|int\|null	$delay
callable	$callback

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

смешанный тип

protected bool shouldDispatchAfterCommit(Closure|string|object $job)

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

Параметры

Closure|string|object

$job

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

bool

protected void raiseJobQueuedEvent(string|int|null $jobId, Closure|string|object $job)

Вызвать событие добавления задачи в очередь.

Параметры

строка\|целое число\|null	$jobId
Closure\|string\|object	$job

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

void

string getConnectionName()

Получить имя подключения к очереди.

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

строка

$this setConnectionName(string $name)

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

Параметры

строка

$name

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

$this

Container getContainer()

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

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

Container

void setContainer(Container $container)

Установить экземпляр контейнера IoC.

Параметры

Container

$container

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

void

int size(string|null $queue = null)

Получить размер очереди.

Параметры

строка|null

$queue

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

целое число

mixed push(string|object $job, mixed $data = '', string|null $queue = null)

Добавить новую задачу в очередь.

Параметры

строка\|объект	$job
смешанный тип	$data
строка\|null	$queue

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

смешанный тип

Исключения

Throwable

protected SyncJob resolveJob(string $payload, string $queue)

Разрешить экземпляр задачи Sync.

Параметры

строка	$payload
строка	$queue

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

SyncJob

protected void raiseBeforeJobEvent(Job $job)

Вызвать событие перед задачей очереди.

Параметры

Задача

$job

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

void

protected void raiseAfterJobEvent(Задача $job)

Вызвать событие после задачи очереди.

Параметры

Задача

$job

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

void

protected void raiseExceptionOccurredJobEvent(Задача $job, Throwable $e)

Вызвать событие возникновения исключения при выполнении задачи в очереди.

Параметры

Задача	$job
Throwable	$e

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

void

END_OF_DOCUMENT_MARKER

protected void handleException(Job $queueJob, Throwable $e)

Обработать исключение, произошедшее во время обработки задания.

Параметры

Job	$queueJob
Throwable	$e

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

void

Исключения

Throwable

mixed pushRaw(string $payload, string|null $queue = null, array $options = [])

Отправить сырое содержимое на очередь.

Параметры

string	$payload
string\|null	$queue
array	$options

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

mixed

mixed later(DateTimeInterface|DateInterval|int $delay, string|object $job, mixed $data = '', string|null $queue = null)

Отправить новое задание в очередь с задержкой.

Параметры

DateTimeInterface\|DateInterval\|int	$delay
string\|object	$job
mixed	$data
string\|null	$queue

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

mixed

Job|null pop(string|null $queue = null)

Извлечь следующее задание из очереди.

Параметры

string|null

$queue

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

Job|null

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