GearmanClient::setCompleteCallback
Set a function to be called on task completion
Description
public bool GearmanClient::setCompleteCallback(callable $callback)
This callback executes only when executing a GearmanTask using
GearmanClient::runTasks. It is not used for individual jobs.
Note:
The callback will only be triggered for tasks that are added (e.g. by calling GearmanClient::addTask)
after calling this method.
Parameters
-
callback
-
A function or method to call.
It should return a valid Gearman return value.
If no return statement is present, it defaults to GEARMAN_SUCCESS.
int callback(GearmanTask $task, mixed $context)
-
task
-
The task this callback is called for.
-
context
-
Whatever has been passed to GearmanClient::addTask (or equivalent method) as context.
Return Values
Returns true on success or false on failure.
See Also
- GearmanClient::setDataCallback
- GearmanClient::setCreatedCallback
- GearmanClient::setExceptionCallback
- GearmanClient::setFailCallback
- GearmanClient::setStatusCallback
- GearmanClient::setWarningCallback
- GearmanClient::setWorkloadCallback