RedisQueue

class RedisQueue extends Queue implements Queue (View source)

Свойства

protected Container	$container	Экземпляр контейнера IoC.	из Queue
protected Encrypter	$encrypter	Реализация шифратора.	из Queue
protected Database	$redis	Экземпляр базы данных Redis.
protected string	$connection	Имя соединения.
protected string	$default	Имя очереди по умолчанию.
protected int\|null	$expire	Время истечения срока действия задания.

Методы

mixed

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

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

из Queue

mixed

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

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

из Queue

mixed

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

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

из Queue

string

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

Создать строку данных задания из заданного задания и данных.

array

createPlainPayload(string $job, mixed $data)

Создать массив данных задания в стандартном формате.

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

__construct(Database $redis, string $default = 'default', string $connection = null, int $expire = 60)

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

int

size(string $queue = null)

Получить размер очереди.

mixed

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

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

Подробности

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

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 string setMeta(string $payload, string $key, string $value)

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

Параметры

string	$payload
string	$key
string	$value

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

string

Исключения

InvalidArgumentException

protected int getSeconds(DateTime|int $delay)

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

Параметры

DateTime|int

$delay

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

int

protected int getTime()

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

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

int

void setContainer(Container $container)

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

Параметры

Container

$container

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

void

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

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

Параметры

Database	$redis
string	$default
string	$connection
int	$expire

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

void

int size(string $queue = null)

Получить размер очереди.

Параметры

string

$queue

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

int

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 deleteReserved(string $queue, string $job)

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

Параметры

string	$queue
string	$job

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

void

void deleteAndRelease(string $queue, string $job, int $delay)

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

Параметры

string	$queue
string	$job
int	$delay

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

void

void migrateExpiredJobs(string $from, string $to)

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

Параметры

string	$from
string	$to

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

void

protected string getRandomId()

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

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

string

protected string getQueue(string|null $queue)

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

Параметры

string|null

$queue

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

string

protected ClientInterface getConnection()

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

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

ClientInterface

Database getRedis()

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

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

Database

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