IronQueue

class IronQueue extends Queue implements QueueInterface (View source)

Свойства

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

Методы

marshal()

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

mixed

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

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

из Queue

string

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

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

string

createClosurePayload(Closure $job, mixed $data)

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

из 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

void

setEncrypter(Encrypter $crypt)

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

из 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 = array())

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

Подробности

marshal()

Отправить запрос очереди 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 string createClosurePayload(Closure $job, mixed $data)

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

Параметры

Closure	$job
mixed	$data

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

string

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

int getTime()

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

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

int

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
string	$default
bool	$shouldEncrypt

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

void

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

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

Параметры

string	$job
mixed	$data
string	$queue

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

mixed

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

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

Параметры

string	$payload
string	$queue
array	$options

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

mixed

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

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

Параметры

string	$payload
string	$queue
int	$delay

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

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

void deleteMessage(string $queue, string $id)

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

Параметры

string	$queue
string	$id

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

void

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