SqsQueue

класс SqsQueue расширяет Queue реализует Queue (View source)

Черты

Свойства

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

Методы

int

secondsUntil(DateTimeInterface|DateInterval|int $delay)

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

из InteractsWithTime

int

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

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

из InteractsWithTime

DateTimeInterface|int

parseDateInterval(DateTimeInterface|DateInterval|int $delay)

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

из InteractsWithTime

int

currentTime()

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

из InteractsWithTime

mixed

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

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

из Queue

mixed

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

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

из Queue

mixed

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

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

из Queue

string

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

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

из Queue

array

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

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

из Queue

array

createObjectPayload(mixed $job, string $queue)

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

из Queue

string

getDisplayName(mixed $job)

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

из Queue

mixed

getJobExpiration(mixed $job)

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

из Queue

array

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

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

из Queue

static void

createPayloadUsing(callable $callback)

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

из Queue

array

withCreatePayloadHooks(string $queue, array $payload)

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

из Queue

string

getConnectionName()

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

из Queue

$this

setConnectionName(string $name)

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

из Queue

void

setContainer(Container $container)

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

из Queue

void

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

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

int

size(string $queue = null)

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

mixed

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

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

mixed

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

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

mixed

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

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

Job|null

pop(string $queue = null)

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

string

getQueue(string|null $queue)

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

SqsClient

getSqs()

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

Подробности

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

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

Parameters

DateTimeInterface|DateInterval|int

$delay

Return Value

int

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

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

Parameters

DateTimeInterface|DateInterval|int

$delay

Return Value

int

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

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

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

Parameters

array	$jobs
mixed	$data
string	$queue

Return Value

mixed

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

Создать строку-платёж из заданной работы и данных.

Parameters

string	$job
string	$queue
mixed	$data

Return Value

string

Exceptions

InvalidPayloadException

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

Создать массив платёжей из заданной работы и данных.

Parameters

mixed	$job
string	$queue
mixed	$data

Return Value

array

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

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

Parameters

mixed	$job
string	$queue

Return Value

array

protected string getDisplayName(mixed $job)

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

Parameters

mixed

$job

Return Value

string

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 = '')

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

Параметры

SqsClient	$sqs
string	$default
string	$prefix

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

void

int size(string $queue = null)

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

Параметры

string

$queue

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

int

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

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

Параметры

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

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

mixed

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

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

Параметры

string	$payload
string	$queue
array	$options

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

mixed

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

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

Параметры

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

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

mixed

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

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

Параметры

string

$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/5.7/Illuminate/Queue/SqsQueue.html