SyncQueue

класс SyncQueue расширяет Queue реализует Queue (View source)

Черты

Свойства

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

Методы

int

secondsUntil(DateTimeInterface|DateInterval|int $delay)

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

из InteractsWithTime

int

availableAt(DateTimeInterface|DateInterval|int $delay)

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

из InteractsWithTime

DateTimeInterface|int

parseDateInterval(DateTimeInterface|DateInterval|int $delay)

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

из InteractsWithTime

int

currentTime()

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

из InteractsWithTime

mixed

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

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

из Queue

mixed

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

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

из Queue

mixed

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

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

из Queue

string

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

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

из Queue

array

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

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

из Queue

array

createObjectPayload(mixed $job)

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

из Queue

string

getDisplayName(mixed $job)

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

из Queue

mixed

getJobExpiration(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|object $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(DateTimeInterface|DateInterval|int $delay, string|object $job, mixed $data = '', string $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)

Получить отметку времени «доступно в» в формате 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

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 = '')

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

Parameters

string	$job
mixed	$data

Return Value

string

Exceptions

InvalidPayloadException

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

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

Parameters

string	$job
mixed	$data

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

mixed getJobExpiration(mixed $job)

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

Parameters

mixed

$job

Return Value

mixed

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|object $job, mixed $data = '', string $queue = null)

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

Parameters

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

Return Value

mixed

Exceptions

Throwable

END_OF_DOCUMENT_MARKER

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 $queue = null, array $options = [])

Отправить сырой фрагмент данных в очередь.

Параметры

string	$payload
string	$queue
array	$options

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

mixed

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

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

Параметры

DateTimeInterface\|DateInterval\|int	$delay
string\|object	$job
mixed	$data
string	$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.5/Illuminate/Queue/SyncQueue.html