SyncQueue

class SyncQueue extends Queue implements Queue (View source)

Свойства

protected Container	$container	Экземпляр контейнера IoC.	из Queue
protected Encrypter	$encrypter	Реализация шифрования.	из Queue
protected string	$connectionName	Имя соединения для очереди.	из Queue

Трейты

InteractsWithTime

Методы

int

secondsUntil(DateTimeInterface $delay)

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

из InteractsWithTime

int

availableAt(DateTimeInterface|int $delay)

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

из InteractsWithTime

int

currentTime()

Получить текущее системное время в виде UNIX-временной метки.

из InteractsWithTime

mixed

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

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

из Queue

mixed

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

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

из Queue

mixed

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

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

из Queue

string

createPayload(string $job, mixed $data = '', string $queue = null)

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

из Queue

array

createPayloadArray(string $job, mixed $data = '', string $queue = null)

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

из Queue

array

createObjectPayload(mixed $job)

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

из Queue

string

getDisplayName(mixed $job)

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

из Queue

array

createStringPayload(string $job, mixed $data)

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

из Queue

string

getConnectionName()

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

из Queue

$this

setConnectionName(string $name)

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

из Queue

void

setContainer(Container $container)

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

из Queue

int

size(string $queue = null)

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

mixed

push(string $job, mixed $data = '', string $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 $queue = null, array $options = [])

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

mixed

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

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

Job|null

pop(string $queue = null)

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

Подробности

protected int secondsUntil(DateTimeInterface $delay)

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

Параметры

DateTimeInterface

$delay

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

int

protected int availableAt(DateTimeInterface|int $delay)

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

Параметры

DateTimeInterface|int

$delay

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

int

protected int currentTime()

Получить текущее системное время в виде UNIX-временной метки.

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

int

END_OF_DOCUMENT_MARKER

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

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

Parameters

string	$queue
string	$job
mixed	$data

Return Value

mixed

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

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

Parameters

string	$queue
DateTime\|int	$delay
string	$job
mixed	$data

Return Value

mixed

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

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

Parameters

array	$jobs
mixed	$data
string	$queue

Return Value

mixed

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

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

Parameters

string	$job
mixed	$data
string	$queue

Return Value

string

Exceptions

InvalidPayloadException

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

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

Parameters

string	$job
mixed	$data
string	$queue

Return Value

array

protected array createObjectPayload(mixed $job)

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

Parameters

mixed

$job

Return Value

array

protected string getDisplayName(mixed $job)

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

Parameters

mixed

$job

Return Value

string

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

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

Parameters

string	$job
mixed	$data

Return Value

array

string getConnectionName()

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

Return Value

string

$this setConnectionName(string $name)

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

Parameters

string

$name

Return Value

$this

void setContainer(Container $container)

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

Parameters

Container

$container

Return Value

void

int size(string $queue = null)

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

Parameters

string

$queue

Return Value

int

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

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

Parameters

string	$job
mixed	$data
string	$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)

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

Parameters

Job

$job

Return Value

void

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

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

Parameters

Job	$job
Exception	$e

Return Value

void

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

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

Parameters

Job	$queueJob
Exception	$e

Return Value

void

Exceptions

Exception

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

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

Параметры

string	$payload
string	$queue
array	$options

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

mixed

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

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

Параметры

DateTime\|int	$delay
string	$job
mixed	$data
string	$queue

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

mixed

Задача|null pop(string $queue = null)

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

Параметры

string

$queue

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

Задача|null

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