GearmanClient::setTimeout »

« GearmanClient::setOptions

GearmanClient::setStatusCallback

(PECL gearman >= 0.5.0)

GearmanClient::setStatusCallback — Set a callback for collecting task status

Description

public GearmanClient::setStatusCallback(callable $callback): bool

Sets a callback function used for getting updated status information from a worker.

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

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::setWarningCallback() - Set a callback for worker warnings
GearmanClient::setWorkloadCallback() - Set a callback for accepting incremental data updates

Improve This Page

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

User Contributed Notes

There are no user contributed notes for this page.