BeanstalkdQueue

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

Свойства

protected Контейнер	$container	Экземпляр контейнера IoC.	из Очереди
protected string	$connectionName	Имя подключения для очереди.	из Очереди
protected bool	$dispatchAfterCommit	Указывает, что задания должны быть отправлены после подтверждения всех транзакций базы данных.	из Очереди
static protected callable[]	$createPayloadCallbacks	Обработчики создания полезной нагрузки.	из Очереди
protected PheanstalkSubscriberInterface	$pheanstalk	Экземпляр Pheanstalk.
protected string	$default	Имя стандартного канала.
protected int	$timeToRun	Время выполнения для всех отправленных заданий.
protected int	$blockFor	Максимальное количество секунд ожидания задания.

Методы

int	secondsUntil(DateTimeInterface\|DateInterval\|int $delay) Получить количество секунд до заданного DateTime.	из InteractsWithTime
int	availableAt(DateTimeInterface\|DateInterval\|int $delay = 0) Получить метку времени UNIX «доступно в».	из InteractsWithTime
DateTimeInterface\|int	parseDateInterval(DateTimeInterface\|DateInterval\|int $delay) Если заданное значение является интервалом, преобразуйте его в экземпляр DateTime.	из InteractsWithTime
int	currentTime() Получить текущее системное время в виде метки времени UNIX.	из InteractsWithTime
string	runTimeForHumans(float $startTime, float $endTime = null) Учитывая начальное время, отформатируйте общее время выполнения для удобочитаемости человеком.	из InteractsWithTime
mixed	pushOn(string $queue, string $job, mixed $data = '') Добавить новую задачу в очередь.	из Queue
mixed	laterOn(string $queue, DateTimeInterface\|DateInterval\|int $delay, string $job, mixed $data = '') Добавить новую задачу в определенную очередь через (n) секунд.	из Queue
void	bulk(array $jobs, mixed $data = '', string\|null $queue = null) Добавить массив задач в очередь.
string	createPayload(Closure\|string\|object $job, string $queue, mixed $data = '') Создать строку полезной нагрузки из заданной задачи и данных.	из Queue
array	createPayloadArray(string\|object $job, string $queue, mixed $data = '') Создать массив полезной нагрузки из заданной задачи и данных.	из Queue
array	createObjectPayload(object $job, string $queue) Создать полезную нагрузку для обработчика очереди на основе объекта.	из Queue
string	getDisplayName(object $job) Получить отображаемое имя для заданной задачи.	из Queue
mixed	getJobTries(mixed $job) Получить максимальное количество попыток для обработчика очереди на основе объекта.	из Queue
mixed	getJobBackoff(mixed $job) Получить откат для обработчика очереди на основе объекта.	из Queue
mixed	getJobExpiration(mixed $job) Получить метку времени истечения срока действия для обработчика очереди на основе объекта.	из Queue
bool	jobShouldBeEncrypted(object $job) Определить, следует ли шифровать задачу.	из Queue
array	createStringPayload(string $job, string $queue, mixed $data) Создать типичный массив полезной нагрузки очереди на основе строки.	из Queue
static void	createPayloadUsing(callable\|null $callback) Зарегистрировать обратный вызов, который будет выполнен при создании полезных данных задания.	из Queue
array	withCreatePayloadHooks(string $queue, array $payload) Создать заданную полезную нагрузку, используя любые зарегистрированные хуки полезной нагрузки.	из Queue
mixed	enqueueUsing(Closure\|string\|object $job, string $payload, string\|null $queue, DateTimeInterface\|DateInterval\|int\|null $delay, callable $callback) Поместить задачу в очередь, используя заданный обратный вызов.	из Queue
bool	shouldDispatchAfterCommit(Closure\|string\|object $job) Определить, следует ли отправлять задачу после подтверждения всех транзакций базы данных.	из Queue
void	raiseJobQueueingEvent(string $queue, Closure\|string\|object $job, string $payload, DateTimeInterface\|DateInterval\|int\|null $delay) Вызвать событие постановки задачи в очередь.	из Queue
void	raiseJobQueuedEvent(string\|null $queue, string\|int\|null $jobId, Closure\|string\|object $job, string $payload, DateTimeInterface\|DateInterval\|int\|null $delay) Вызвать событие добавления задачи в очередь.	из Queue
string	getConnectionName() Получить имя соединения для очереди.	из Queue
$this	setConnectionName(string $name) Установить имя соединения для очереди.	из Queue
Container	getContainer() Получить экземпляр контейнера, используемый соединением.	из Queue
void	setContainer(Container $container) Установить экземпляр контейнера IoC.	из Queue

