PHP 8.4.1 Released!

GearmanClient::setCompleteCallback

(PECL gearman >= 0.5.0)

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

説明

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.

注意:

このコールバックは、このメソッドを呼び出した後に追加されたタスク(例: GearmanClient::addTask() を呼び出して追加されたタスク)に対してのみ実行されます。

パラメータ

callback

呼び出す関数またはメソッド。有効な Gearmanの値 を返す必要があります。

return 文が存在しない場合、デフォルトで GEARMAN_SUCCESS が返されます。

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

このコールバックが呼び出されるタスク。

context

GearmanClient::addTask() (または同等のメソッド) に context として渡されたもの。

戻り値

成功した場合に true を、失敗した場合に false を返します。

参考

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