RedisQueue

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

Свойства

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

Методы

смешанное

pushOn(string $queue, string $job, смешанное $data = '')

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

из Очередь

смешанное

laterOn(string $queue, DateTime|int $delay, string $job, смешанное $data = '')

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

из Очередь

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

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

из Очередь

смешанное

bulk(array $jobs, смешанное $data = '', string $queue = null)

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

из Очередь

строка

createPayload(string $job, смешанное $data = '', string $queue = null)

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

массив

createPlainPayload(string $job, смешанное $data)

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

из Очередь

смешанное

prepareQueueableEntities(смешанное $data)

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

из Очередь

смешанное

prepareQueueableEntity(смешанное $value)

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

из Очередь

строка

createClosurePayload(Closure $job, смешанное $data)

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

из Очередь

строка

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

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

из Очередь

целое число

getSeconds(DateTime|int $delay)

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

из Очередь

целое число

getTime()

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

из Очередь

void

setContainer(Контейнер $container)

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

из Очередь

void

setEncrypter(Encrypter $crypt)

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

из Очередь

void

__construct(База данных $redis, string $default = 'default', string $connection = null)

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

смешанное

push(string $job, смешанное $data = '', string $queue = null)

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

смешанное

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

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

смешанное

later(DateTime|int $delay, string $job, смешанное $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)

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

массив

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

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

void

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

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

void

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

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

строка

getRandomId()

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

строка

getQueue(string|null $queue)

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

ClientInterface

getConnection()

Получить подключение для очереди.

База данных

getRedis()

Получить базовое соединение Redis.

целое число|null

getExpire()

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

void

setExpire(int|null $seconds)

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

Подробности

смешанное pushOn(string $queue, string $job, смешанное $data = '')

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

Параметры

строка	$queue
строка	$job
смешанное	$data

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

смешанное

END_OF_DOCUMENT_MARKER

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.

Обработать запрос очереди 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 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(Database $redis, string $default = 'default', string $connection = null)

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

Параметры

Database	$redis
string	$default
string	$connection

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

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

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

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

Параметры

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

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

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()

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

Return Value

ClientInterface

Database getRedis()

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

Return Value

Database

int|null getExpire()

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

Return Value

int|null

void setExpire(int|null $seconds)

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

Parameters

int|null

$seconds

Return Value

void

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

RedisQueue

Свойства

Методы

Подробности

смешанное pushOn(string $queue, string $job, смешанное $data = '')

Параметры

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

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

Параметры

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

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(Database $redis, string $default = 'default', string $connection = null)

Параметры

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

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)

Параметры

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

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

Параметры

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

Job|null pop(string $queue = null)

Parameters

Return Value

void deleteReserved(string $queue, string $job)

Parameters

Return Value

protected void migrateAllExpiredJobs(string $queue)

Parameters

Return Value

void migrateExpiredJobs(string $from, string $to)

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

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