Spec-Zone.ru › Laravel 5.2

Рабочий

класс Worker (View source)

Свойства

protected QueueManager $manager Экземпляр менеджера очереди.
protected FailedJobProviderInterface $failer Реализация поставщика невыполненных заданий.
protected Dispatcher $events Экземпляр диспетчера событий.
protected Repository $cache Реализация репозитория кэша.
protected Handler $exceptions Экземпляр обработчика исключений.

Методы

void __construct(QueueManager $manager, FailedJobProviderInterface $failer = null, Dispatcher $events = null)

Создать новый рабочий поток очереди.

array daemon(string $connectionName, string $queue = null, int $delay, int $memory = 128, int $sleep = 3, int $maxTries)

Прослушивать заданную очередь в цикле.

void runNextJobForDaemon(string $connectionName, string $queue, int $delay, int $sleep, int $maxTries)

Выполнить следующее задание для фонового рабочего процесса.

bool daemonShouldRun()

Определить, должен ли фоновый процесс обрабатывать на этой итерации.

array pop(string $connectionName, string $queue = null, int $delay, int $sleep = 3, int $maxTries)

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

Job|null getNextJob(Queue $connection, string $queue)

Получить следующее задание из соединения очереди.

array|null process(string $connection, Job $job, int $maxTries, int $delay)

Обработать заданное задание из очереди.

void handleJobException(string $connection, Job $job, int $delay, Throwable $e)

Обработать исключение, возникшее во время выполнения задания.

void raiseBeforeJobEvent(string $connection, Job $job)

Вызвать событие перед выполнением задания очереди.

void raiseAfterJobEvent(string $connection, Job $job)

Вызвать событие после выполнения задания очереди.

void raiseExceptionOccurredJobEvent(string $connection, Job $job, Throwable $exception)

Вызвать событие о возникновении исключения в задании очереди.

array logFailedJob(string $connection, Job $job)

Записать в журнал невыполненное задание в хранилище.

void raiseFailedJobEvent(string $connection, Job $job, int|null $failedId)

Вызвать событие о невыполненном задании очереди.

bool memoryExceeded(int $memoryLimit)

Определить, был ли превышен лимит памяти.

void stop()

Остановить прослушивание и выйти из скрипта.

void sleep(int $seconds)

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

int|null getTimestampOfLastQueueRestart()

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

bool queueShouldRestart(int|null $lastRestart)

Определить, следует ли перезапускать обработчик очереди.

void setDaemonExceptionHandler(ExceptionHandler $handler)

Установить обработчик исключений для использования в режиме Daemon.

void setCache(Repository $cache)

Установить реализацию репозитория кэша.

QueueManager getManager()

Получить экземпляр менеджера очереди.

void setManager(QueueManager $manager)

Установить экземпляр менеджера очереди.

Подробности

void __construct(QueueManager $manager, FailedJobProviderInterface $failer = null, Dispatcher $events = null)

Создать новый рабочий поток очереди.

Параметры

QueueManager $manager
FailedJobProviderInterface $failer
Dispatcher $events

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

void

array daemon(string $connectionName, string $queue = null, int $delay, int $memory = 128, int $sleep = 3, int $maxTries)

Прослушивать заданную очередь в цикле.

Параметры

string $connectionName
string $queue
int $delay
int $memory
int $sleep
int $maxTries

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

array

protected void runNextJobForDaemon(string $connectionName, string $queue, int $delay, int $sleep, int $maxTries)

Выполнить следующее задание для фонового рабочего процесса.

Параметры

string $connectionName
string $queue
int $delay
int $sleep
int $maxTries

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

void

protected bool daemonShouldRun()

Определить, должен ли фоновый процесс обрабатывать на этой итерации.

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

bool
END_OF_DOCUMENT_MARKER

массив pop(строка $connectionName, строка $queue = null, целое $delay, целое $sleep = 3, целое $maxTries)

Прослушивать указанную очередь.

Параметры

строка $connectionName
строка $queue
целое $delay
целое $sleep
целое $maxTries

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

массив

защищенный Задача|null getNextJob(Очередь $connection, строка $queue)

Получить следующую задачу из соединения очереди.

Параметры

Очередь $connection
строка $queue

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

Задача|null

массив|null process(строка $connection, Задача $job, целое $maxTries, целое $delay)

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

Параметры

строка $connection
Задача $job
целое $maxTries
целое $delay

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

массив|null

Исключения

Throwable

защищенный пустое handleJobException(строка $connection, Задача $job, целое $delay, Throwable $e)

Обработать исключение, возникшее во время выполнения задачи.

Параметры

строка $connection
Задача $job
целое $delay
Throwable $e

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

пустое

Исключения

Throwable

защищенный пустое raiseBeforeJobEvent(строка $connection, Задача $job)

Вызвать событие перед задачей очереди.

Параметры

строка $connection
Задача $job

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

пустое

защищенный пустое raiseAfterJobEvent(строка $connection, Задача $job)

Вызвать событие после задачи очереди.

Параметры

строка $connection
Задача $job

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

пустое

защищенный пустое raiseExceptionOccurredJobEvent(строка $connection, Задача $job, Throwable $exception)

Вызвать событие возникновения исключения в задаче очереди.

Параметры

строка $connection
Задача $job
Throwable $exception

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

пустое

защищенный массив logFailedJob(строка $connection, Задача $job)

Залогировать проваленную задачу в хранилище.

Параметры

строка $connection
Задача $job

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

массив

защищенный пустое raiseFailedJobEvent(строка $connection, Задача $job, целое|null $failedId)

Вызвать событие проваленной задачи очереди.

Параметры

строка $connection
Задача $job
целое|null $failedId

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

пустое

логическое memoryExceeded(целое $memoryLimit)

Определить, превышен ли лимит памяти.

Параметры

целое $memoryLimit

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

логическое

пустое stop()

Остановить прослушивание и выйти из скрипта.

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

пустое

пустое sleep(целое $seconds)

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

Параметры

целое $seconds

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

пустое

защищенный целое|null getTimestampOfLastQueueRestart()

Получить временную метку последнего перезапуска очереди, или null.

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

целое|null

защищенный логическое queueShouldRestart(целое|null $lastRestart)

Определить, должен ли рабочий процесс очереди перезапуститься.

Параметры

целое|null $lastRestart

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

логическое

пустое setDaemonExceptionHandler(ОбработчикИсключений $handler)

Установить обработчик исключений для использования в режиме Daemon.

Параметры

ОбработчикИсключений $handler

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

пустое

пустое setCache(Репозиторий $cache)

Установить реализацию репозитория кэша.

Параметры

Репозиторий $cache

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

пустое

QueueManager getManager()

Получить экземпляр диспетчера очереди.

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

QueueManager

void setManager(QueueManager $manager)

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

Параметры

QueueManager $manager

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

void

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API