When will GearmanWorker::work be false?

[ifohancroft]

I have looked everywhere (even tried reading the C source but that didn't help) but I can't find the answer to that.

When will GearmanWorker::work be false? What can/will cause it to "fail" basically?
The PHP manual over at php.net says:

Waits for a job to be assigned and then calls the appropriate callback function. Issues an E_WARNING with the last Gearman error if the return code is not one of GEARMAN_SUCCESS, GEARMAN_IO_WAIT, or GEARMAN_WORK_FAIL.

If the return code of what is not one of GEARMAN_SUCCESS, GEARMAN_IO_WAIT or GEARMAN_WORK_FAIL?

Is there a way to see the Gearman Worker class as a PHP code? I.e. as if it was a class written in PHP?

[oleg-st]

Here is the source code for this method:

pecl-networking-gearman/php_gearman_worker.c

Line 627 in 7da13e4

PHP_FUNCTION(gearman_worker_work) {

It will return false if return code is not GEARMAN_SUCCESS.

[ifohancroft]

Here is the source code for this method:

pecl-networking-gearman/php_gearman_worker.c

Line 627 in 7da13e4

PHP_FUNCTION(gearman_worker_work) {

It will return false if return code is not GEARMAN_SUCCESS.

Thank you! The return code of what though?

[esabol]

The return code of what though?

The C function gearman_worker_work in libgearman.

See https://github.com/gearman/gearmand/blob/302f33cebf730a9f7356ccdcc4cb8b4c171bd68a/docs/source/libgearman/gearman_return_t.rst for a list of possible errors.

[ifohancroft]

The return code of what though?

The C function gearman_worker_work in libgearman.

I get that, but I am asking on a higher level. What has to happen for $worker->work to return false/what controls what GEARMAN_STATUS would $worker->returnCode() return and in what cases it won't be GEARMAN_SUCCESS?