SqsQueue

класс SqsQueue расширяет Queue и реализует Queue (Посмотреть исходный код)

Свойства

protected Container	$container	Экземпляр контейнера IoC.	из Queue
protected string	$connectionName	Имя подключения для очереди.	из Queue
static protected callable[]	$createPayloadCallbacks	Обработчики создания полезной нагрузки.	из Queue
protected SqsClient	$sqs	Экземпляр Amazon SQS.
protected string	$default	Название очереди по умолчанию.
protected string	$prefix	Префикс URL очереди.

Методы

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)

Добавить массив задач в очередь.

from Queue

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

getJobRetryDelay(mixed $job)

Получить задержку повтора для обработчика очереди на основе объекта.

from Queue

mixed

getJobExpiration(mixed $job)

Получить метку времени истечения срока действия для обработчика очереди на основе объекта.

from Queue

array

createStringPayload(string $job, string $queue, mixed $data)

Создать типичный массив полезной нагрузки очереди на основе строки.

from Queue

static void

createPayloadUsing(callable $callback)

Зарегистрировать обратный вызов, который будет выполнен при создании полезных нагрузок заданий.

from Queue

array

withCreatePayloadHooks(string $queue, array $payload)

Создать заданную полезную нагрузку с использованием любых зарегистрированных хуков полезной нагрузки.

from Queue

string

getConnectionName()

Получить имя соединения для очереди.

from Queue

$this

setConnectionName(string $name)

Установить имя соединения для очереди.

from Queue

void

setContainer(Container $container)

Установить экземпляр контейнера IoC.

from Queue

void

__construct(SqsClient $sqs, string $default, string $prefix = '', string $suffix = '')

Создать новый экземпляр очереди 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)

Добавить новую задачу в очередь через некоторое время.

Job|null

pop(string|null $queue = null)

Извлечь следующую задачу из очереди.

string

getQueue(string|null $queue)

Получить очередь или вернуть значение по умолчанию.

SqsClient

getSqs()

Получить основной экземпляр SQS.

Подробности

protected int secondsUntil(DateTimeInterface|DateInterval|int $delay)

Получить количество секунд до заданного DateTime.

Параметры

DateTimeInterface|DateInterval|int

$delay

Возвращаемое значение

int

protected int availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Получить метку времени UNIX "доступно в".

Параметры

DateTimeInterface|DateInterval|int

$delay

Возвращаемое значение

int

END_OF_DOCUMENT_MARKER

protected DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)

Если заданное значение является интервалом, преобразуйте его в экземпляр DateTime.

Parameters

DateTimeInterface|DateInterval|int

$delay

Return Value

DateTimeInterface|int

protected int currentTime()

Получить текущее системное время в формате отметки UNIX.

Return Value

int

mixed pushOn(string $queue, string $job, mixed $data = '')

Добавить новую задачу в очередь.

Parameters

string	$queue
string	$job
mixed	$data

Return Value

mixed

mixed laterOn(string $queue, DateTimeInterface|DateInterval|int $delay, string $job, mixed $data = '')

Добавить новую задачу в очередь с задержкой.

Parameters

string	$queue
DateTimeInterface\|DateInterval\|int	$delay
string	$job
mixed	$data

Return Value

mixed

void bulk(array $jobs, mixed $data = '', string|null $queue = null)

Добавить массив задач в очередь.

Parameters

array	$jobs
mixed	$data
string\|null	$queue

Return Value

void

protected string createPayload(Closure|string|object $job, string $queue, mixed $data = '')

Создать строку полезной нагрузки из заданной задачи и данных.

Parameters

Closure\|string\|object	$job
string	$queue
mixed	$data

Return Value

string

Exceptions

InvalidPayloadException

protected array createPayloadArray(string|object $job, string $queue, mixed $data = '')

Создать массив полезной нагрузки из заданной задачи и данных.

Parameters

string\|object	$job
string	$queue
mixed	$data

Return Value

array

protected array createObjectPayload(object $job, string $queue)

Создать полезную нагрузку для обработчика очереди на основе объекта.

Parameters

object	$job
string	$queue

Return Value

array

protected string getDisplayName(object $job)

Получить имя для отображения заданной задачи.

Parameters

object

$job

Return Value

string

mixed getJobRetryDelay(mixed $job)

Получить задержку повторной попытки для обработчика очереди на основе объекта.

Parameters

mixed

$job

Return Value

mixed

mixed getJobExpiration(mixed $job)

Получить отметку времени истечения срока действия для обработчика очереди на основе объекта.

Parameters

mixed

$job

Return Value

mixed

protected array createStringPayload(string $job, string $queue, mixed $data)

Создать массив типичной полезной нагрузки для очереди на основе строки.

Parameters

string	$job
string	$queue
mixed	$data

Return Value

array

static void createPayloadUsing(callable $callback)

Зарегистрировать вызов, который будет выполнен при создании полезной нагрузки задачи.

Parameters

callable

$callback

Return Value

void

protected array withCreatePayloadHooks(string $queue, array $payload)

Создать заданную полезную нагрузку с помощью любых зарегистрированных хуков полезной нагрузки.

Parameters

string	$queue
array	$payload

Return Value

array

string getConnectionName()

Получить имя подключения для очереди.

Return Value

string

$this setConnectionName(string $name)

Установить имя подключения для очереди.

Parameters

string

$name

Return Value

$this

void setContainer(Container $container)

Установить экземпляр контейнера IoC.

Parameters

Container

$container

Return Value

void

void __construct(SqsClient $sqs, string $default, string $prefix = '', string $suffix = '')

Создать новый экземпляр очереди Amazon SQS.

Parameters

SqsClient	$sqs
string	$default
string	$prefix
string	$suffix

Return Value

void

int size(string|null $queue = null)

Получить размер очереди.

Параметры

string|null

$queue

Возвращаемое значение

int

mixed push(string|object $job, mixed $data = '', string|null $queue = null)

Добавить новую задачу в очередь.

Параметры

string\|object	$job
mixed	$data
string\|null	$queue

Возвращаемое значение

mixed

mixed pushRaw(string $payload, string|null $queue = null, array $options = [])

Добавить сырые данные в очередь.

Параметры

string	$payload
string\|null	$queue
array	$options

Возвращаемое значение

mixed

mixed later(DateTimeInterface|DateInterval|int $delay, string|object $job, mixed $data = '', string|null $queue = null)

Добавить новую задачу в очередь с задержкой.

Параметры

DateTimeInterface\|DateInterval\|int	$delay
string\|object	$job
mixed	$data
string\|null	$queue

Возвращаемое значение

mixed

Задача|null pop(string|null $queue = null)

Извлечь следующую задачу из очереди.

Параметры

string|null

$queue

Возвращаемое значение

Задача|null

string getQueue(string|null $queue)

Получить очередь или вернуть значение по умолчанию.

Параметры

string|null

$queue

Возвращаемое значение

string

SqsClient getSqs()

Получить базовую инстанцию SQS.

Возвращаемое значение

SqsClient

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/7.x/Illuminate/Queue/SqsQueue.html