Spec-Zone.ru › Laravel 4.2

RedisQueue

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

Свойства

protected Контейнер $container Экземпляр контейнера IoC. из Очередь
protected База данных $redis Экземпляр базы данных Redis.
protected string $connection Имя подключения.
protected string $default Имя очереди по умолчанию.
protected int|null $expire Время истечения срока действия задания.

Методы

marshal()

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

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

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

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

Создать строку полезной нагрузки из заданного задания и данных.
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(Шифровальщик $crypt)

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

 из Очередь
void __construct(База данных $redis, string $default = 'default', string $connection = null)

Создать новый экземпляр очереди Redis.
mixed push(string $job, mixed $data = '', string $queue = null)

Добавить новое задание в очередь.
mixed pushRaw(string $payload, string $queue = null, array $options = array())

Добавить сырую полезную нагрузку в очередь.
mixed later(DateTime|int $delay, string $job, mixed $data = '', string $queue = null)

Добавить новое задание в очередь с задержкой.
void release(string $queue, string $payload, int $delay, int $attempts)

Возвратить зарезервированное задание обратно в очередь.
Задание|null pop(string $queue = null)

Извлечь следующее задание из очереди.
void deleteReserved(string $queue, string $job)

Удалить зарезервированное задание из очереди.
void migrateAllExpiredJobs(string $queue)

Переместить все ожидания заданий в очереди.
void migrateExpiredJobs(string $from, string $to)

Переместить отложенные задания, готовые к выполнению в обычную очередь.
array getExpiredJobs(MultiExec $transaction, string $from, int $time)

Получить просроченные задания из заданной очереди.
void removeExpiredJobs(MultiExec $transaction, string $from, int $time)

Удалить просроченные задания из заданной очереди.
void pushExpiredJobsOntoNewQueue(MultiExec $transaction, string $to, array $jobs)

Добавить все заданные задания в другую очередь.
string getRandomId()

Получить случайную строку ID.
string getQueue(string|null $queue)

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

Получить подключение для очереди.
База данных getRedis()

Получить базу данных Redis.
int|null getExpire()

Получить время истечения срока действия в секундах.
void setExpire(int|null $seconds)

Установить время истечения срока действия в секундах.

Подробности

marshal()

Маршалить запрос очереди push и запустить задачу.

Исключения

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 string createClosurePayload(Closure $job, mixed $data)

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

Параметры

Closure $job
mixed $data

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

string

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

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

Parameters

string $payload
string $key
string $value

Return Value

string

protected int getSeconds(DateTime|int $delay)

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

Parameters

DateTime|int $delay

Return Value

int

int getTime()

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

Return Value

int

void setContainer(Container $container)

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

Parameters

Container $container

Return Value

void

void setEncrypter(Encrypter $crypt)

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

Parameters

Encrypter $crypt

Return Value

void

void __construct(Database $redis, string $default = 'default', string $connection = null)

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

Parameters

Database $redis
string $default
string $connection

Return Value

void

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

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

Parameters

string $job
mixed $data
string $queue

Return Value

mixed

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

Добавить сырой payload в очередь.

Parameters

string $payload
string $queue
array $options

Return Value

mixed

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

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

Parameters

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

Return Value

mixed

void release(string $queue, string $payload, int $delay, int $attempts)

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

Parameters

string $queue
string $payload
int $delay
int $attempts

Return Value

void

Job|null pop(string $queue = null)

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

Parameters

string $queue

Return Value

Job|null

void deleteReserved(string $queue, string $job)

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

Parameters

string $queue
string $job

Return Value

void

protected void migrateAllExpiredJobs(string $queue)

Мигрировать все ожидания задач в очереди.

Parameters

string $queue

Return Value

void

void migrateExpiredJobs(string $from, string $to)

Мигрировать отложенные задачи, готовые к обычной очереди.

Parameters

string $from
string $to

Return Value

void

protected array getExpiredJobs(MultiExec $transaction, string $from, int $time)

Получить просроченные задачи из заданной очереди.

Parameters

MultiExec $transaction
string $from
int $time

Return Value

array

protected void removeExpiredJobs(MultiExec $transaction, string $from, int $time)

Удалить просроченные задачи из заданной очереди.

Parameters

MultiExec $transaction
string $from
int $time

Return Value

void

protected void pushExpiredJobsOntoNewQueue(MultiExec $transaction, string $to, array $jobs)

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

Parameters

MultiExec $transaction
string $to
array $jobs

Return Value

void

protected string getRandomId()

Получить случайную строку ID.

Return Value

string

protected string getQueue(string|null $queue)

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

Parameters

string|null $queue

Return Value

string

protected ClientInterface getConnection()

Получить соединение для очереди.

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

ClientInterface

База данных getRedis()

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

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

База данных

int|null getExpire()

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

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

int|null

void setExpire(int|null $seconds)

Установить время истечения срока действия в секундах.

Параметры

int|null $seconds

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

void

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

Spec-Zone.ru

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