1GEARMAN_CLIENT_JOB_STATUS(3)       Gearmand       GEARMAN_CLIENT_JOB_STATUS(3)
2
3
4

NAME

6       gearman_client_job_status   -   Gearmand   Documentation,  http://gear‐
7       man.info/
8

SYNOPSIS

10       #include <libgearman/gearman.h>
11
12       gearman_return_t  gearman_client_job_status(gearman_client_st  *client,
13       gearman_job_handle_t  job_handle,  bool  *is_known,  bool  *is_running,
14       uint32_t *numerator, uint32_t *denominator)
15
16       Link with -lgearman
17

DESCRIPTION

19       gearman_client_job_status() is used to find the status of a job via its
20       gearman_job_handle_t.  The  arguments  is_known, is_running, numerator,
21       and denominator are all optional. Unless a Gearman worker has sent  nu‐
22       merator/denominator via gearman_job_send_status(), those values will be
23       zero.
24
25       If the arguments is_known and is_running are omitted then the  function
26       returns state data via gearman_return_t.
27

RETURN VALUE

29       gearman_return_t  will  be  returned.  GEARMAN_SUCCESS will be returned
30       upon success of the status being updated.  If  the  arguments  is_known
31       and is_running are omitted then gearman_client_job_status() will return
32       GEARMAN_JOB_EXISTS if the gearman_job_handle_t is known on the  server,
33       and  GEARMAN_IN_PROGRESS  if  it is running. Knowing whether the job is
34       running or not has higher precedence. gearman_continue()  can  be  used
35       for  loops  where  you want to exit from the loop once the job has been
36       completed.
37
38       WARNING:
39          For loops you should always check gearman_return_t with gearman_con‐
40          tinue()  even if you specifiy the argument is_known or is_running. A
41          non-blocking IO call can return something  other  then  GEARMAN_SUC‐
42          CESS,  in  some cases you will want to treat those values not as er‐
43          rors.
44

HOME

46       To find out more information please check: http://gearman.info/
47
48       SEE ALSO:
49          gearmand(8)  libgearman(3)   gearman_client_st(3)   gearman_job_han‐
50          dle_t(3) gearman_continue(3
51

AUTHOR

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

56       2011-2014, Data Differential, http://www.datadifferential.com/
57
58
59
60
611.1.20                           Nov 19, 2022     GEARMAN_CLIENT_JOB_STATUS(3)
Impressum