GearmanClient::addTask

(PECL gearman >= 0.5.0)

GearmanClient::addTask — Añade una tarea para ser ejecutada en paralelo

Descripción

public GearmanClient::addTask(
    string $function_name,
    string $workload,
    mixed &$context = ?,
    string $unique = ?
): GearmanTask

Añade una tarea para ser ejecutada en paralelo con otras tareas. Debe llamarse a este método en todas las tareas que van a ejecutarse en paralelo y, entonces, llamar a GearmanClient::runTasks() para realizar el trabajo. Notar que se necesitan al menos tantos trabajadores como tareas para que puedan ejecutarse todos en paralelo de forma simultánea.

Parámetros

function_name: Función registrada que ejecutará el worker
workload: Datos serializados a ser procesados
context: Aplicación context a asociar con la tarea
unique: ID único para identificar una tarea en particular

Valores devueltos

Un objeto GearmanTask o false si no se puede añadir la tarea.

Ejemplos

Ejemplo #1 Envío básico de dos tareas

<?php

# Crear el servidor Gearman
$gmclient= new GearmanClient(); 

# Establece una función a ser llamada cuando se complete el trabajo
$gmclient->setCompleteCallback("complete"); 

# Añade el servidor por defecto
$gmclient->addServer(); 

# Añade una tarea que ejecuta la función "reverse" al string "Hello World!"
$gmclient->addTask("reverse", "Hello World!", null, "1"); 

# Añade otra tarea para ejecutar la función "reverse" en el string "!dlroW olleH"
$gmclient->addTask("reverse", "!dlroW olleH", null, "2"); 

# Ejecuta las tareas
$gmclient->runTasks(); 

function complete($task) 
{ 
  print "COMPLETE: " . $task->unique() . ", " . $task->data() . "\n"; 
}

?>

El resultado del ejemplo sería algo similar a:

COMPLETE: 2, Hello World!
COMPLETE: 1, !dlroW olleH

Ejemplo #2 Envío básico de dos tareas pasando contexto de la aplicación

<?php

$client = new GearmanClient();
$client->addServer();

# Establece una función a ser llamada cuando se complete el trabajo
$client->setCompleteCallback("reverse_complete");


# Añade algunas tareas y provee de un lugar donde poner los resultados
$results = array();
$client->addTask("reverse", "Hello World!", &$results, "t1");
$client->addTask("reverse", "!dlroW olleH", &$results, "t2");

$client->runTasks();

# Los resultados deberían estar rellenos
foreach ($results as $id => $result)
   echo $id . ": " . $result['handle'] . ", " . $result['data'] . "\n";


function reverse_complete($task, $results)
{
   $results[$task->unique()] = array("handle"=>$task->jobHandle(), "data"=>$task->data());
}

?>

El resultado del ejemplo sería algo similar a:

t2: H.foo:21, Hello World!
t1: H:foo:22, !dlroW olleH

Ver también

GearmanClient::addTaskHigh() - Añade una tarea de alta prioridad para ser ejecutada en paralelo
GearmanClient::addTaskLow() - Añade una tarea de baja prioridad para ejecutar en paralelo
GearmanClient::addTaskBackground() - Ejecuta una tarea en segundo plano para ser ejecutada en paralelo
GearmanClient::addTaskHighBackground() - Añade una tarea de alta prioridad ejecutada en segundo plano y en paralelo
GearmanClient::addTaskLowBackground() - Añade una tarea de baja prioridad en segundo plano para ser ejecutada en paralelo
GearmanClient::runTasks() - Ejecuta una lista de tareas en paralelo

add a note

User Contributed Notes 3 notes

down

liv_romania at yahoo dot com ¶

9 years ago


On PHP 5.5 you can use the following code for passing context by reference and avoid "Call-time pass-by-reference has been removed":

<?php
$client = new GearmanClient();
$client->addServer();

# Set a function to be called when the work is complete
$client->setCompleteCallback("reverse_complete");

# Use StdClass instead of array
$results = new StdClass();
$results->value = array();

# Add some tasks for a placeholder of where to put the results
$client->addTask("reverse", "Hello World!", $results, "t1");
$client->addTask("reverse", "!dlroW olleH", $results, "t2");

$client->runTasks();

# The results should now be filled in from the callbacks
foreach ($results->value as $id => $result) {
    echo $id . ": " . $result['handle'] . ", " . $result['data'] . "\n";
}

function reverse_complete(GearmanTask $task, StdClass $results)
{
    $results->value[$task->unique()] = array(
        "handle" => $task->jobHandle(),
        "data" => $task->data()
    );
}
?>

down

stanislav dot reshetnev at gmail dot com ¶

10 years ago


Note that param $unique must be different for multiple tasks if You want to run they all separately. If param $unique is equal for multiple tasks You will get the same task:

<?php
  $unique=1;

  $gclient = GearmanClient();
  $gclient->addServer('srv');  
  
  $this->setCreatedCallback(function(GearmanTask $task) {
    print $task->jobHandle() . "\n"; 
  });
  
  $gclient->addTask('function_name', 'workload', null, $unique);
  $gclient->addTask('function_name', 'workload', null, $unique);
  $gclient->addTask('function_name', 'workload', null, $unique);
  $gclient->runTasks();
  
  sleep(5);
?>

This sript will print only one handler:

H:srv:377382343
H:srv:377382343
H:srv:377382343

down

Jeremy Zerr ¶

11 years ago


As of PHP 5.3.0, you will get a warning saying that "call-time pass-by-reference" is deprecated when you use & in $client->addTask(..., ..., &$results, ...);. And as of PHP 5.4.0, call-time pass-by-reference was removed, so using it will raise a fatal error.

So that means that when you call addTask with a context parameter as in the example above like this:

<?php
# Add some tasks for a placeholder of where to put the results
$results = array();
$client->addTask("reverse", "Hello World!", &$results, "t1");
?>

You get this "call-time pass-by-reference" warning (or error).  This can be avoided and still result in functional code by changing the context variable to be an object so that it is passed by reference like this:

<?php
$results = new \stdClass();
$client->addTask("reverse", "Hello World!", $results, "t1");
?>

Then for completeness, change the complete handler to expect a reference:

<?php
function reverse_complete($task, &$results) { ... }
?>

Then inside the complete handler, you can use the $results object to save your results to be accessible outside the complete handler.

add a note