gearman_client_job_status(3) [debian man page]

GEARMAN_CLIENT_JOB_STATUS(3)					     Gearmand					      GEARMAN_CLIENT_JOB_STATUS(3)

NAME

       gearman_client_job_status - Gearmand Documentation, http://gearman.info/

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,  numera-
       tor,  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 ommitted 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: http://gearman.info/

       See also

	      gearmand(8) libgearman(3) gearman_client_st(3) gearman_job_handle_t(3) gearman_continue(3

AUTHOR

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

COPYRIGHT

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

0.33								   May 04, 2012 				      GEARMAN_CLIENT_JOB_STATUS(3)

GEARMAN_JOB_SEND_STATUS(3)					     Gearmand						GEARMAN_JOB_SEND_STATUS(3)

NAME

       gearman_job_send_status - Gearmand Documentation, http://gearman.info/

SYNOPSIS

       #include <libgearman/gearman.h>

       gearman_job_st

       void gearman_job_free(gearman_job_st *job)

       gearman_return_t gearman_job_send_data(gearman_job_st *job, const void *data, size_t data_size)

       gearman_return_t gearman_job_send_warning(gearman_job_st *job, const void *warning, size_t warning_size)

       gearman_return_t gearman_job_send_status(gearman_job_st *job, uint32_t numerator, uint32_t denominator)

       gearman_return_t gearman_job_send_complete(gearman_job_st *job, const void *result, size_t result_size)

       gearman_return_t gearman_job_send_exception(gearman_job_st *job, const void *exception, size_t exception_size)

       gearman_return_t gearman_job_send_fail(gearman_job_st *job)

       const char *gearman_job_handle(const gearman_job_st *job)

       const char *gearman_job_function_name(const gearman_job_st *job)

       const char *gearman_job_unique(const gearman_job_st *job)

       const void *gearman_job_workload(const gearman_job_st *job)

       size_t gearman_job_workload_size(const gearman_job_st *job)

       void *gearman_job_take_workload(gearman_job_st *job, size_t *data_size)

       Link with -lgearman

DESCRIPTION

       gearman_job_st are passed to worker functions to represent jobs that are being run by gearman_worker_work().

       gearman_job_free() is used to free a job. This only needs to be done if a task was created with a preallocated structure.

       gearman_job_handle() returns the job handle(see gearman_job_handle_t for more information).

       gearman_job_function_name() return the name of the function that the job was set to execute against.

       gearman_job_unique() return the unique value that was used for gearman_job_st.

       returns the gearman_job_st workload. The size of it can be determined with gearman_job_workload_size().	gearman_job_take_workload() is the
       same as gearman_job_workload() with the exception that the result must be free(3) by the caller.

RETURN VALUE

       A value of gearman_return_t  is returned.  On success that value will be :c:type::GEARMAN_SUCCESS.   Use  gearman_strerror()  to  translate
       this value to a printable string.

HOME

       To find out more information please check: http://gearman.info/

SEE ALSO

       gearmand(8) libgearman(3)

AUTHOR

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

COPYRIGHT

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

0.33								   May 04, 2012 					GEARMAN_JOB_SEND_STATUS(3)