RedisQueue
class RedisQueue extends Очередь implements Очередь (Просмотреть исходный код)
Трейты
| InteractsWithTime |
Свойства
| protected Контейнер | $container | Экземпляр контейнера IoC. | из Очередь |
| protected Шифровальщик | $encrypter | Реализация шифрования. | из Очередь |
| protected string | $connectionName | Имя соединения для очереди. | из Очередь |
| protected Фабрика | $redis | Реализация фабрики Redis. | |
| protected string | $connection | Имя соединения. | |
| protected string | $default | Имя очереди по умолчанию. | |
| protected int|null | $retryAfter | Время ожидания повторной попытки выполнения задачи. |
Методы
| int | secondsUntil(DateTimeInterface|DateInterval|int $delay) Получить количество секунд до указанной даты DateTime. | from InteractsWithTime |
| int | availableAt(DateTimeInterface|DateInterval|int $delay) Получить временную метку UNIX "доступно в" (available at). | from InteractsWithTime |
| DateTimeInterface|int | parseDateInterval(DateTimeInterface|DateInterval|int $delay) Если заданное значение представляет собой интервал, преобразовать его в экземпляр DateTime. | from InteractsWithTime |
| int | currentTime() Получить текущее системное время в виде метки времени UNIX. | from InteractsWithTime |
| mixed | pushOn(string $queue, string $job, mixed $data = '') Добавить новую задачу в очередь. | from Queue |
| mixed | laterOn(string $queue, DateTimeInterface|DateInterval|int $delay, string $job, mixed $data = '') Добавить новую задачу в очередь с задержкой. | from Queue |
| mixed | bulk(array $jobs, mixed $data = '', string $queue = null) Добавить массив задач в очередь. | from Queue |
| string | createPayload(string $job, mixed $data = '') Создать строку полезной нагрузки из заданной задачи и данных. | from Queue |
| array | createPayloadArray(string $job, mixed $data = '') Создать строку полезной нагрузки из заданной задачи и данных. | |
| array | createObjectPayload(mixed $job) Создать полезную нагрузку для обработчика очереди на основе объектов. | from Queue |
| string | getDisplayName(mixed $job) Получить отображаемое имя для заданной задачи. | from Queue |
| mixed | getJobExpiration(mixed $job) Получить временную метку истечения срока действия для обработчика очереди на основе объектов. | from Queue |
| array | createStringPayload(string $job, mixed $data) Создать массив типичной полезной нагрузки очереди на основе строк. | from Queue |
| string | getConnectionName() Получить имя подключения к очереди. | from Queue |
| $this | setConnectionName(string $name) Установить имя подключения к очереди. | from Queue |
| void | setContainer(Container $container) Установить экземпляр контейнера IoC. | from Queue |
| void | __construct(Factory $redis, string $default = 'default', string $connection = null, int $retryAfter = 60) Создать новый экземпляр очереди Redis. | |
| int | size(string $queue = null) Получить размер очереди. | |
| mixed | push(string|object $job, mixed $data = '', string $queue = null) Добавить новую задачу в очередь. | |
| mixed | pushRaw(string $payload, string $queue = null, array $options = []) Добавить сырую полезную нагрузку в очередь. | |
| mixed | later(DateTimeInterface|DateInterval|int $delay, string|object $job, mixed $data = '', string $queue = null) Добавить новую задачу в очередь с задержкой. | |
| mixed | laterRaw(DateTimeInterface|DateInterval|int $delay, string $payload, string $queue = null) Добавить сырую задачу в очередь с задержкой. | |
| Job|null | pop(string $queue = null) Извлечь следующую задачу из очереди. | |
| void | migrate(string $queue) Мигрировать любые отложенные или истекшие задачи в основную очередь. | |
| array | migrateExpiredJobs(string $from, string $to) Мигрировать отложенные задачи, готовые к отправке, в обычную очередь. | |
| array | retrieveNextJob(string $queue) Извлечь следующую задачу из очереди. | |
| void | deleteReserved(string $queue, RedisJob $job) Удалить зарезервированную задачу из очереди. | |
| void | deleteAndRelease(string $queue, RedisJob $job, int $delay) Удалить зарезервированную задачу из зарезервированной очереди и освободить её. | |
| string | getRandomId() Получить случайную строку ID. | |
| string | getQueue(string|null $queue) Получить очередь или вернуть значение по умолчанию. | |
| Connection | getConnection() Получить подключение к очереди. | |
| Factory | getRedis() Получить базовый экземпляр Redis. |
Details
protected int secondsUntil(DateTimeInterface|DateInterval|int $delay)
Получить количество секунд до указанной даты DateTime.
protected int availableAt(DateTimeInterface|DateInterval|int $delay)
Получить метку времени «доступно в» в формате UNIX.
protected DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)
Если заданное значение является интервалом, преобразовать его в объект DateTime.
protected int currentTime()
Получить текущее системное время в формате UNIX timestamp.
mixed pushOn(string $queue, string $job, mixed $data = '')
Добавить новую задачу в очередь.
mixed laterOn(string $queue, DateTimeInterface|DateInterval|int $delay, string $job, mixed $data = '')
Добавить новую задачу в очередь с задержкой.
mixed bulk(array $jobs, mixed $data = '', string $queue = null)
Добавить массив задач в очередь.
protected string createPayload(string $job, mixed $data = '')
Создать строку полезной нагрузки из заданной задачи и данных.
protected array createPayloadArray(string $job, mixed $data = '')
Создать строку полезной нагрузки из заданной задачи и данных.
protected array createObjectPayload(mixed $job)
Создать полезную нагрузку для обработчика очереди на основе объектов.
protected string getDisplayName(mixed $job)
Получить имя для отображения данной задачи.
mixed getJobExpiration(mixed $job)
Получить метку времени истечения срока действия задачи для обработчика очереди на основе объектов.
protected array createStringPayload(string $job, mixed $data)
Создать типичный массив полезной нагрузки очереди на основе строк.
string getConnectionName()
Получить имя соединения для очереди.
$this setConnectionName(string $name)
Установить имя соединения для очереди.
void setContainer(Container $container)
Установить экземпляр контейнера IoC.
void __construct(Factory $redis, string $default = 'default', string $connection = null, int $retryAfter = 60)
Создать новый экземпляр очереди Redis.
int size(string $queue = null)
Получить размер очереди.
mixed push(string|object $job, mixed $data = '', string $queue = null)
Добавить новую задачу в очередь.
mixed pushRaw(string $payload, string $queue = null, array $options = [])
Отправить сырое содержимое в очередь.
mixed later(DateTimeInterface|DateInterval|int $delay, string|object $job, mixed $data = '', string $queue = null)
Отправить новую задачу в очередь с задержкой.
protected mixed laterRaw(DateTimeInterface|DateInterval|int $delay, string $payload, string $queue = null)
Отправить сырую задачу в очередь с задержкой.
Job|null pop(string $queue = null)
Извлечь следующую задачу из очереди.
protected void migrate(string $queue)
Переместить отложенные или истекшие задачи в основную очередь.
array migrateExpiredJobs(string $from, string $to)
Переместить задачи с задержкой, готовые к выполнению, в обычную очередь.
protected array retrieveNextJob(string $queue)
Получить следующую задачу из очереди.
void deleteReserved(string $queue, RedisJob $job)
Удалить зарезервированную задачу из очереди.
void deleteAndRelease(string $queue, RedisJob $job, int $delay)
Удалить зарезервированную задачу из очереди и отпустить её.
protected string getRandomId()
Получить случайный идентификатор.
string getQueue(string|null $queue)
Получить очередь или вернуть значение по умолчанию.
protected Connection getConnection()
Получить соединение для очереди.
Factory getRedis()
Получить базовый экземпляр Redis.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.5/Illuminate/Queue/RedisQueue.html
