SqsQueue
class SqsQueue extends Очередь implements Очередь, Очередь с очисткой (Просмотреть исходный код)
Трейты
| Взаимодействует со временем |
Свойства
| protected Контейнер | $container | Экземпляр контейнера IoC. | из Очередь |
| protected string | $connectionName | Имя подключения для очереди. | из Очередь |
| protected | $dispatchAfterCommit | Указывает, что задачи должны быть отправлены после завершения всех транзакций базы данных. | из Очередь |
| static protected callable[] | $createPayloadCallbacks | Обработчики создания полезной нагрузки. | из Очередь |
| protected SqsClient | $sqs | Экземпляр Amazon SQS. | |
| protected string | $default | Имя очереди по умолчанию. | |
| protected string | $prefix | Префикс URL очереди. |
Методы
| 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 timestamp. | из InteractsWithTime |
| mixed | pushOn(string $queue, string $job, mixed $data = '')
Добавить новую задачу в очередь. | из Queue |
| mixed | laterOn(string $queue, DateTimeInterface|DateInterval|int $delay, string $job, mixed $data = '')
Добавить новую задачу в определённую очередь через (n) секунд. | из Queue |
| void | bulk(array $jobs, mixed $data = '', string|null $queue = null)
Добавить массив задач в очередь. | |
| string | createPayload(Closure|string|object $job, string $queue, mixed $data = '')
Создать строку полезной нагрузки из заданной задачи и данных. | из Queue |
| array | createPayloadArray(string|object $job, string $queue, mixed $data = '')
Создать массив полезной нагрузки из заданной задачи и данных. | из Queue |
| array | createObjectPayload(object $job, string $queue)
Создать полезную нагрузку для обработчика очереди на основе объектов. | из Queue |
| string | getDisplayName(object $job)
Получить отображаемое имя для заданной задачи. | из Queue |
| mixed | getJobBackoff(mixed $job)
Получить отложенную обработку для обработчика очереди на основе объектов. | из Queue |
| mixed | getJobExpiration(mixed $job)
Получить отметку времени истечения срока действия для обработчика очереди на основе объектов. | из Queue |
| bool | jobShouldBeEncrypted(object $job)
Определить, должна ли задача быть зашифрована. | из Queue |
| array | createStringPayload(string $job, string $queue, mixed $data)
Создать типичный массив полезной нагрузки очереди на основе строк. | из Queue |
| static void | createPayloadUsing(callable|null $callback)
Зарегистрировать обратный вызов, который будет выполнен при создании полезной нагрузки задачи. | из Queue |
| array | withCreatePayloadHooks(string $queue, array $payload)
Создать заданную полезную нагрузку с использованием любых зарегистрированных хуков полезной нагрузки. | из Queue |
| mixed | enqueueUsing(Closure|string|object $job, string $payload, string $queue, DateTimeInterface|DateInterval|int|null $delay, callable $callback)
Добавить задачу в очередь, используя указанный обратный вызов. | из Queue |
| bool | shouldDispatchAfterCommit(Closure|string|object $job)
Определить, должна ли задача быть отправлена после завершения всех баз данных транзакций. | из Queue |
| void | raiseJobQueuedEvent(string|int|null $jobId, Closure|string|object $job)
Вызвать событие задачи, помещённой в очередь. | из Queue |
| string | getConnectionName()
Получить имя подключения для очереди. | из Queue |
| $this | setConnectionName(string $name)
Установить имя подключения для очереди. | из Queue |
| Container | getContainer()
Получить экземпляр контейнера, используемый подключением. | из Queue |
| void | setContainer(Container $container)
Установить экземпляр контейнера IoC. | из Queue |
| void | __construct(SqsClient $sqs, string $default, string $prefix = '', string $suffix = '', bool $dispatchAfterCommit = false)
Создать новый экземпляр очереди Amazon SQS. | |
| 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)
Добавить новую задачу в очередь через (n) секунд. |
| Задача|null | pop(string|null $queue = null)
Извлечь следующую задачу из очереди. | |
| int | clear(string $queue)
Удалить все задачи из очереди. | |
| string | getQueue(string|null $queue)
Получить очередь или вернуть значение по умолчанию. | |
| string | suffixQueue(string $queue, string $suffix = '')
Добавить заданный суффикс к имени очереди. | |
| SqsClient | getSqs()
Получить базовый экземпляр SQS. |
Подробности
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 = '')
Добавить новую задачу в определенную очередь через (n) секунд.
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(SqsClient $sqs, string $default, string $prefix = '', string $suffix = '', bool $dispatchAfterCommit = false)
Создать новый экземпляр очереди Amazon SQS.
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)
Добавить новое задание в очередь через (n) секунд.
Job|null pop(string|null $queue = null)
Извлечь следующее задание из очереди.
int clear(string $queue)
Удалить все задания из очереди.
string getQueue(string|null $queue)
Получить очередь или вернуть значение по умолчанию.
protected string suffixQueue(string $queue, string $suffix = '')
Добавить заданный суффикс к заданному имени очереди.
SqsClient getSqs()
Получить базовый экземпляр SQS.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/9.x/Illuminate/Queue/SqsQueue.html
