BeanstalkdQueue
class BeanstalkdQueue extends Queue implements Queue (View source)
Свойства
| InteractsWithTime |
Свойства
| 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 | Максимальное время ожидания задачи в секундах. |
Методы
| 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 |
| mixed | pushOn(string $queue, string $job, mixed $data = '')
Добавить новую задачу в очередь. | из Queue |
| mixed | laterOn(string $queue, DateTimeInterface|DateInterval|int $delay, string $job, mixed $data = '')
Добавить новую задачу в очередь после задержки. | из Queue |
| void | bulk(array $jobs, mixed $data = '', string|null $queue = null)
Добавить массив задач в очередь. | из Queue |
| 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 | getJobRetryDelay(mixed $job)
Получить задержку повтора для обработчика очереди на основе объекта. | из Queue |
| mixed | getJobExpiration(mixed $job)
Получить метку времени истечения срока действия для обработчика очереди на основе объекта. | из Queue |
| array | createStringPayload(string $job, string $queue, mixed $data)
Создать типичный массив полезной нагрузки очереди на основе строки. | из Queue |
| static void | createPayloadUsing(callable $callback)
Зарегистрировать обратный вызов, который будет выполнен при создании полезных нагрузок заданий. | из Queue |
| array | withCreatePayloadHooks(string $queue, array $payload)
Создать заданную полезную нагрузку с использованием любых зарегистрированных хуков полезной нагрузки. | из Queue |
| string | getConnectionName()
Получить имя соединения для очереди. | из Queue |
| $this | setConnectionName(string $name)
Установить имя соединения для очереди. | из Queue |
| void | setContainer(Container $container)
Установить экземпляр контейнера IoC. | из 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|null $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)
Получить количество секунд до заданного DateTime.
protected int availableAt(DateTimeInterface|DateInterval|int $delay = 0)
Получить метку времени Unix "доступно в".
protected DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)
Если заданное значение является интервалом, преобразовать его в экземпляр DateTime.
protected int currentTime()
Получить текущее системное время в формате метки времени Unix.
mixed pushOn(string $queue, string $job, mixed $data = '')
Добавить новую задачу в очередь.
mixed laterOn(string $queue, DateTimeInterface|DateInterval|int $delay, string $job, mixed $data = '')
Добавить новую задачу в очередь с задержкой.
void bulk(array $jobs, mixed $data = '', string|null $queue = null)
Добавить массив задач в очередь.
protected string createPayload(Closure|string|object $job, string $queue, mixed $data = '')
Создать строку полезной нагрузки из заданной задачи и данных.
protected array createPayloadArray(string|object $job, string $queue, mixed $data = '')
Создать массив полезной нагрузки из заданной задачи и данных.
protected array createObjectPayload(object $job, string $queue)
Создать полезную нагрузку для обработчика очереди на основе объекта.
protected string getDisplayName(object $job)
Получить имя для отображения для заданной задачи.
mixed getJobRetryDelay(mixed $job)
Получить задержку повторной попытки для обработчика очереди на основе объекта.
mixed getJobExpiration(mixed $job)
Получить метку времени истечения срока действия для обработчика очереди на основе объекта.
protected array createStringPayload(string $job, string $queue, mixed $data)
Создать массив типичной полезной нагрузки на основе строки для очереди.
static void createPayloadUsing(callable $callback)
Зарегистрировать обратный вызов, который будет выполнен при создании полезной нагрузки задачи.
protected array withCreatePayloadHooks(string $queue, array $payload)
Создать заданную полезную нагрузку с использованием любых зарегистрированных хуков полезной нагрузки.
string getConnectionName()
Получить имя соединения для очереди.
$this setConnectionName(string $name)
Установить имя соединения для очереди.
void setContainer(Container $container)
Установить экземпляр контейнера IoC.
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|null $queue = null)
Извлечь следующую задачу из очереди.
void deleteMessage(string $queue, string|int $id)
Удалить сообщение из очереди Beanstalk.
string getQueue(string|null $queue)
Получить очередь или вернуть значение по умолчанию.
Pheanstalk getPheanstalk()
Получить базовый экземпляр Pheanstalk.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/7.x/Illuminate/Queue/BeanstalkdQueue.html
