GearmanClient::setCompleteCallback

(PECL gearman >= 0.5.0)

GearmanClient::setCompleteCallback — Set a function to be called on task completion

Description

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.

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.
callback(GearmanTask $task, mixed $context): int
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