Worker
class Worker (View source)
Трейты
| DetectsLostConnections |
Свойства
| protected Factory | $manager | Экземпляр менеджера очереди. | |
| protected Dispatcher | $events | Экземпляр диспетчера событий. | |
| protected Repository | $cache | Реализация репозитория кэша. | |
| protected ExceptionHandler | $exceptions | Экземпляр обработчика исключений. | |
| protected callable | $isDownForMaintenance | Обратный вызов, используемый для определения, находится ли приложение в режиме технического обслуживания. | |
| bool | $shouldQuit | Указывает, должен ли рабочий процесс завершиться. | |
| bool | $paused | Указывает, приостановлен ли рабочий процесс. |
Методы
| bool | causedByLostConnection(Throwable $e)
Определить, было ли данное исключение вызвано потерей соединения. | из DetectsLostConnections |
| void | __construct(Factory $manager, Dispatcher $events, ExceptionHandler $exceptions, callable $isDownForMaintenance)
Создать нового работника очереди. | |
| void | daemon(string $connectionName, string $queue, WorkerOptions $options)
Прослушивать заданную очередь в цикле. | |
| void | registerTimeoutHandler(Job|null $job, WorkerOptions $options)
Зарегистрировать обработчик таймаута работника. | |
| void | resetTimeoutHandler()
Сбросить обработчик таймаута работника. | |
| int | timeoutForJob(Job|null $job, WorkerOptions $options)
Получить соответствующий таймаут для данной задачи. | |
| bool | daemonShouldRun(WorkerOptions $options, string $connectionName, string $queue)
Определить, должен ли демон обрабатывать на этой итерации. | |
| void | pauseWorker(WorkerOptions $options, int $lastRestart)
Приостановить работника на текущий цикл. | |
| void | stopIfNecessary(WorkerOptions $options, int $lastRestart, mixed $job = null)
Остановите процесс, если необходимо. | |
| void | runNextJob(string $connectionName, string $queue, WorkerOptions $options)
Обработать следующую задачу в очереди. | |
| Job|null | getNextJob(Queue $connection, string $queue)
Получить следующую задачу из подключения к очереди. | |
| void | runJob(Job $job, string $connectionName, WorkerOptions $options)
Обработать заданную задачу. | |
| void | stopWorkerIfLostConnection(Throwable $e)
Остановить работника, если соединение с базой данных потеряно. | |
| void | process(string $connectionName, Job $job, WorkerOptions $options)
Обработать заданную задачу из очереди. | |
| void | handleJobException(string $connectionName, Job $job, WorkerOptions $options, Throwable $e)
Обработать исключение, произошедшее во время выполнения задачи. | |
| void | markJobAsFailedIfAlreadyExceedsMaxAttempts(string $connectionName, Job $job, int $maxTries)
Отметить задачу как завершенную с ошибкой, если она превысила максимальное количество попыток. | |
| void | markJobAsFailedIfWillExceedMaxAttempts(string $connectionName, Job $job, int $maxTries, Throwable $e)
Отметить задачу как завершенную с ошибкой, если она превысит максимальное количество попыток. | |
| void | markJobAsFailedIfWillExceedMaxExceptions(string $connectionName, Job $job, Throwable $e)
Отметить задачу как завершенную с ошибкой, если она превысила максимальное количество попыток. | |
| void | failJob(Job $job, Throwable $e)
Отметить задачу как завершенную с ошибкой и поднять соответствующее событие. | |
| void | raiseBeforeJobEvent(string $connectionName, Job $job)
Вызвать событие перед задачей очереди. | |
| void | raiseAfterJobEvent(string $connectionName, Job $job)
Вызвать событие после задачи очереди. | |
| void | raiseExceptionOccurredJobEvent(string $connectionName, Job $job, Throwable $e)
Вызвать событие возникновения исключения в задаче очереди. | |
| bool | queueShouldRestart(int|null $lastRestart)
Определить, следует ли перезапустить работника очереди. | |
| int|null | getTimestampOfLastQueueRestart()
Получить отметку времени последней перезагрузки очереди, или null. | |
| void | listenForSignals()
Включить асинхронные сигналы для процесса. | |
| bool | supportsAsyncSignals()
Определить, поддерживаются ли асинхронные сигналы. | |
| bool | memoryExceeded(int $memoryLimit)
Определить, превышен ли предел памяти. | |
| void | stop(int $status = 0)
Остановить прослушивание и прервать выполнение скрипта. | |
| void | kill(int $status = 0)
Завершить процесс. | |
| MaxAttemptsExceededException | maxAttemptsExceededException(Job $job)
Создать экземпляр MaxAttemptsExceededException. | |
| void | sleep(int|float $seconds)
Уснуть скрипт на заданное количество секунд. | |
| void | setCache(Repository $cache)
Установить реализацию репозитория кэша. | |
| QueueManager | getManager()
Получить экземпляр диспетчера очереди. |
| void | setManager(Factory $manager)
Установить экземпляр менеджера очереди. |
Подробности
protected bool causedByLostConnection(Throwable $e)
Определить, вызвана ли данная исключительная ситуация потерей соединения.
void __construct(Factory $manager, Dispatcher $events, ExceptionHandler $exceptions, callable $isDownForMaintenance)
Создать нового работника очереди.
void daemon(string $connectionName, string $queue, WorkerOptions $options)
Прослушивать заданную очередь в цикле.
protected void registerTimeoutHandler(Job|null $job, WorkerOptions $options)
Зарегистрировать обработчик таймаута работника.
protected void resetTimeoutHandler()
Сбросить обработчик таймаута работника.
protected int timeoutForJob(Job|null $job, WorkerOptions $options)
Получить соответствующий таймаут для данной задачи.
protected bool daemonShouldRun(WorkerOptions $options, string $connectionName, string $queue)
Определить, должен ли демон обрабатывать на данной итерации.
protected void pauseWorker(WorkerOptions $options, int $lastRestart)
Приостановить работника на текущий цикл.
protected void stopIfNecessary(WorkerOptions $options, int $lastRestart, mixed $job = null)
Остановить процесс, если необходимо.
void runNextJob(string $connectionName, string $queue, WorkerOptions $options)
Обработать следующую задачу в очереди.
protected Job|null getNextJob(Queue $connection, string $queue)
Получить следующую задачу из соединения очереди.
protected void runJob(Job $job, string $connectionName, WorkerOptions $options)
Обработать заданную задачу.
protected void stopWorkerIfLostConnection(Throwable $e)
Остановить работника, если соединение с базой данных было потеряно.
void process(string $connectionName, Job $job, WorkerOptions $options)
Обработать задачу из очереди.
protected void handleJobException(string $connectionName, Job $job, WorkerOptions $options, Throwable $e)
Обработать исключение, произошедшее во время выполнения задачи.
protected void markJobAsFailedIfAlreadyExceedsMaxAttempts(string $connectionName, Job $job, int $maxTries)
Отметить задачу как завершенную с ошибкой, если количество попыток превышено.
Это, вероятно, произойдет из-за превышения таймаута задачи ранее.
protected void markJobAsFailedIfWillExceedMaxAttempts(string $connectionName, Job $job, int $maxTries, Throwable $e)
Отметить задачу как завершенную с ошибкой, если количество попыток превышено.
protected void markJobAsFailedIfWillExceedMaxExceptions(string $connectionName, Job $job, Throwable $e)
Отметить задачу как завершенную с ошибкой, если количество попыток превышено.
protected void failJob(Job $job, Throwable $e)
Отметить задачу как завершенную с ошибкой и вывести соответствующее событие.
protected void raiseBeforeJobEvent(string $connectionName, Job $job)
Вызвать событие перед запуском задачи в очереди.
protected void raiseAfterJobEvent(string $connectionName, Job $job)
Вызвать событие после выполнения задачи в очереди.
protected void raiseExceptionOccurredJobEvent(string $connectionName, Job $job, Throwable $e)
Вызвать событие о возникновении исключения при обработке задачи в очереди.
protected bool queueShouldRestart(int|null $lastRestart)
Определить, нужно ли перезапустить обработчик очереди.
protected int|null getTimestampOfLastQueueRestart()
Получить метку времени последнего перезапуска обработчика очереди или null.
protected void listenForSignals()
Включить асинхронные сигналы для процесса.
protected bool supportsAsyncSignals()
Определить, поддерживаются ли асинхронные сигналы.
bool memoryExceeded(int $memoryLimit)
Определить, превышен ли лимит памяти.
void stop(int $status = 0)
Остановить прослушивание и завершить выполнение скрипта.
void kill(int $status = 0)
Убить процесс.
protected MaxAttemptsExceededException maxAttemptsExceededException(Job $job)
Создать экземпляр MaxAttemptsExceededException.
void sleep(int|float $seconds)
Засыпать скрипт на заданное количество секунд.
void setCache(Repository $cache)
Установить реализацию репозитория кэша.
QueueManager getManager()
Получить экземпляр менеджера очереди.
void setManager(Factory $manager)
Установить экземпляр менеджера очереди.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/7.x/Illuminate/Queue/Worker.html
