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)

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

mixed

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

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

mixed

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

Отправить сырую полезную нагрузку в очередь после шифрования полезной нагрузки.

mixed

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

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

Job|null

pop(string $queue = null)

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

void

deleteMessage(string $queue, string $id)

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

object

marshalPushedJob()

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

IronJob

createPushedIronJob(object $job)

Создать новую задачу IronJob для отправленной задачи.

string

parseJobBody(string $body)

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

string

getQueue(string|null $queue)

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

IronMQ

getIron()

Получить базовый экземпляр IronMQ.

Request

getRequest()

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

void

setRequest(Request $request)

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

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() ^{устаревший}

^{устаревший}

since версия 5.1.

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

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

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

DateTime|int

$delay

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

int

string

$queue

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

Задача|null

void deleteMessage(string $queue, string $id)

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

Параметры

string	$queue
string	$id

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

void

END_OF_DOCUMENT_MARKER

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.5/Illuminate/Queue/IronQueue.html

IronQueue

Свойства

Методы

Details

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

Parameters

Return Value

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

Parameters

Return Value

marshal() устаревший

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

Параметры

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

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

Параметры

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

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

Параметры

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

protected mixed prepareQueueableEntities(mixed $data)

Параметры

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

protected mixed prepareQueueableEntity(mixed $value)

Параметры

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

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

Параметры

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

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

Параметры

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

protected int getSeconds(DateTime|int $delay)

Параметры

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

protected int getTime()

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

void setContainer(Container $container)

Параметры

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

void setEncrypter(Encrypter $crypt)

Параметры

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

void __construct(IronMQ $iron, Запрос $request, string $default, bool $shouldEncrypt = false)

Параметры

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

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

Параметры

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

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

Параметры

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

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

Параметры

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

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

Параметры

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

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

Параметры

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

void deleteMessage(string $queue, string $id)

Параметры

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

protected object marshalPushedJob()

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

protected IronJob createPushedIronJob(object $job)

Параметры

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

protected string parseJobBody(string $body)

Параметры

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

string getQueue(string|null $queue)

Параметры

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

IronMQ getIron()

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

Request getRequest()

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

void setRequest(Request $request)

marshal() ^{устаревший}