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