SyncQueue

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

Свойства

protected Контейнер	$container	Экземпляр контейнера IoC.	из Очереди
protected string	$connectionName	Имя подключения к очереди.	из Очереди
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(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

getJobRetryDelay(mixed $job)

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

из Queue

mixed

getJobExpiration(mixed $job)

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

из Queue

array

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

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

из Queue

static void

createPayloadUsing(callable $callback)

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

из Queue

array

withCreatePayloadHooks(string $queue, array $payload)

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

из Queue

string

getConnectionName()

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

из Queue

$this

setConnectionName(string $name)

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

из 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, Exception $e)

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

void

handleException(Job $queueJob, Exception $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 $queue = null)

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

Подробности

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

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

Parameters

DateTimeInterface|DateInterval|int

$delay

Return Value

int

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

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

Parameters

DateTimeInterface|DateInterval|int

$delay

Return Value

int

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

Если заданное значение является интервалом, преобразовать его в экземпляр DateTime.

Parameters

DateTimeInterface|DateInterval|int

$delay

Return Value

DateTimeInterface|int

protected int currentTime()

Получить текущее время системы в формате UNIX timestamp.

Return Value

int

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

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

Parameters

string	$queue
string	$job
mixed	$data

Return Value

mixed

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

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

Parameters

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

Return Value

mixed

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

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

Parameters

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

Return Value

void

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

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

Parameters

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

Return Value

string

Exceptions

InvalidPayloadException

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

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

Parameters

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

Return Value

array

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

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

Параметры

объект	$job
строка	$queue

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

массив

protected string getDisplayName(object $job)

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

Параметры

объект

$job

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

строка

mixed getJobRetryDelay(mixed $job)

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

Параметры

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

$job

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

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

mixed getJobExpiration(mixed $job)

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

Параметры

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

$job

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

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

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

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

Параметры

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

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

массив

static void createPayloadUsing(callable $callback)

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

Параметры

вызываемый объект

$callback

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

пустое значение

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

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

Параметры

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

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

массив

string getConnectionName()

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

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

строка

$this setConnectionName(string $name)

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

Параметры

string

$name

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

$this

void setContainer(Container $container)

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

Параметры

Container

$container

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

void

int size(string|null $queue = null)

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

Параметры

string|null

$queue

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

int

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

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

Параметры

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

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

mixed

Исключения

Throwable

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

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

Параметры

string	$payload
string	$queue

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

SyncJob

protected void raiseBeforeJobEvent(Job $job)

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

Параметры

Job

$job

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

void

protected void raiseAfterJobEvent(Job $job)

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

Параметры

Job

$job

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

void

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

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

Параметры

Job	$job
Exception	$e

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

void

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

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

Параметры

Job	$queueJob
Exception	$e

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

void

Исключения

Exception

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 $queue = null)

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

Параметры

string

$queue

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

Job|null

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