PHP 8.4.1 Released!

GearmanClient::setCompleteCallback

(PECL gearman >= 0.5.0)

GearmanClient::setCompleteCallbackSet a function to be called on task completion

Beschreibung

public GearmanClient::setCompleteCallback(callable $callback): bool

Use to set a callback function to be called when a GearmanTask is completed, or when GearmanJob::sendComplete() is invoked by a worker (whichever happens first).

This callback executes only when executing a GearmanTask using GearmanClient::runTasks(). It is not used for individual jobs.

Hinweis:

Der Callback wird nur für Aufgaben ausgelöst, die nach dem Aufruf dieser Methode hinzugefügt werden (z. B. durch den Aufruf von GearmanClient::addTask()).

Parameter-Liste

callback

Die aufzurufende Funktion oder Methode. Sie sollte einen gültigen Gearman-Rückgabewert zurückgeben.

Wenn es keine Rückgabeanweisung gibt, ist der Standardwert GEARMAN_SUCCESS.

callback(GearmanTask $task, mixed $context): int
task

Die Aufgabe, für die dieser Callback aufgerufen wird.

context

Alles, was an GearmanClient::addTask() (oder eine entsprechende Methode) als context übergeben wurde.

Rückgabewerte

Gibt bei Erfolg true zurück. Bei einem Fehler wird false zurückgegeben.

Siehe auch

add a note

User Contributed Notes 1 note

up
5
Justas Butkus
13 years ago
One shall note, that callback function MUST either return a valid Gearman status code, or return nothing (do not return).

I.e. these are valid complete callbacks:

<?php
function goodCallbackOne(GearmanTask $task)
{
print_r($task);
}
?>

<?php
function goodCallbackTwo(GearmanTask $task)
{
print_r($task);
return
GEARMAN_SUCCESS;
}
?>

While following is NOT, unless you want your client code to fail with Gearman error 'german wait:no active file descriptors':

<?php
function badCallbackTwo(GearmanTask $task)
{
print_r($task);
return
true;
}
?>
To Top