SyncQueue

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

Свойства

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

Методы

int	secondsUntil(DateTimeInterface\|DateInterval\|int $delay) Получить количество секунд до указанной даты DateTime.	из 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
mixed	pushOn(string $queue, string $job, mixed $data = '') Добавить новую задачу в очередь.	из Queue
mixed	laterOn(string $queue, DateTimeInterface\|DateInterval\|int $delay, string $job, mixed $data = '') Добавить новую задачу в конкретную очередь с задержкой (n) секунд.	из 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	getJobTries(mixed $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	raiseJobQueueingEvent(Closure\|string\|object $job, string $payload) Сгенерировать событие добавления задачи в очередь.	из Queue
void	raiseJobQueuedEvent(string\|int\|null $jobId, Closure\|string\|object $job, string $payload) Сгенерировать событие добавления задачи в очередь.	из 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) Добавить новую задачу в очередь через (n) секунд.
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 = '')

Добавить новую задачу в определённую очередь через (n) секунд.

Параметры

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 getJobTries(mixed $job)

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

Параметры

mixed

$job

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

mixed

mixed getJobBackoff(mixed $job)

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

Parameters

mixed

$job

Return Value

mixed

mixed getJobExpiration(mixed $job)

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

Parameters

mixed

$job

Return Value

mixed

protected bool jobShouldBeEncrypted(object $job)

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

Parameters

object

$job

Return Value

bool

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

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

Parameters

string	$job
string	$queue
mixed	$data

Return Value

array

static void createPayloadUsing(callable|null $callback)

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

Parameters

callable|null

$callback

Return Value

void

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

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

Parameters

string	$queue
array	$payload

Return Value

array

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

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

Parameters

Closure\|string\|object	$job
string	$payload
string	$queue
DateTimeInterface\|DateInterval\|int\|null	$delay
callable	$callback

Return Value

mixed

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

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

Parameters

Closure|string|object

$job

Return Value

bool

protected void raiseJobQueueingEvent(Closure|string|object $job, string $payload)

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

Parameters

Closure\|string\|object	$job
string	$payload

Return Value

void

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

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

Parameters

string\|int\|null	$jobId
Closure\|string\|object	$job
string	$payload

Return Value

void

string getConnectionName()

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

Return Value

string

$this setConnectionName(string $name)

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

Parameters

string

$name

Return Value

$this

Container getContainer()

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

Return Value

Container

void setContainer(Container $container)

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

Parameters

Container

$container

Return Value

void

int size(string|null $queue = null)

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

Parameters

string|null

$queue

Return Value

int

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

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

Parameters

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

Return Value

mixed

Exceptions

Throwable

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

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

Parameters

string	$payload
string	$queue

Return Value

SyncJob

protected void raiseBeforeJobEvent(Job $job)

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

Parameters

Job

$job

Return Value

void

protected void raiseAfterJobEvent(Job $job)

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

Параметры

Job

$job

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

void

protected void raiseExceptionOccurredJobEvent(Job $job, Throwable $e)

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

Параметры

Job	$job
Throwable	$e

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

void

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)

Добавить задание в очередь с отложенным выполнением (через n секунд).

Параметры

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/10.x/Illuminate/Queue/SyncQueue.html