void	__construct(PheanstalkSubscriberInterface $pheanstalk, string $default, int $timeToRun, int $blockFor = 0, bool $dispatchAfterCommit = false) Создать новый экземпляр очереди Beanstalkd.
int	size(string\|null $queue = null) Получить размер очереди.
mixed	push(string\|object $job, mixed $data = '', string\|null $queue = null) Добавить новую задачу в очередь.
mixed	pushRaw(string $payload, string\|null $queue = null, array $options = []) Добавить сырой payload в очередь.
mixed	later(DateTimeInterface\|DateInterval\|int $delay, string\|object $job, mixed $data = '', string\|null $queue = null) Добавить новую задачу в очередь через (n) секунд.
Job\|null	pop(string\|null $queue = null) Извлечь следующую задачу из очереди.
void	deleteMessage(string $queue, string\|int $id) Удалить сообщение из очереди Beanstalk.
string	getQueue(string\|null $queue) Получить очередь или вернуть значение по умолчанию.
PheanstalkSubscriberInterface	getPheanstalk() Получить базовый экземпляр Pheanstalk.

Подробности

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

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

Параметры

DateTimeInterface|DateInterval|int

$delay

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

int

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

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

Параметры

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

protected string runTimeForHumans(float $startTime, float $endTime = null)

Учитывая начальное время, отформатировать общее время выполнения для удобочитаемости.

Параметры

float	$startTime
float	$endTime

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

string

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

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

Параметры

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

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

mixed

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

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

Параметры

array	$jobs
mixed	$data
string\|null	$queue

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

void

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

Создать строку payload из заданной задачи и данных.

Параметры

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

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

string

Исключения

InvalidPayloadException

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

Создать массив payload из заданной задачи и данных.

Параметры

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

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

array

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

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

Параметры

object	$job
string	$queue

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

array

protected string getDisplayName(object $job)

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

Параметры

object

$job

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

string

mixed getJobTries(mixed $job)

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

Parameters

mixed

$job

Return Value

mixed

mixed getJobBackoff(mixed $job)

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

Parameters

mixed

$job

Return Value

mixed

mixed getJobExpiration(mixed $job)

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

Parameters

mixed

$job

Return Value

mixed

protected bool jobShouldBeEncrypted(object $job)

Определить, следует ли шифровать задачу.

Parameters

object

$job

Return Value

bool

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

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

Parameters

string	$job
string	$queue
mixed	$data

Return Value

array

static void createPayloadUsing(callable|null $callback)

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

Parameters

callable|null

$callback

Return Value

void

protected array withCreatePayloadHooks(string $queue, array $payload)

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

Parameters

string	$queue
array	$payload

Return Value

array

protected mixed enqueueUsing(Closure|string|object $job, string $payload, string|null $queue, DateTimeInterface|DateInterval|int|null $delay, callable $callback)

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

Parameters

Closure\|string\|object	$job
string	$payload
string\|null	$queue
DateTimeInterface\|DateInterval\|int\|null	$delay
callable	$callback

Return Value

mixed

protected bool shouldDispatchAfterCommit(Closure|string|object $job)

Определить, следует ли запускать задачу после завершения всех транзакций базы данных.

Parameters

Closure|string|object

$job

Return Value

bool

protected void raiseJobQueueingEvent(string $queue, Closure|string|object $job, string $payload, DateTimeInterface|DateInterval|int|null $delay)

Вызвать событие очереди задач.

Parameters

string	$queue
Closure\|string\|object	$job
string	$payload
DateTimeInterface\|DateInterval\|int\|null	$delay

Return Value

void

protected void raiseJobQueuedEvent(string|null $queue, string|int|null $jobId, Closure|string|object $job, string $payload, DateTimeInterface|DateInterval|int|null $delay)

Вызвать событие о помещении задачи в очередь.

Parameters

string\|null	$queue
string\|int\|null	$jobId
Closure\|string\|object	$job
string	$payload
DateTimeInterface\|DateInterval\|int\|null	$delay

Return Value

void

string getConnectionName()

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

Return Value

string

$this setConnectionName(string $name)

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

Parameters

string

$name

Return Value

$this

Container getContainer()

Получить экземпляр контейнера, используемый подключением.

Return Value

Container

void setContainer(Container $container)

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

Parameters

Container

$container

Return Value

void

void __construct(PheanstalkSubscriberInterface $pheanstalk, string $default, int $timeToRun, int $blockFor = 0, bool $dispatchAfterCommit = false)

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

Parameters

PheanstalkSubscriberInterface	$pheanstalk
string	$default
int	$timeToRun
int	$blockFor
bool	$dispatchAfterCommit

Return Value

void

int size(string|null $queue = null)

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

Параметры

string|null

$queue

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

int

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

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

Параметры

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

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

mixed

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

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

Параметры

string	$payload
string\|null	$queue
array	$options

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

mixed

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

Добавить новую задачу в очередь через (n) секунд.

Параметры

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

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

mixed

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

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

Параметры

string|null

$queue

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

Задача|null

void deleteMessage(string $queue, string|int $id)

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

Параметры

string	$queue
string\|int	$id

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

void

string getQueue(string|null $queue)

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

Параметры

string|null

$queue

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

string

PheanstalkSubscriberInterface getPheanstalk()

Получить подлежащий экземпляр Pheanstalk.

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

PheanstalkSubscriberInterface

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