BeanstalkdQueue

class BeanstalkdQueue extends Queue implements Queue (View source)

Свойства

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

Свойства (свойство)

InteractsWithTime

Методы

int

secondsUntil(DateTimeInterface|DateInterval|int $delay)

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

from InteractsWithTime

int

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

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

from InteractsWithTime

DateTimeInterface|int

parseDateInterval(DateTimeInterface|DateInterval|int $delay)

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

from InteractsWithTime

int

currentTime()

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

from InteractsWithTime

mixed

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

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

from Queue

mixed

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

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

from Queue

void

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

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

from Queue

string

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

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

from Queue

array

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

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

from Queue

array

createObjectPayload(object $job, string $queue)

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

from Queue

string

getDisplayName(object $job)

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

from Queue

mixed

getJobRetryDelay(mixed $job)

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

from Queue

mixed

getJobExpiration(mixed $job)

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

from Queue

array

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

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

from Queue

static void

createPayloadUsing(callable $callback)

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

from Queue

array

withCreatePayloadHooks(string $queue, array $payload)

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

from Queue

string

getConnectionName()

Получить имя соединения для очереди.

from Queue

$this

setConnectionName(string $name)

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

from Queue

void

setContainer(Container $container)

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

from Queue

void

__construct(Pheanstalk $pheanstalk, string $default, int $timeToRun, int $blockFor = 0)

Создать новый экземпляр очереди 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 = [])

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

mixed

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

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

Job|null

pop(string $queue = null)

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

void

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

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

string

getQueue(string|null $queue)

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

Pheanstalk

getPheanstalk()

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

Подробности

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

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

Параметры

DateTimeInterface|DateInterval|int

$delay

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

int

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

Получить метку времени 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.

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

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

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

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

Параметры

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

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

void

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

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

Параметры

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

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

string

Исключения

InvalidPayloadException

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

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

Параметры

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

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

array

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

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

Параметры

object	$job
string	$queue

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

array

protected string getDisplayName(object $job)

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

Параметры

object

$job

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

string

mixed getJobRetryDelay(mixed $job)

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

Параметры

mixed

$job

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

mixed

mixed getJobExpiration(mixed $job)

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

Параметры

mixed

$job

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

mixed

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

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

Параметры

string	$job
string	$queue
mixed	$data

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

array

static void createPayloadUsing(callable $callback)

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

Параметры

callable

$callback

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

void

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

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

Параметры

string	$queue
array	$payload

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

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, int $blockFor = 0)

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

Parameters

Pheanstalk	$pheanstalk
string	$default
int	$timeToRun
int	$blockFor

Return Value

void

int size(string|null $queue = null)

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

Parameters

string|null

$queue

Return Value

int

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

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

Parameters

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

Return Value

mixed

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

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

Parameters

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

Return Value

mixed

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

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

Parameters

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

Return Value

mixed

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

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

Parameters

string

$queue

Return Value

Задача|null

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

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

Parameters

string	$queue
string\|int	$id

Return Value

void

string getQueue(string|null $queue)

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

Parameters

string|null

$queue

Return Value

string

Pheanstalk getPheanstalk()

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

Return Value

Pheanstalk

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