GearmanClient::addTaskBackground
(PECL gearman >= 0.5.0)
GearmanClient::addTaskBackground — Добавить фоновую задачу для работы в параллельном режиме
Описание
public GearmanTask GearmanClient::addTaskBackground
( string
$function_name
, string $workload
[, mixed &$context
[, string $unique
]] )Добавляет фоновую задачу для параллельной работы с другими задачами. Вызовите этот метод для всех задач, которые будут работать параллельно, а затем вызовите GearmanClient::runTasks() для выполнения работ.
Список параметров
-
function_name -
Зарегистрированная функция, вызываемая рабочим процессом
-
workload -
Сериализованные данные, подлежащие обработке
-
context -
Контекст приложения, связываемый с задачей
-
unique -
Уникальный ID, назначаемый определенной задаче
Возвращаемые значения
Объект GearmanTask или FALSE, если задача не может быть добавлена.
Примеры
Пример #1 Две задачи, одна в фоновом режиме другая нет
Этот пример иллюстрирует различие между выполнением фоновой задачи и нормальной задачей. Клиент добавляет две задачи для выполнения одних и тех же функций, но одна добавлена с помощью addTaskBackground(). Обратный вызов установлен так, чтобы выполнение задания можно было проследить. Простой рабочий с искусственной задержкой сообщает статус выполнения задания, и клиент понимает это посредством обратного вызова. Два рабочих запущены для этого примера. Обратите внимание, что фоновая задача не показывается в клиентском выводе.
<?php
# Клиентский скрипт
# Создание нашего клиента
$gmc= new GearmanClient();
# Добавление сервера задач по умолчанию
$gmc->addServer();
# Установка нескольких обратных вызовов. Таким образом, мы сможем отслеживать выполнение
$gmc->setCompleteCallback("reverse_complete");
$gmc->setStatusCallback("reverse_status");
# Добавление задачи для функции reverse
$task= $gmc->addTask("reverse", "Hello World!", null, "1");
# Добавление другой задачи, но она предназначена для запуска в фоне
$task= $gmc->addTaskBackground("reverse", "!dlroW olleH", null, "2");
if (! $gmc->runTasks())
{
echo "Ошибка " . $gmc->error() . "\n";
exit;
}
echo "Выполнено\n";
function reverse_status($task)
{
echo "Статус: " . $task->unique() . ", " . $task->jobHandle() . " - " . $task->taskNumerator() .
"/" . $task->taskDenominator() . "\n";
}
function reverse_complete($task)
{
echo "Завершено: " . $task->unique() . ", " . $task->data() . "\n";
}
?>
<?php
# Скрипт работника
echo "Начинаем\n";
# Создаем наш объект работника
$gmworker= new GearmanWorker();
# Добавление сервера задач по умолчанию (localhost).
$gmworker->addServer();
# Регистрируем функцию reverse на сервере
$gmworker->addFunction("reverse", "reverse_fn");
print "Ожидание задачи...\n";
while($gmworker->work())
{
if ($gmworker->returnCode() != GEARMAN_SUCCESS)
{
echo "возвратный код: " . $gmworker->returnCode() . "\n";
break;
}
}
function reverse_fn($job)
{
echo "Получена задача: " . $job->handle() . "\n";
$workload = $job->workload();
$workload_size = $job->workloadSize();
echo "Рабочая нагрузка: $workload ($workload_size)\n";
# В этом цикле отображения статуса нет необходимости. Просто для демонстрации как это работает
for ($x= 0; $x < $workload_size; $x++)
{
echo "Отправка статуса: " . ($x + 1) . "/$workload_size выполнено\n";
$job->sendStatus($x+1, $workload_size);
$job->sendData(substr($workload, $x, 1));
sleep(1);
}
$result= strrev($workload);
echo "Результат: $result\n";
# Возвращаем то, что мы хотим вернуть клиенту
return $result;
}
?>
Вывод рабочего для двух запущенных работников:
Получена задача: H:foo.local:65 Рабочая нагрузка: !dlroW olleH (12) 1/12 выполнено Получена задача: H:foo.local:66 Рабочая нагрузка: Hello World! (12) Отправка статуса: 1/12 выполнено Отправка статуса: 2/12 выполнено Отправка статуса: 2/12 выполнено Отправка статуса: 3/12 выполнено Отправка статуса: 3/12 выполнено Отправка статуса: 4/12 выполнено Отправка статуса: 4/12 выполнено Отправка статуса: 5/12 выполнено Отправка статуса: 5/12 выполнено Отправка статуса: 6/12 выполнено Отправка статуса: 6/12 выполнено Отправка статуса: 7/12 выполнено Отправка статуса: 7/12 выполнено Отправка статуса: 8/12 выполнено Отправка статуса: 8/12 выполнено Отправка статуса: 9/12 выполнено Отправка статуса: 9/12 выполнено Отправка статуса: 10/12 выполнено Отправка статуса: 10/12 выполнено Отправка статуса: 11/12 выполнено Отправка статуса: 11/12 выполнено Отправка статуса: 12/12 выполнено Отправка статуса: 12/12 выполнено Result: !dlroW olleH Result: Hello World!
Клиент выводит:
Статус: 1, H:foo.local:66 - 1/12 Статус: 1, H:foo.local:66 - 2/12 Статус: 1, H:foo.local:66 - 3/12 Статус: 1, H:foo.local:66 - 4/12 Статус: 1, H:foo.local:66 - 5/12 Статус: 1, H:foo.local:66 - 6/12 Статус: 1, H:foo.local:66 - 7/12 Статус: 1, H:foo.local:66 - 8/12 Статус: 1, H:foo.local:66 - 9/12 Статус: 1, H:foo.local:66 - 10/12 Статус: 1, H:foo.local:66 - 11/12 Статус: 1, H:foo.local:66 - 12/12 Завершено: 1, !dlroW olleH Выполнено
Смотрите также
- GearmanClient::addTask() - Добавить задачу, которая будет выполнена в параллельном режиме
- GearmanClient::addTaskHigh() - Добавить высокоприоритетную задачу для работы в параллельном режиме
- GearmanClient::addTaskLow() - Добавить низкоприоритетную задачу для работы в параллельном режиме
- GearmanClient::addTaskHighBackground() - Добавить высокоприоритетную фоновую задачу для работы в параллельном режиме
- GearmanClient::addTaskLowBackground() - Добавить низкоприоритетную фоновую задачу для работы в параллельном режиме
- GearmanClient::runTasks() - Запустить список задач в параллельном режиме
- Функция GearmanClient::addOptions() - Добавить клиентские опции
- Функция GearmanClient::addServer() - Добавить сервер задач для клиента
- Функция GearmanClient::addServers() - Добавить список серверов задач для клиента
- Функция GearmanClient::addTask() - Добавить задачу, которая будет выполнена в параллельном режиме
- Функция GearmanClient::addTaskBackground() - Добавить фоновую задачу для работы в параллельном режиме
- Функция GearmanClient::addTaskHigh() - Добавить высокоприоритетную задачу для работы в параллельном режиме
- Функция GearmanClient::addTaskHighBackground() - Добавить высокоприоритетную фоновую задачу для работы в параллельном режиме
- Функция GearmanClient::addTaskLow() - Добавить низкоприоритетную задачу для работы в параллельном режиме
- Функция GearmanClient::addTaskLowBackground() - Добавить низкоприоритетную фоновую задачу для работы в параллельном режиме
- Функция GearmanClient::addTaskStatus() - Добавить задачу для получения статуса
- Функция GearmanClient::clearCallbacks() - Очистить все функции обратного вызова данной задачи
- Функция GearmanClient::clone() - Создать копию объекта GearmanClient
- Функция GearmanClient::__construct() - Создать экземпляр GearmanClient
- Функция GearmanClient::context() - Возвращает контекст приложения
- Функция GearmanClient::data() - Возвращает данные приложения (функция устарела)
- Функция GearmanClient::do() - Выполняет одну задачу и возвращает результат [Устаревший метод]
- Функция GearmanClient::doBackground() - Запускает выполнение задачи в фоновом режиме
- Функция GearmanClient::doHigh() - Запускает на выполнение задачу с высоким приоритетом
- Функция GearmanClient::doHighBackground() - Запускает на выполнение с высоким приоритетом задачу в фоновом режиме
- Функция GearmanClient::doJobHandle() - Получить дескриптор выполняющейся задачи
- Функция GearmanClient::doLow() - Запускает на выполнение задачу с низким приоритетом
- Функция GearmanClient::doLowBackground() - Запускает на выполнение с низким приоритетом задачу в фоновом режиме
- Функция GearmanClient::doNormal() - Выполняет одиночное задание и возвращает результат
- Функция GearmanClient::doStatus() - Получение статуса обработки задания
- Функция GearmanClient::echo() - Отправляет данные всем серверам заданий, чтобы проверить отклик [Устаревший метод]
- Функция GearmanClient::error() - Вернуть строку ошибки для последней встретившейся ошибки
- Функция GearmanClient::getErrno() - Получить значение errno
- Функция GearmanClient::jobStatus() - Получение статуса выполнения фонового задания
- Функция GearmanClient::ping() - Отправляет данные на все сервера и смотрит, какие из них выведут эти данные
- Функция GearmanClient::removeOptions() - Удалить клиентские опции
- Функция GearmanClient::returnCode() - Получить последний возвращённый код Gearman
- Функция GearmanClient::runTasks() - Запустить список задач в параллельном режиме
- Функция GearmanClient::setClientCallback() - Установить функцию обратного вызова, когда есть пакет данных для задачи (устаревший метод)
- Функция GearmanClient::setCompleteCallback() - Установите функцию, которая будет вызвана по завершении задачи
- Функция GearmanClient::setContext() - Установить данные приложения
- Функция GearmanClient::setCreatedCallback() - Установить функцию обратного вызова, когда задача ставится в очередь
- Функция GearmanClient::setData() - Установить данные приложения (устаревший метод)
- Функция GearmanClient::setDataCallback() - Задает callback-функцию для обработки переданных данных
- GearmanClient::setExceptionCallback
- GearmanClient::setFailCallback
- Функция GearmanClient::setOptions() - Задание настроек клиента
- Функция GearmanClient::setStatusCallback() - Задание callback-функции, собирающей информацию о состоянии обработчика заданий
- Функция GearmanClient::setTimeout() - Установка таймаута для операций ввода/вывода
- Функция GearmanClient::setWarningCallback() - Задание callback-функции, обслуживающей предупреждения обработчика заданий
- GearmanClient::setWorkloadCallback
- Функция GearmanClient::timeout() - Получение значения таймаута операций ввода/вывода
Коментарии
It is unlikely this example works quite as advertised.
The foreground job will block, however the background job should not.. (and if it does that's not documented Gearman behaviour far as I know and would not make sense for a Background job).
So, if the foreground job completes, then we would expect runTasks() to return at that moment, regardless of the status of the background job(s). With nothing else to do, the php script (the client) in this example would exit at that point.
To fully-utilize background jobs, it's reasonable to assume that we still wish to know their status. To do that, you need a polling loop that "checks up on them" and waits until their completion.
That eliminates the point of background jobs of course - because the client would still be Blocking (in a polling loop) more or less occupied, and unable to exit/finish.
So, in practice, background jobs mean you are decoupled from the client upon execution (because the main point is to free up the client, otherwise just use foreground execution), which means the client is likely going to exit, meaning the jobs themselves should be reporting their status and final result independently, not leaving it up to the client.
It's a significantly different setup compared to foreground jobs. In fact this example is kind of silly to even mix the two.
Nobody will ever see this post, because apparently nobody in the world has ever commented on the php gearman client, but it's a good post never the less.
This method seems only useful when you doesn't need to know something about the worker, when you can let runTasks() finishes its code and destroy the GearmanClient object without a problem.
If you need to get data from worker via callbacks, forget it after runTasks() finishes.
You have to block your execution in the GearmanClient "main loop", so it can call the callbacks. It seems that runTasks() is that "main loop".
function run_process($cmd,$outputFile = '/dev/null', $append = false){
$pid=0;
if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') {//'This is a server using Windows!';
$cmd = 'wmic process call create "'.$cmd.'" | find "ProcessId"';
$handle = popen("start /B ". $cmd, "r");
$read = fread($handle, 200); //Read the output
$pid=substr($read,strpos($read,'=')+1);
$pid=substr($pid,0,strpos($pid,';') );
$pid = (int)$pid;
pclose($handle); //Close
}else{
$pid = (int)shell_exec(sprintf('%s %s %s 2>&1 & echo $!', $cmd, ($append) ? '>>' : '>', $outputFile));
}
return $pid;
}
function is_process_running($pid){
if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') {//'This is a server using Windows!';
//tasklist /FI "PID eq 6480"
$result = shell_exec('tasklist /FI "PID eq '.$pid.'"' );
if (count(preg_split("/\n/", $result)) > 0 && !preg_match('/No tasks/', $result)) {
return true;
}
}else{
$result = shell_exec(sprintf('ps %d 2>&1', $pid));
if (count(preg_split("/\n/", $result)) > 2 && !preg_match('/ERROR: Process ID out of range/', $result)) {
return true;
}
}
return false;
}
function stop_process($pid){
if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') {//'This is a server using Windows!';
$result = shell_exec('taskkill /PID '.$pid );
if (count(preg_split("/\n/", $result)) > 0 && !preg_match('/No tasks/', $result)) {
return true;
}
}else{
$result = shell_exec(sprintf('kill %d 2>&1', $pid));
if (!preg_match('/No such process/', $result)) {
return true;
}
}
}
$cmd='';
if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') {//'This is a server using Windows!';
$cmd= $php_path.'\php.exe '.$path.'\long_process.php' ;
}else{
$cmd='/usr/bin/php -f /var/www/example.com/public/long_process.php';
}
$pid=run_process($cmd);