GearmanClient::setCompleteCallback

Set a function to be called on task completion

説明

public bool GearmanClient::setCompleteCallback(callable $callback)

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 が返されます。

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

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

context

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

戻り値

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

参考

  • GearmanClient::setDataCallback
  • GearmanClient::setCreatedCallback
  • GearmanClient::setExceptionCallback
  • GearmanClient::setFailCallback
  • GearmanClient::setStatusCallback
  • GearmanClient::setWarningCallback
  • GearmanClient::setWorkloadCallback