Работник
класс Работник (Просмотр исходного кода)
Трейты
| DetectsLostConnections |
Свойства
| protected Управление очередью | $manager | Экземпляр управляющего очереди. | |
| protected Диспечер событий | $events | Экземпляр диспечера событий. | |
| protected Репозиторий кэша | $cache | Реализация репозитория кэша. | |
| protected Обработчик исключений | $exceptions | Экземпляр обработчика исключений. | |
| bool | $shouldQuit | Указывает, должен ли работник завершиться. | |
| bool | $paused | Указывает, приостановлен ли работник. |
Методы
| bool | causedByLostConnection(Throwable $e) Определить, было ли данное исключение вызвано потерей подключения. | from DetectsLostConnections |
| void | __construct(QueueManager $manager, Dispatcher $events, ExceptionHandler $exceptions) Создать нового обработчика очереди. | |
| void | daemon(string $connectionName, string $queue, WorkerOptions $options) Прослушивать заданную очередь в цикле. | |
| void | registerTimeoutHandler(Job|null $job, WorkerOptions $options) Зарегистрировать обработчик таймаута для обработчика очереди. | |
| int | timeoutForJob(Job|null $job, WorkerOptions $options) Получить соответствующий таймаут для данной задачи. | |
| bool | daemonShouldRun(WorkerOptions $options, string $connectionName, string $queue) Определить, должен ли демон обрабатывать задачу в данный момент. | |
| void | pauseWorker(WorkerOptions $options, int $lastRestart) Приостановить обработчик очереди на текущий цикл. | |
| 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, Exception $e) Обработать исключение, произошедшее во время выполнения задачи. | |
| void | markJobAsFailedIfAlreadyExceedsMaxAttempts(string $connectionName, Job $job, int $maxTries) Отметить задачу как проваленную, если попытки превысили максимально допустимое значение. | |
| void | markJobAsFailedIfWillExceedMaxAttempts(string $connectionName, Job $job, int $maxTries, Exception $e) Отметить задачу как проваленную, если попытки превысят максимально допустимое значение. | |
| void | failJob(Job $job, Exception $e) Отметить задачу как проваленную и вызвать соответствующее событие. | |
| void | raiseBeforeJobEvent(string $connectionName, Job $job) Вызвать событие перед обработкой задачи в очереди. | |
| void | raiseAfterJobEvent(string $connectionName, Job $job) Вызвать событие после обработки задачи в очереди. | |
| void | raiseExceptionOccurredJobEvent(string $connectionName, Job $job, Exception $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|null $job) Создать экземпляр MaxAttemptsExceededException. | |
| void | sleep(int|float $seconds) Засыпать скрипт на заданное количество секунд. | |
| void | setCache(Repository $cache) Установить реализацию репозитория кэша. | |
| QueueManager | getManager() Получить экземпляр менеджера очереди. | |
| void | setManager(QueueManager $manager) Установить экземпляр менеджера очереди. |
Подробности
protected bool causedByLostConnection(Throwable $e)
Определить, вызвано ли данное исключение потерей соединения.
void __construct(QueueManager $manager, Dispatcher $events, ExceptionHandler $exceptions)
Создать нового работника очереди.
void daemon(string $connectionName, string $queue, WorkerOptions $options)
Прослушивать заданную очередь в цикле.
protected void registerTimeoutHandler(Job|null $job, WorkerOptions $options)
Зарегистрировать обработчик таймаута работника.
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 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, Exception $e)
Обработать исключение, возникшее во время выполнения задачи.
protected void markJobAsFailedIfAlreadyExceedsMaxAttempts(string $connectionName, Job $job, int $maxTries)
Отметить задачу как завершённую с ошибкой, если число попыток превысило максимальное.
Вероятно, это произошло из-за превышения таймаута задачи ранее.
protected void markJobAsFailedIfWillExceedMaxAttempts(string $connectionName, Job $job, int $maxTries, Exception $e)
Отметить задачу как завершённую с ошибкой, если число попыток превысило максимальное.
protected void failJob(Job $job, Exception $e)
Отметить задачу как завершённую с ошибкой и сгенерировать соответствующее событие.
protected void raiseBeforeJobEvent(string $connectionName, Job $job)
Вызвать событие перед выполнением задачи в очереди.
protected void raiseAfterJobEvent(string $connectionName, Job $job)
Вызвать событие после выполнения задачи в очереди.
protected void raiseExceptionOccurredJobEvent(string $connectionName, Job $job, Exception $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|null $job)
Создать экземпляр MaxAttemptsExceededException.
void sleep(int|float $seconds)
Заставить скрипт поспать на заданное количество секунд.
void setCache(Репозиторий $cache)
Установить реализацию репозитория кэша.
Менеджер очереди getManager()
Получить экземпляр менеджера очереди.
void setManager(Менеджер очереди $manager)
Установить экземпляр менеджера очереди.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.8/Illuminate/Queue/Worker.html
