BeanstalkdQueue

class BeanstalkdQueue extends Queue implements Queue (View source)

Свойства

protected Container	$container	Экземпляр контейнера IoC.	из Queue
protected Encrypter	$encrypter	Реализация шифрования.	из Queue
protected Pheanstalk	$pheanstalk	Экземпляр Pheanstalk.
protected string	$default	Имя стандартной очереди.
protected int	$timeToRun	Время выполнения для всех задач.

Методы

mixed

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

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

из Queue

mixed

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

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

из Queue

mixed

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

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

из Queue

string

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

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

из Queue

array

createPlainPayload(string $job, mixed $data)

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

из Queue

string

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

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

из Queue

int

getSeconds(DateTime|int $delay)

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

из Queue

int

getTime()

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

из Queue

void

setContainer(Container $container)

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

из Queue

void

__construct(Pheanstalk $pheanstalk, string $default, int $timeToRun)

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

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)

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

Job|null

pop(string $queue = null)

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

void

deleteMessage(string $queue, string $id)

Удалить сообщение из очереди Beanstalk.

string

getQueue(string|null $queue)

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

Pheanstalk

getPheanstalk()

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

Подробности

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(Pheanstalk $pheanstalk, string $default, int $timeToRun)

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

Параметры

Pheanstalk	$pheanstalk
string	$default
int	$timeToRun

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

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

void deleteMessage(string $queue, string $id)

Удалить сообщение из очереди Beanstalk.

Параметры

string	$queue
string	$id

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

void

string getQueue(string|null $queue)

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

Параметры

string|null

$queue

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

string

Pheanstalk getPheanstalk()

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

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

Pheanstalk

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