SqsQueue

class SqsQueue extends Очередь implements Очередь (Просмотреть исходный код)

Свойства

protected Контейнер	$container	Экземпляр контейнера IoC.	из Очередь
protected Шифрование	$encrypter	Реализация шифрования.	из Очередь
protected SqsClient	$sqs	Экземпляр Amazon SQS.
protected string	$default	Имя стандартной очереди.
protected string	$prefix	Префикс URL sqs.

Методы

mixed

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

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

из Очередь

mixed

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

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

из Очередь

mixed

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

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

из Очередь

string

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

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

из Очередь

array

createPlainPayload(string $job, mixed $data)

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

из Очередь

string

setMeta(string $payload, string $key, string $value)

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

из Очередь

int

getSeconds(DateTime|int $delay)

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

из Очередь

int

getTime()

Получить текущую метку времени Unix.

из Очередь

void

setContainer(Контейнер $container)

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

из Очередь

void

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

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

int

size(string $queue = null)

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

mixed

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

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

mixed

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

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

mixed

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

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

Задача|null

pop(string $queue = null)

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

string

getQueue(string|null $queue)

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

SqsClient

getSqs()

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

Подробное описание

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

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

Параметры

string	$queue
string	$job
mixed	$data

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

mixed

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

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

Параметры

string	$queue
DateTime\|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 $queue = null)

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

Параметры

string	$job
mixed	$data
string	$queue

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

string

Исключения

InvalidArgumentException

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

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

Параметры

string	$job
mixed	$data

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

array

protected string setMeta(string $payload, string $key, string $value)

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

Параметры

string	$payload
string	$key
string	$value

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

string

Исключения

InvalidArgumentException

protected int getSeconds(DateTime|int $delay)

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

Параметры

DateTime|int

$delay

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

int

protected int getTime()

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

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

int

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 $job, mixed $data = '', string $queue = null)

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

Параметры

string	$job
mixed	$data
string	$queue

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

mixed

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

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

Параметры

string	$payload
string	$queue
array	$options

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

mixed

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

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

Параметры

DateTime\|int	$delay
string	$job
mixed	$data
string	$queue

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

mixed

Job|null pop(string $queue = null)

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

Параметры

string

$queue

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

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