SqsQueue

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

Черты

Свойства

protected Container	$container	Экземпляр контейнера IoC.	из Queue
protected Encrypter	$encrypter	Реализация шифрования.	из Queue
protected string	$connectionName	Имя соединения для очереди.	из Queue
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)

Получить метку времени 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, mixed $data = '')

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

из Queue

array

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

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

из Queue

array

createObjectPayload(mixed $job)

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

из Queue

string

getDisplayName(mixed $job)

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

из Queue

mixed

getJobExpiration(mixed $job)

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

из Queue

array

createStringPayload(string $job, mixed $data)

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

из 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.

Параметры

DateTimeInterface|DateInterval|int

$delay

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

int

END_OF_DOCUMENT_MARKER

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

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

Параметры

DateTimeInterface|DateInterval|int

$delay

Значение возврата

int

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

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

Параметры

DateTimeInterface|DateInterval|int

$delay

Значение возврата

DateTimeInterface|int

protected int currentTime()

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

Значение возврата

int

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

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

Параметры

string	$queue
string	$job
mixed	$data

Значение возврата

mixed

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

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

Параметры

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

Значение возврата

mixed

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

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

Параметры

array	$jobs
mixed	$data
string	$queue

Значение возврата

mixed

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

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

Параметры

string	$job
mixed	$data

Значение возврата

string

Исключения

InvalidPayloadException

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

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

Параметры

string	$job
mixed	$data

Значение возврата

array

protected array createObjectPayload(mixed $job)

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

Параметры

mixed

$job

Значение возврата

array

protected string getDisplayName(mixed $job)

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

Параметры

mixed

$job

Значение возврата

string

mixed getJobExpiration(mixed $job)

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

Параметры

mixed

$job

Значение возврата

mixed

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

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

Параметры

string	$job
mixed	$data

Значение возврата

array

string getConnectionName()

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

Значение возврата

string

$this setConnectionName(string $name)

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

Параметры

string

$name

Значение возврата

$this

void setContainer(Container $container)

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

Параметры

Container

$container

Значение возврата

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