SqsQueue
класс SqsQueue расширяет Queue и реализует Queue, ClearableQueue (Посмотреть исходный код)
Трейты
| InteractsWithTime |
Свойства
| protected Container | $container | Экземпляр контейнера IoC. | из Queue |
| protected string | $connectionName | Имя подключения для очереди. | из Queue |
| protected bool | $dispatchAfterCommit | Указывает, что задачи должны быть отправлены после того, как все транзакции базы данных будут завершены. | из Queue |
| static protected callable[] | $createPayloadCallbacks | Обработчики создания полезной нагрузки. | из Queue |
| protected SqsClient | $sqs | Экземпляр Amazon SQS. | |
| protected string | $default | Имя очереди по умолчанию. | |
| protected string | $prefix | Префикс URL очереди. | |
| protected string | $suffix | Суффикс имени очереди. |
Методы
| int | secondsUntil(DateTimeInterface|DateInterval|int $delay)
Получить количество секунд до указанной даты DateTime. | from InteractsWithTime |
| int | availableAt(DateTimeInterface|DateInterval|int $delay = 0)
Получить отметку времени «доступно в» в формате UNIX timestamp. | from InteractsWithTime |
| DateTimeInterface|int | parseDateInterval(DateTimeInterface|DateInterval|int $delay)
Если заданное значение является интервалом, преобразовать его в экземпляр DateTime. | from InteractsWithTime |
| int | currentTime()
Получить текущее системное время в формате UNIX timestamp. | 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 = '')
Создать массив загрузки из заданной задачи и данных. | from Queue |
| 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 $queue, DateTimeInterface|DateInterval|int|null $delay, callable $callback)
Добавить задачу в очередь с использованием заданного обратного вызова. | from Queue |
| bool | shouldDispatchAfterCommit(Closure|string|object $job)
Определить, должна ли задача запускаться после завершения всех операций базы данных. | from Queue |
| void | raiseJobQueueingEvent(Closure|string|object $job, string $payload)
Вызвать событие очереди добавления задачи. | from Queue |
| void | raiseJobQueuedEvent(string|int|null $jobId, Closure|string|object $job, string $payload)
Вызвать событие задачи, помещенной в очередь. | 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(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)
Получить очередь или вернуть значение по умолчанию. | |
| string | suffixQueue(string $queue, string $suffix = '')
Добавить заданный суффикс к имени очереди. | |
| SqsClient | getSqs()
Получить базовый экземпляр SQS. |
Подробности
protected int secondsUntil(DateTimeInterface|DateInterval|int $delay)
Получить количество секунд до заданной даты и времени.
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 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 $queue, DateTimeInterface|DateInterval|int|null $delay, callable $callback)
Добавить задачу в очередь с помощью указанного обратного вызова.
protected bool shouldDispatchAfterCommit(Closure|string|object $job)
Определить, следует ли выполнить задачу после подтверждения всех транзакций базы данных.
protected void raiseJobQueueingEvent(Closure|string|object $job, string $payload)
Вызвать событие очереди задач.
protected void raiseJobQueuedEvent(string|int|null $jobId, Closure|string|object $job, string $payload)
Вызвать событие задачи в очереди.
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) секунд.
Задание|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/10.x/Illuminate/Queue/SqsQueue.html
