Spec-Zone.ru › Laravel 5.1

BeanstalkdQueue

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

Свойства

protected Контейнер $container Экземпляр контейнера IoC. из Очередь
protected Pheanstalk $pheanstalk Экземпляр Pheanstalk.
protected string $default Название очереди по умолчанию.
protected int $timeToRun Время выполнения для всех поставленных задач.

Методы

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

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

из Очередь
mixed laterOn(string $queue, DateTime|int $delay, string $job, mixed $data = '')

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

из Очередь
marshal() устарел

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

из Очередь
mixed bulk(array $jobs, mixed $data = '', string $queue = null)

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

из Очередь
string createPayload(string $job, mixed $data = '', string $queue = null)

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

из Очередь
array createPlainPayload(string $job, mixed $data)

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

из Очередь
mixed prepareQueueableEntities(mixed $data)

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

из Очередь
mixed prepareQueueableEntity(mixed $value)

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

из Очередь
string createClosurePayload(Closure $job, mixed $data)

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

из Очередь
string setMeta(string $payload, string $key, string $value)

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

из Очередь
int getSeconds(DateTime|int $delay)

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

из Очередь
int getTime()

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

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

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

из Очередь
void setEncrypter(Encrypter $crypt)

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

из Очередь
void __construct(Pheanstalk $pheanstalk, string $default, int $timeToRun)

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

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

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

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

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

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

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

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

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

void deleteMessage(string $queue, string $id)

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

string getQueue(string|null $queue)

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

Pheanstalk getPheanstalk()

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

Подробности

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

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

Параметры

string $queue
string $job
mixed $data

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

mixed

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

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

Параметры

string $queue
DateTime|int $delay
string $job
mixed $data

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

mixed

marshal() устарел

устарел

since версия 5.1.

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

Исключения

RuntimeException

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 $value

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

mixed

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

protected int getTime()

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

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

int

void setContainer(Container $container)

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

Параметры

Container $container

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

void

void setEncrypter(Encrypter $crypt)

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

Параметры

Encrypter $crypt

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

void

void __construct(Pheanstalk $pheanstalk, string $default, int $timeToRun)

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

Параметры

Pheanstalk $pheanstalk
string $default
int $timeToRun

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

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 = [])

Отправить сырые данные в очередь.

Параметры

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

void deleteMessage(string $queue, string $id)

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

Параметры

string $queue
string $id

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

void

string getQueue(string|null $queue)

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

Параметры

string|null $queue

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

string

Pheanstalk getPheanstalk()

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

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

Pheanstalk

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

Spec-Zone.ru

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