GearmanClient::addTask

(PECL gearman >= 0.5.0)

GearmanClient::addTask — Ajoute une tâche à exécuter en parallèle

Description

public GearmanClient::addTask(
    string $function_name,
    string|int|float $workload,
    mixed $context = null,
    ?string $unique_key = null
): GearmanTask|false

Ajoute une tâche à exécuter en parallèle d'autres tâches. Appelez cette méthode pour toutes les tâches à exécuter en parallèle, puis, appelez la méthode GearmanClient::runTasks() pour exécuter les tâches. Notez qu'il est nécessaire d'avoir assez d'agents disponibles pour exécuter en parallèle toutes les tâches.

Liste de paramètres

function_name: Une fonction enregistrée que le travailleur va exécuter
workload: Données sérialisées à analyser
context: Contexte de l'application à associer avec une tâche
unique_key: Un identifiant unique utilisé pour identifier une tâche particulière

Valeurs de retour

Un objet GearmanTask ou false si l tâche n'a pu être ajoutée.

Exemples

Exemple #1 Ajout de 2 tâches

<?php

# Crée un client gearman
$gmclient= new GearmanClient(); 

# Ajoute le serveur de travaux par défaut
$gmclient->addServer();

# Défini une fonction à appeler lorsque le travail est terminé
$gmclient->setCompleteCallback("complete");

# Ajoute une tâche exécutant la fonction "reverse" sur la chaîne "Hello World!"
$gmclient->addTask("reverse", "Hello World!", null, "1"); 

# Ajoute une autre tâche exécutant la fonction "reverse" sur la chaîne "!dlroW olleH"
$gmclient->addTask("reverse", "!dlroW olleH", null, "2"); 

# Exécute les tâches
$gmclient->runTasks(); 

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

?>

Résultat de l'exemple ci-dessus est similaire à :

Terminé : 2, Hello World!
Terminé : 1, !dlroW olleH

Exemple #2 Ajout de 2 tâches en passant le contexte de l'application

<?php

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

# Défini une fonction à appeler lorsque le travail est terminé
$client->setCompleteCallback("reverse_complete");

# Ajout de quelques tâches contenant un marqueur à l'emplacement duquel le résultat doit être placé
$results = array();
$client->addTask("reverse", "Hello World!", $results, "t1");
$client->addTask("reverse", "!dlroW olleH", $results, "t2");

$client->runTasks();

# Le résultat doit être maintenant contenu dans les fonctions de rappel
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());
}

?>

Résultat de l'exemple ci-dessus est similaire à :

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

Voir aussi

GearmanClient::addTaskHigh() - Ajoute une tâche de forte priorité à effectuer en parallèle
GearmanClient::addTaskLow() - Ajoute une tâche de faible priorité à effectuer en parallèle
GearmanClient::addTaskBackground() - Ajoute une tâche d'arrière-plan pour une exécution en parallèle
GearmanClient::addTaskHighBackground() - Ajoute une tâche de fond de forte priorité à effectuer en parallèle
GearmanClient::addTaskLowBackground() - Ajoute une tâche de fond de faible priorité à effectuer en parallèle
GearmanClient::runTasks() - Exécute une liste de tâches en parallèle

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 ¶

10 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