Spec-Zone.ru › Laravel 5.1

Работник

класс Работник (Просмотреть исходный код)

Свойства

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 raiseAfterJobEvent(string $connection, Job $job)

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

array logFailedJob(string $connection, Job $job)

Залогировать задачу с ошибкой в хранилище.

void raiseFailedJobEvent(string $connection, Job $job)

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

bool memoryExceeded(int $memoryLimit)

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

void stop()

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

void sleep(int $seconds)

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

int|null getTimestampOfLastQueueRestart()

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

bool queueShouldRestart(int|null $lastRestart)

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

void setDaemonExceptionHandler(ExceptionHandler $handler)

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

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

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

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

Параметры

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

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

array

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

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

Параметры

Queue $connection
string $queue

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

Job|null

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

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

Параметры

string $connection
Job $job
int $maxTries
int $delay

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

array|null

Исключения

Throwable

protected void raiseAfterJobEvent(string $connection, Job $job)

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

Параметры

string $connection
Job $job

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

void

protected array logFailedJob(string $connection, Job $job)

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

Параметры

string $connection
Job $job

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

array

protected void raiseFailedJobEvent(string $connection, Job $job)

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

Параметры

string $connection
Job $job

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

void

bool memoryExceeded(int $memoryLimit)

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

Параметры

int $memoryLimit

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

bool

void stop()

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

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

void

void sleep(int $seconds)

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

Параметры

int $seconds

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

void

protected int|null getTimestampOfLastQueueRestart()

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

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

int|null

protected bool queueShouldRestart(int|null $lastRestart)

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

Параметры

int|null $lastRestart

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

bool

void setDaemonExceptionHandler(ExceptionHandler $handler)

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

Параметры

ExceptionHandler $handler

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

void

void setCache(Repository $cache)

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

Параметры

Repository $cache

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

void

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.1/Illuminate/Queue/Worker.html

Spec-Zone.ru

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