RedisQueue
class RedisQueue extends Очередь implements Очередь, Очередь с очисткой (Просмотреть исходный код)
Трейты
| Взаимодействие со временем |
Свойства
| protected Контейнер | $container | Экземпляр контейнера IoC. | из Очередь |
| protected string | $connectionName | Имя подключения для очереди. | из Очередь |
| protected bool | $dispatchAfterCommit | Указывает, что задачи должны быть отправлены после завершения всех транзакций базы данных. | из Очередь |
| static protected callable[] | $createPayloadCallbacks | Обработчики создания полезной нагрузки. | из Очередь |
| protected Фабрика | $redis | Реализация фабрики Redis. | |
| protected string | $connection | Имя подключения. | |
| protected string | $default | Имя очереди по умолчанию. | |
| protected int|null | $retryAfter | Время истечения срока действия задачи. | |
| protected int|null | $blockFor | Максимальное время в секундах для ожидания задачи. | |
| protected int | $migrationBatchSize | Размер пакета, используемый при миграции отложенных/просроченных задач в основную очередь. |
Методы
| int | secondsUntil(DateTimeInterface|DateInterval|int $delay)
Получить количество секунд до указанной даты и времени. | 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 |
| string | runTimeForHumans(float $startTime, float $endTime = null)
Учитывая начальное время, отформатируйте общее время выполнения для удобства чтения человеком. | from InteractsWithTime |
| mixed | pushOn(string $queue, string $job, mixed $data = '')
Добавить новую задачу в очередь. | from Queue |
| mixed | laterOn(string $queue, DateTimeInterface|DateInterval|int $delay, string $job, mixed $data = '')
Добавить новую задачу в определенную очередь через (n) секунд. | 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 | getJobTries(mixed $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|null $queue, DateTimeInterface|DateInterval|int|null $delay, callable $callback)
Поместить задачу в очередь с помощью заданного обратного вызова. | from Queue |
| bool | shouldDispatchAfterCommit(Closure|string|object $job)
Определить, следует ли отправлять задачу после подтверждения всех транзакций базы данных. | from Queue |
| void | raiseJobQueueingEvent(string $queue, Closure|string|object $job, string $payload, DateTimeInterface|DateInterval|int|null $delay)
Поднять событие постановки задачи в очередь. | from Queue |
| void | raiseJobQueuedEvent(string|null $queue, string|int|null $jobId, Closure|string|object $job, string $payload, DateTimeInterface|DateInterval|int|null $delay)
Поднять событие добавления задачи в очередь. | 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, int $migrationBatchSize = -1)
Создать новый экземпляр очереди 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()
Получить случайную строку идентификатора. | |
| 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)
Получить отметку времени "доступно в" в формате Unix timestamp.
protected DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)
Если заданное значение является интервалом, преобразовать его в экземпляр DateTime.
protected int currentTime()
Получить текущее системное время в формате Unix timestamp.
protected string runTimeForHumans(float $startTime, float $endTime = null)
Исходя из начального времени, отформатировать общее время выполнения для удобного чтения человеком.
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 getJobTries(mixed $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|null $queue, DateTimeInterface|DateInterval|int|null $delay, callable $callback)
Добавить работу в очередь с использованием заданного обратного вызова.
protected bool shouldDispatchAfterCommit(Closure|string|object $job)
Определить, должна ли работа быть запущена после завершения всех баз данных транзакций.
protected void raiseJobQueueingEvent(string $queue, Closure|string|object $job, string $payload, DateTimeInterface|DateInterval|int|null $delay)
Вызвать событие добавления работы в очередь.
protected void raiseJobQueuedEvent(string|null $queue, string|int|null $jobId, Closure|string|object $job, string $payload, DateTimeInterface|DateInterval|int|null $delay)
Вызвать событие размещения работы в очереди.
string getConnectionName()
Получить имя подключения для очереди.
$this setConnectionName(string $name)
Установите имя подключения для очереди.
Контейнер getContainer()
Получить экземпляр контейнера, используемый подключением.
void setContainer(Контейнер $container)
Установить экземпляр контейнера IoC.
void __construct(Factory $redis, string $default = 'default', string|null $connection = null, int $retryAfter = 60, int|null $blockFor = null, bool $dispatchAfterCommit = false, int $migrationBatchSize = -1)
Создать новый экземпляр очереди 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)
Добавить сырую задачу в очередь с задержкой (n секунд).
Задача|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()
Получить случайную строку ID.
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/11.x/Illuminate/Queue/RedisQueue.html
