---
name: "gearman_client_job_status"
section: "3"
platform: "linux"
package: "gearmand"
version: "2.2.0-1"
release: "Arch Linux 2026-11-01"
platforms: ["linux"]
url: "https://new.carta.tech/gearman_client_job_status"
---

# gearman\_client\_job\_status(3)

Gearmand Documentation, https://gearman.org/gearmand/

## NAME

gearman\_client\_job\_status - Gearmand Documentation, https://gearman.org/gearmand/

## SYNOPSIS

\#include \<libgearman/gearman.h\>

- ***gearman\_return\_t* gearman\_client\_job\_status(*gearman\_client\_st* \*client, *gearman\_job\_handle\_t* job\_handle, *bool* \*is\_known, *bool* \*is\_running, *uint32\_t* \*numerator, *uint32\_t* \*denominator)**

  Link with -lgearman

## DESCRIPTION

*gearman\_client\_job\_status()* is used to find the status of a job via its *gearman\_job\_handle\_t*. The arguments is\_known, is\_running, numerator, and denominator are all optional. Unless a Gearman worker has sent numerator/denominator via *gearman\_job\_send\_status()*, those values will be zero.

If the arguments is\_known and is\_running are omitted then the function returns state data via *gearman\_return\_t*.

## RETURN VALUE

*gearman\_return\_t* will be returned. **GEARMAN\_SUCCESS** will be returned upon success of the status being updated. If the arguments is\_known and is\_running are omitted then *gearman\_client\_job\_status()* will return *GEARMAN\_JOB\_EXISTS* if the *gearman\_job\_handle\_t* is known on the server, and *GEARMAN\_IN\_PROGRESS* if it is running. Knowing whether the job is running or not has higher precedence. *gearman\_continue()* can be used for loops where you want to exit from the loop once the job has been completed.

**WARNING:**

For loops you should always check *gearman\_return\_t* with *gearman\_continue()* even if you specifiy the argument is\_known or is\_running. A non-blocking IO call can return something other then **GEARMAN\_SUCCESS**, in some cases you will want to treat those values not as errors.

## HOME

To find out more information please check: *https://gearman.org/gearmand/*

**SEE ALSO:**

**[gearmand(8)](/gearmand/8.md)** **[libgearman(3)](/libgearman/3.md)** **[gearman\_client\_st(3)](/gearman_client_st/3.md)** **[gearman\_job\_handle\_t(3)](/gearman_job_handle_t/3.md)** **gearman\_continue(3**

## AUTHOR

Data Differential http://www.datadifferential.com/

## COPYRIGHT

2011-2014, Data Differential, http://www.datadifferential.com/