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