SyncQueue

class SyncQueue extends Queue implements Queue (View source)

Свойства

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

Методы

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

createPlainPayload(string $job, mixed $data)

Создать типичную полезную нагрузку очереди.

из Queue

string

setMeta(string $payload, string $key, string $value)

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

из Queue

int

getSeconds(DateTime|int $delay)

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

из Queue

int

getTime()

Получить текущее значение отметки времени Unix.

из Queue

void

setContainer(Container $container)

Установить инстанс контейнера IoC.

из Queue

int

size(string $queue = null)

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

mixed

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

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

void

handleSyncException(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)

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

SyncJob

resolveJob(string $payload, string $queue)

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

void

raiseBeforeJobEvent(Job $job)

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

void

raiseAfterJobEvent(Job $job)

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

void

raiseExceptionOccurredJobEvent(Job $job, Exception $e)

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

array

handleFailedJob(Job $job, Exception $e)

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

void

raiseFailedJobEvent(Job $job, Exception $e)

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

Подробности

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

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

Параметры

string	$queue
string	$job
mixed	$data

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

mixed

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

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

Параметры

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

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

mixed

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

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

Параметры

array	$jobs
mixed	$data
string	$queue

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

mixed

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

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

Параметры

string	$job
mixed	$data
string	$queue

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

string

Исключения

InvalidArgumentException

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

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

Параметры

string	$job
mixed	$data

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

array

protected string setMeta(string $payload, string $key, string $value)

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

Параметры

string	$payload
string	$key
string	$value

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

string

Исключения

InvalidArgumentException

protected int getSeconds(DateTime|int $delay)

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

Параметры

DateTime|int

$delay

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

int

protected int getTime()

Получить текущую метку времени Unix.

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

int

void setContainer(Container $container)

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

Параметры

Container

$container

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

void

int size(string $queue = null)

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

Параметры

string

$queue

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

int

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

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

Параметры

string	$job
mixed	$data
string	$queue

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

mixed

Исключения

Throwable

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

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

Параметры

Job	$queueJob
Exception	$e

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

void

Исключения

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

Job|null pop(string $queue = null)

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

Параметры

string

$queue

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

Job|null

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 array handleFailedJob(Job $job, Exception $e)

Обработать ошибочную задачу.

Параметры

Job	$job
Exception	$e

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

array

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

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

Параметры

Job	$job
Exception	$e

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

void

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

END_OF_DOCUMENT_MARKER