Spec-Zone.ru › Laravel 5.3

IronQueue

class IronQueue extends Queue implements Queue (View source)

Свойства

protected Container $container Экземпляр контейнера IoC. из Queue
protected IronMQ $iron Экземпляр IronMQ.
protected Request $request Текущий экземпляр запроса.
protected string $default Имя по умолчанию очереди.
protected bool $shouldEncrypt Указывает, должны ли сообщения быть зашифрованы.

Методы

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

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

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

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

from Queue
marshal() deprecated

Обработать запрос очереди отправки и запустить задачу.

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

Отправить массив задач в очередь.

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

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

array createPlainPayload(string $job, mixed $data)

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

from Queue
mixed prepareQueueableEntities(mixed $data)

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

from Queue
mixed prepareQueueableEntity(mixed $value)

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

from Queue
string createClosurePayload(Closure $job, mixed $data)

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

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

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

from Queue
int getSeconds(DateTime|int $delay)

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

from Queue
int getTime()

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

from Queue
void setContainer(Container $container)

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

from Queue
void setEncrypter(Encrypter $crypt)

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

from Queue
void __construct(IronMQ $iron, Request $request, string $default, bool $shouldEncrypt = false)

Создать новый экземпляр очереди IronMQ.

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

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

Details

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

marshal() deprecated

deprecated

since версия 5.1.

Отправить запрос очереди обработки и запустить задачу.

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

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

Параметры

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

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

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

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

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

Параметры

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

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

строка

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

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

Параметры

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

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

массив

protected mixed prepareQueueableEntities(mixed $data)

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

Параметры

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

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

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

protected mixed prepareQueueableEntity(mixed $value)

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

Параметры

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

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

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

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

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

Параметры

Closure $job
смешанный тип $data

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

строка

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

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

Параметры

строка $payload
строка $key
строка $value

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

строка

protected int getSeconds(DateTime|int $delay)

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

Параметры

DateTime|int $delay

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

целое число

protected int getTime()

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

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

целое число

void setContainer(Container $container)

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

Параметры

Container $container

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

void

void setEncrypter(Encrypter $crypt)

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

Параметры

Encrypter $crypt

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

void

void __construct(IronMQ $iron, Request $request, string $default, bool $shouldEncrypt = false)

Создать новый экземпляр очереди IronMQ.

Параметры

IronMQ $iron
Request $request
строка $default
булево $shouldEncrypt

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

void

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

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

Параметры

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

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

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

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

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

Параметры

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

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

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

mixed recreate(string $payload, string $queue, int $delay)

Добавить сырой фрагмент данных в очередь после шифрования.

Параметры

строка $payload
строка $queue
целое число $delay

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

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

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

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

Параметры

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

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

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

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

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

Параметры

строка $queue

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

Задача|null

void deleteMessage(string $queue, string $id)

Удалить сообщение из очереди Iron.

Параметры

строка $queue
строка $id

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

void
END_OF_DOCUMENT_MARKER

protected object marshalPushedJob()

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

Значение результата

object

protected IronJob createPushedIronJob(object $job)

Создаёт новое задание IronJob для поставленного задания.

Параметры

object $job

Значение результата

IronJob

protected string parseJobBody(string $body)

Парсит тело задания для запуска.

Параметры

string $body

Значение результата

string

string getQueue(string|null $queue)

Возвращает очередь или по умолчанию.

Параметры

string|null $queue

Значение результата

string

IronMQ getIron()

Возвращает базовый экземпляр IronMQ.

Значение результата

IronMQ

Request getRequest()

Получить экземпляр запроса.

Значение результата

Request

void setRequest(Request $request)

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

Параметры

Request $request

Значение результата

void

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

Spec-Zone.ru

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