PHP Conference Nagoya 2025

    GearmanClient::addTaskBackground

    (PECL gearman >= 0.5.0)

    GearmanClient::addTaskBackground — Add a background task to be run in parallel

    Description

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

    Adds a background task to be run in parallel with other tasks. Call this method for all the tasks to be run in parallel, then call GearmanClient::runTasks() to perform the work.

    Parameters

    function_name

    A registered function the worker is to execute

    workload

    Serialized data to be processed

    context

    Application context to associate with a task

    unique_key

    A unique ID used to identify a particular task

    Return Values

    A GearmanTask object or false if the task could not be added.

    Examples

    Example #1 Two tasks, one background and one not

    This example illustrates the difference between running a background task and a normal task. The client adds two tasks to execute the same function, but one is added with addTaskBackground(). A callback is set so that progress of the job can be tracked. A simple worker with an artificial delay reports on the job progress and the client picks this up through the callback. Two workers are run for this example. Note that the background task does not show in the client output.

    <?php

    # The client script

    # create our gearman client
    $gmc= new GearmanClient();

    # add the default job server
    $gmc->addServer();

    # set a couple of callbacks so we can track progress
    $gmc->setCompleteCallback("reverse_complete");
    $gmc->setStatusCallback("reverse_status");

    # add a task for the "reverse" function
    $task= $gmc->addTask("reverse", "Hello World!", null, "1");

    # add another task, but this one to run in the background
    $task= $gmc->addTaskBackground("reverse", "!dlroW olleH", null, "2");

    if (!     $gmc->runTasks())
    {
    echo     "ERROR " . $gmc->error() . "\n";
    exit;
    }

    echo     "DONE\n";

    function     reverse_status($task)
    {
    echo     "STATUS: " . $task->unique() . ", " . $task->jobHandle() . " - " . $task->taskNumerator() .
    "/" . $task->taskDenominator() . "\n";
    }

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

    ?>
    <?php

    # The worker script

    echo "Starting\n";

    # Create our worker object.
    $gmworker= new GearmanWorker();

    # Add default server (localhost).
    $gmworker->addServer();

    # Register function "reverse" with the server.
    $gmworker->addFunction("reverse", "reverse_fn");

    print     "Waiting for job...\n";
    while(    $gmworker->work())
    {
    if (    $gmworker->returnCode() != GEARMAN_SUCCESS)
    {
    echo     "return_code: " . $gmworker->returnCode() . "\n";
    break;
    }
    }

    function     reverse_fn($job)
    {
    echo     "Received job: " . $job->handle() . "\n";

    $workload = $job->workload();
    $workload_size = $job->workloadSize();

    echo     "Workload: $workload ($workload_size)\n";

    # This status loop is not needed, just showing how it works
    for ($x= 0; $x < $workload_size; $x++)
    {
    echo     "Sending status: " . ($x + 1) . "/$workload_size complete\n";
    $job->sendStatus($x+1, $workload_size);
    $job->sendData(substr($workload, $x, 1));
    sleep(1);
    }

    $result= strrev($workload);
    echo     "Result: $result\n";

    # Return what we want to send back to the client.
    return $result;
    }

    ?>

    Worker output for two workers running: 

    Received job: H:foo.local:65
Workload: !dlroW olleH (12)
1/12 complete
Received job: H:foo.local:66
Workload: Hello World! (12)
Sending status: 1/12 complete
Sending status: 2/12 complete
Sending status: 2/12 complete
Sending status: 3/12 complete
Sending status: 3/12 complete
Sending status: 4/12 complete
Sending status: 4/12 complete
Sending status: 5/12 complete
Sending status: 5/12 complete
Sending status: 6/12 complete
Sending status: 6/12 complete
Sending status: 7/12 complete
Sending status: 7/12 complete
Sending status: 8/12 complete
Sending status: 8/12 complete
Sending status: 9/12 complete
Sending status: 9/12 complete
Sending status: 10/12 complete
Sending status: 10/12 complete
Sending status: 11/12 complete
Sending status: 11/12 complete
Sending status: 12/12 complete
Sending status: 12/12 complete
Result: !dlroW olleH
Result: Hello World!

    Client output: 

    STATUS: 1, H:foo.local:66 - 1/12
STATUS: 1, H:foo.local:66 - 2/12
STATUS: 1, H:foo.local:66 - 3/12
STATUS: 1, H:foo.local:66 - 4/12
STATUS: 1, H:foo.local:66 - 5/12
STATUS: 1, H:foo.local:66 - 6/12
STATUS: 1, H:foo.local:66 - 7/12
STATUS: 1, H:foo.local:66 - 8/12
STATUS: 1, H:foo.local:66 - 9/12
STATUS: 1, H:foo.local:66 - 10/12
STATUS: 1, H:foo.local:66 - 11/12
STATUS: 1, H:foo.local:66 - 12/12
COMPLETE: 1, !dlroW olleH
DONE

    See Also

    Found A Problem?

    Learn How To Improve This Page • Submit a Pull Request • Report a Bug
    ＋add a note

    User Contributed Notes 3 notes

    up
    16
    Anonymous
    9 years ago
    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.
    up
    2
    iunknowvb at gmail dot com
    7 years ago
    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);
    up
    -2
    raitech at gmail dot com
    9 years ago
    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".
    ＋add a note
    To Top