GearmanClient::setWorkloadCallback

(PECL gearman >= 0.5.0)

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

Descrição

public 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.

Note:
A função de retorno só será chamada para tarefas que forem adicionadas (por exemplo, chamando GearmanClient::addTask()) após a chamada a este método.

Parâmetros

callback

Uma função ou um método a ser chamado. Deve retornar um valor de retorno Gearman válido.

Se nenhuma declaração de retorno estiver presente, o padrão será GEARMAN_SUCCESS.

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

task: A tarefa para a qual esta função é chamada.
context: Qualquer coisa que foi passada para GearmanClient::addTask() (ou método equivalente) como contexto.

Valor Retornado

Retorna true em caso de sucesso ou false em caso de falha.

Veja Também

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