PHP 8.4.0 RC4 available for testing

GearmanClient::setWorkloadCallback

(PECL gearman >= 0.5.0)

GearmanClient::setWorkloadCallbackSet a callback for accepting incremental data updates

Description

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:

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

add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top