.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "GEARMAN_CLIENT_JOB_STATUS" "3" "Jan 31, 2024" "1.1.20+ds" "Gearmand"
.SH NAME
gearman_client_job_status \- Gearmand Documentation, http://gearman.info/
.SH SYNOPSIS
.sp
#include <libgearman/gearman.h>
.INDENT 0.0
.TP
.B \fI\%gearman_return_t\fP gearman_client_job_status(\fI\%gearman_client_st\fP *client, \fI\%gearman_job_handle_t\fP job_handle, bool *is_known, bool *is_running, \fI\%uint32_t\fP *numerator, \fI\%uint32_t\fP *denominator) 
.UNINDENT
.sp
Link with \-lgearman
.SH DESCRIPTION
.sp
\fI\%gearman_client_job_status()\fP is used to find the status of a job via its \fI\%gearman_job_handle_t\fP\&. The arguments is_known, is_running, numerator, and denominator are all optional. Unless a Gearman worker has sent numerator/denominator via \fI\%gearman_job_send_status()\fP, those values will be zero.
.sp
If the arguments is_known and is_running are omitted then the function returns state data via \fI\%gearman_return_t\fP\&.
.SH RETURN VALUE
.sp
\fI\%gearman_return_t\fP will be returned. \fI\%GEARMAN_SUCCESS\fP will be returned upon success of the status being updated.
If the arguments is_known and is_running are omitted then \fI\%gearman_client_job_status()\fP will return \fI\%GEARMAN_JOB_EXISTS\fP if the \fI\%gearman_job_handle_t\fP is known on the server, and
\fI\%GEARMAN_IN_PROGRESS\fP if it is running. Knowing whether the job is running or not has higher precedence. \fI\%gearman_continue()\fP can be used for loops where you want to exit from the loop once the job has been completed.
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
For loops you should always check \fI\%gearman_return_t\fP with \fI\%gearman_continue()\fP even if you specify the argument is_known or is_running. A non\-blocking IO call can return something other then \fI\%GEARMAN_SUCCESS\fP, in some cases you will want to treat those values not as errors.
.UNINDENT
.UNINDENT
.SH HOME
.sp
To find out more information please check:
\fI\%http://gearman.info/\fP
.sp
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
\fBgearmand(8)\fP \fBlibgearman(3)\fP \fBgearman_client_st(3)\fP \fBgearman_job_handle_t(3)\fP \fBgearman_continue(3\fP
.UNINDENT
.UNINDENT
.SH AUTHOR
Data Differential http://www.datadifferential.com/
.SH COPYRIGHT
2011-2024, Data Differential, http://www.datadifferential.com/
.\" Generated by docutils manpage writer.
.