Spec-Zone.ru › Laravel 5.2

SyncQueue

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

Свойства

protected Контейнер $container Экземпляр контейнера IoC. из Очередь
protected Шифровальщик $encrypter Реализация шифровальщика. из Очередь

Методы

смешанный pushOn(строка $queue, строка $job, смешанный $data = '')

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

из Очередь
смешанный laterOn(строка $queue, DateTime|целое число $delay, строка $job, смешанный $data = '')

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

из Очередь
смешанный bulk(массив $jobs, смешанный $data = '', строка $queue = null)

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

из Очередь
строка createPayload(строка $job, смешанный $data = '', строка $queue = null)

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

из Очередь
массив createPlainPayload(строка $job, смешанный $data)

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

из Очередь
смешанный prepareQueueableEntities(смешанный $data)

Подготовка любых сущностей для добавления в очередь для хранения.

из Очередь
смешанный prepareQueueableEntity(смешанный $value)

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

из Очередь
массив createClosurePayload(Closure $job, смешанный $data)

Создание строки полезной нагрузки для заданной задачи Closure.

из Очередь
строка setMeta(строка $payload, строка $key, строка $value)

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

из Очередь
целое число getSeconds(DateTime|целое число $delay)

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

из Очередь
целое число getTime()

Получение текущего отметки времени UNIX.

из Очередь
void setContainer(Контейнер $container)

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

из Очередь
Шифровальщик getEncrypter()

Получение реализации шифровальщика.

из Очередь
void setEncrypter(Шифровальщик $encrypter)

Установка реализации шифровальщика.

из Очередь
смешанный push(строка $job, смешанный $data = '', строка $queue = null)

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

смешанный pushRaw(строка $payload, строка $queue = null, массив $options = [])

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

смешанный later(DateTime|целое число $delay, строка $job, смешанный $data = '', строка $queue = null)

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

Задача|null pop(строка $queue = null)

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

SyncJob resolveJob(строка $payload)

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

void raiseBeforeJobEvent(Задача $job)

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

void raiseAfterJobEvent(Задача $job)

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

void raiseExceptionOccurredJobEvent(Задача $job, Throwable $exception)

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

массив handleFailedJob(Задача $job)

Обработка не удавшейся задачи.

void raiseFailedJobEvent(Задача $job)

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

Подробности

смешанный pushOn(строка $queue, строка $job, смешанный $data = '')

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

Параметры

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

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

смешанный

смешанный laterOn(строка $queue, DateTime|целое число $delay, строка $job, смешанный $data = '')

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

Параметры

строка $queue
DateTime|целое число $delay
строка $job
смешанный $data

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

смешанный

смешанный bulk(массив $jobs, смешанный $data = '', строка $queue = null)

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

Параметры

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

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

смешанный

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

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

Параметры

string $job
mixed $data
string $queue

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

string

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

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

Параметры

string $job
mixed $data

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

array

protected mixed prepareQueueableEntities(mixed $data)

Подготовьте все сущности, пригодные для очереди, для хранения в очереди.

Параметры

mixed $data

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

mixed

protected mixed prepareQueueableEntity(mixed $value)

Подготовьте одну сущность, пригодную для очереди, для хранения в очереди.

Параметры

mixed $value

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

mixed

protected array createClosurePayload(Closure $job, mixed $data)

Создайте строку полезной нагрузки для заданной работы Closure.

Параметры

Closure $job
mixed $data

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

array

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

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

Параметры

string $payload
string $key
string $value

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

string

protected int getSeconds(DateTime|int $delay)

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

Параметры

DateTime|int $delay

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

int

protected int getTime()

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

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

int

void setContainer(Container $container)

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

Параметры

Container $container

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

void

protected Encrypter getEncrypter()

Получить реализацию шифрования.

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

Encrypter

Исключения

Exception

void setEncrypter(Encrypter $encrypter)

Установить реализацию шифрования.

Параметры

Encrypter $encrypter

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

void

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

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

Параметры

string $job
mixed $data
string $queue

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

mixed

Исключения

Throwable

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)

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

Параметры

string $payload

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

SyncJob

protected void raiseBeforeJobEvent(Job $job)

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

Параметры

Job $job

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

void

protected void raiseAfterJobEvent(Job $job)

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

Параметры

Job $job

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

void

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

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

Параметры

Job $job
Throwable $exception

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

void

protected array handleFailedJob(Job $job)

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

Параметры

Job $job

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

array

protected void raiseFailedJobEvent(Job $job)

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

Параметры

Job $job

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

void

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API