RedisQueue
класс RedisQueue расширяет Queue и реализует Queue, ClearableQueue (Посмотреть исходный код)
Трейты
| InteractsWithTime |
Свойства
| protected Container | $container | Экземпляр контейнера IoC. | из Queue |
| protected string | $connectionName | Имя подключения для очереди. | из Queue |
| protected | $dispatchAfterCommit | Указывает, что задачи должны быть отправлены после завершения всех транзакций базы данных. | из Queue |
| static protected callable[] | $createPayloadCallbacks | Обратные вызовы для создания полезной нагрузки. | из Queue |
| protected Factory | $redis | Реализация фабрики Redis. | |
| protected string | $connection | Имя подключения. | |
| protected string | $default | Имя очереди по умолчанию. | |
| protected int|null | $retryAfter | Время ожидания задачи. | |
| protected int|null | $blockFor | Максимальное время ожидания задачи в секундах. |
Методы
| int | secondsUntil(DateTimeInterface|DateInterval|int $delay)
Получить количество секунд до указанного DateTime. | from InteractsWithTime |
| int | availableAt(DateTimeInterface|DateInterval|int $delay = 0)
Получить метку времени UNIX "доступно в". | 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 |
| void | bulk(array $jobs, mixed $data = '', string|null $queue = null)
Поместить массив задач в очередь. | |
| string | createPayload(Closure|string|object $job, string $queue, mixed $data = '')
Создать строку полезной нагрузки из заданной задачи и данных. | from Queue |
| array | createPayloadArray(string|object $job, string $queue, mixed $data = '')
Создать строку полезной нагрузки из заданной задачи и данных. | |
| array | createObjectPayload(object $job, string $queue)
Создать полезную нагрузку для обработчика очереди на основе объекта. | from Queue |
| string | getDisplayName(object $job)
Получить отображаемое имя для данной задачи. | from Queue |
| mixed | getJobBackoff(mixed $job)
Получить задержку для обработчика очереди на основе объекта. | from Queue |
| mixed | getJobExpiration(mixed $job)
Получить метку времени истечения срока действия для обработчика очереди на основе объекта. | from Queue |
| bool | jobShouldBeEncrypted(object $job)
Определить, следует ли шифровать задачу. | from Queue |
| array | createStringPayload(string $job, string $queue, mixed $data)
Создать типичный массив полезной нагрузки очереди на основе строки. | from Queue |
| static void | createPayloadUsing(callable|null $callback)
Зарегистрировать обратный вызов, который будет выполнен при создании полезных нагрузок заданий. | from Queue |
| array | withCreatePayloadHooks(string $queue, array $payload)
Создать заданную полезную нагрузку, используя любые зарегистрированные хуки полезной нагрузки. | from Queue |
| mixed | enqueueUsing(Closure|string|object $job, string $payload, string $queue, DateTimeInterface|DateInterval|int|null $delay, callable $callback)
Поместить задачу в очередь, используя заданный обратный вызов. | from Queue |
| bool | shouldDispatchAfterCommit(Closure|string|object $job)
Определить, следует ли отправлять задачу после фиксации всех транзакций базы данных. | from Queue |
| void | raiseJobQueuedEvent(string|int|null $jobId, Closure|string|object $job)
Вызвать событие помещения задачи в очередь. | from Queue |
| string | getConnectionName()
Получить имя соединения для очереди. | from Queue |
| $this | setConnectionName(string $name)
Установить имя соединения для очереди. | from Queue |
| Container | getContainer()
Получить экземпляр контейнера, используемый соединением. | from Queue |
| void | setContainer(Container $container)
Установить экземпляр контейнера IoC. | from Queue |
| void | __construct(Factory $redis, string $default = 'default', string|null $connection = null, int $retryAfter = 60, int|null $blockFor = null, bool $dispatchAfterCommit = false)
Создать новый экземпляр очереди 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|null $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)
Удалить зарезервированное задание из зарезервированной очереди и освободить его. | |
| int | clear(string $queue)
Удалить все задания из очереди. | |
| string | getRandomId()
Получить случайную строку ID. | |
| string | getQueue(string|null $queue)
Получить очередь или вернуть значение по умолчанию. | |
| Connection | getConnection()
Получить подключение для очереди. | |
| Factory | getRedis()
Получить базовый экземпляр Redis. |
Details
protected int secondsUntil(DateTimeInterface|DateInterval|int $delay)
Получить количество секунд до указанной даты и времени.
protected int availableAt(DateTimeInterface|DateInterval|int $delay = 0)
Получить метку времени «доступно в».
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(Closure|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 getJobBackoff(mixed $job)
Получить задержку для обработчика очереди на основе объектов.
mixed getJobExpiration(mixed $job)
Получить отметку времени истечения срока действия для обработчика очереди на основе объектов.
protected bool jobShouldBeEncrypted(object $job)
Определить, должно ли задание быть зашифровано.
protected array createStringPayload(string $job, string $queue, mixed $data)
Создать массив типичного полезного содержимого очереди на основе строк.
static void createPayloadUsing(callable|null $callback)
Зарегистрировать обратный вызов, который будет выполняться при создании полезного содержимого задания.
protected array withCreatePayloadHooks(string $queue, array $payload)
Создать заданное полезное содержимое с использованием любых зарегистрированных хуков полезного содержимого.
protected mixed enqueueUsing(Closure|string|object $job, string $payload, string $queue, DateTimeInterface|DateInterval|int|null $delay, callable $callback)
Добавить задание в очередь с использованием заданного обратного вызова.
protected bool shouldDispatchAfterCommit(Closure|string|object $job)
Определить, должно ли задание быть отправлено после завершения всех транзакций базы данных.
protected void raiseJobQueuedEvent(string|int|null $jobId, Closure|string|object $job)
Вызвать событие о добавлении задания в очередь.
string getConnectionName()
Получить имя подключения для очереди.
$this setConnectionName(string $name)
Установить имя подключения для очереди.
Container getContainer()
Получить экземпляр контейнера, используемый подключением.
void setContainer(Container $container)
Установить экземпляр контейнера IoC.
void __construct(Factory $redis, string $default = 'default', string|null $connection = null, int $retryAfter = 60, int|null $blockFor = null, bool $dispatchAfterCommit = false)
Создать новый экземпляр очереди 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)
Отправить новую задачу в очередь с задержкой.
protected mixed laterRaw(DateTimeInterface|DateInterval|int $delay, string $payload, string|null $queue = null)
Отправить сырую задачу в очередь с задержкой.
Job|null pop(string|null $queue = null)
Извлечь следующую задачу из очереди.
protected void migrate(string $queue)
Перенести отложенные или истекшие задачи в основную очередь.
array migrateExpiredJobs(string $from, string $to)
Перенести отложенные задачи, готовые к выполнению, в обычную очередь.
protected array retrieveNextJob(string $queue, bool $block = true)
Получить следующую задачу из очереди.
void deleteReserved(string $queue, RedisJob $job)
Удалить зарезервированную задачу из очереди.
void deleteAndRelease(string $queue, RedisJob $job, int $delay)
Удалить зарезервированную задачу из очереди и освободить её.
int clear(string $queue)
Удалить все задачи из очереди.
protected string getRandomId()
Получить случайный идентификатор.
string getQueue(string|null $queue)
Получить очередь или вернуть значение по умолчанию.
Connection getConnection()
Получить соединение для очереди.
Factory getRedis()
Получить базовый экземпляр Redis.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/8.x/Illuminate/Queue/RedisQueue.html
