Set a callback for accepting incremental data updates

# GearmanClient::setWorkloadCallback

(PECL gearman >= 0.5.0)

GearmanClient::setWorkloadCallback — Set a callback for accepting incremental data updates

### 説明

public function GearmanClient::setWorkloadCallback(callable `$callback`): bool

Sets a callback function to be called when a worker needs to send back data prior to job completion. A worker can do this when it needs to send updates, send partial results, or flush data during long running jobs.

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

### パラメータ

`callback`
  呼び出す関数またはメソッド。有効な Gearmanの値 を返す必要があります。 return 文が存在しない場合、デフォルトで `GEARMAN_SUCCESS` が返されます。
  function callback(GearmanTask `$task`, mixed `$context`): int
  `task`
    このコールバックが呼び出されるタスク。
  `context`
    GearmanClient::addTask() (または同等のメソッド) に `context` として渡されたもの。

### 戻り値

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

### 参考

- GearmanClient::setDataCallback() - Callback function when there is a data packet for a task
- GearmanClient::setCompleteCallback() - Set a function to be called on task completion
- GearmanClient::setCreatedCallback() - Set a callback for when a task is queued
- GearmanClient::setExceptionCallback() - Set a callback for worker exceptions
- GearmanClient::setFailCallback() - Set callback for job failure
- GearmanClient::setStatusCallback() - Set a callback for collecting task status
- GearmanClient::setWarningCallback() - Set a callback for worker warnings

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open