BeanstalkdQueue

class BeanstalkdQueue extends Queue implements Queue (View source)

Свойства

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

Свойства

InteractsWithTime

Методы

int

secondsUntil(DateTimeInterface $delay)

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

из InteractsWithTime

int

availableAt(DateTimeInterface|int $delay)

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

из InteractsWithTime

int

currentTime()

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

из InteractsWithTime

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

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

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

из Queue

array

createObjectPayload(mixed $job)

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

из Queue

string

getDisplayName(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(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.

Подробности

protected int secondsUntil(DateTimeInterface $delay)

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

Параметры

DateTimeInterface

$delay

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

int

protected int availableAt(DateTimeInterface|int $delay)

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

Параметры

DateTimeInterface|int

$delay

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

int

protected int currentTime()

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

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

int

END_OF_DOCUMENT_MARKER

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

Исключения

InvalidPayloadException

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

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

Параметры

string	$job
mixed	$data
string	$queue

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

array

protected array createObjectPayload(mixed $job)

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

Параметры

mixed

$job

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

array

protected string getDisplayName(mixed $job)

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

Параметры

mixed

$job

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

string

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(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

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

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

Параметры

string

$queue

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

Задача|null

void deleteMessage(string $queue, string $id)

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

Параметры

string	$queue
string	$id

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

void

string getQueue(string|null $queue)

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

Параметры

string|null

$queue

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

string

END_OF_DOCUMENT_MARKER

Pheanstalk getPheanstalk()

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

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

Pheanstalk

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